Page MenuHomePhabricator

[TableGen] [Docs] Add lldb-tblgen to command guide; add 4 stubs for xxx-tblgen commands
ClosedPublic

Authored by Paul-C-Anagnostopoulos on Tue, Mar 30, 9:41 AM.

Details

Summary

This revision adds the lldb-tblgen command options to the tblgen command guide.

It also adds four stub documents, xxx-tblgen, for the four flavors of TableGen, which simply refer the reader to the primary command guide.

Diff Detail

Event Timeline

Paul-C-Anagnostopoulos requested review of this revision.Tue, Mar 30, 9:41 AM
lattner resigned from this revision.Tue, Mar 30, 1:01 PM

I'm not up to speed on the doc structure.

The comments apply similarly to the other files,

llvm/docs/CommandGuide/clang-tblgen.rst
2

I'd say "Description to C++ Code for Clang".

It can be a bunch of things like command line options, diagnostic messages, attributes, so I think it's hard to find something overarching here.

5

Should this say clang-tblgen? Not sure how this works.

23

Can we use * instead of xxx here?

Incorporate Aaron's comments.

Now let's actually include the changes.

aaronpuchert accepted this revision.Thu, Apr 1, 12:50 PM

I'm wondering if we should move the files to their respective subprojects, but that would probably prevent the links from working. So I guess we have to live with this for now.

This revision is now accepted and ready to land.Thu, Apr 1, 12:50 PM
jrtc27 added a subscriber: jrtc27.Thu, Apr 8, 1:43 PM
jrtc27 added inline comments.
llvm/docs/CommandGuide/tblgen.rst
1

This is what ends up in the mange's file name, so we now have a file called tblgen Family.1 being built, which is clearly not a good idea. Please change this.

1

*manpage's

brooks added a subscriber: brooks.Thu, Apr 8, 1:43 PM

This results in a manpage with the filename tblgen Family.1 which quite odd.

jrtc27 added inline comments.Thu, Apr 8, 1:46 PM
llvm/docs/CommandGuide/clang-tblgen.rst
20

These references are wrong; the real title doesn't have "Target" in it (since that's specifically for llvm-tblgen)

llvm/docs/CommandGuide/tblgen.rst
1

What do you suggest I change it to?

jrtc27 added inline comments.Thu, Apr 8, 2:12 PM
llvm/docs/CommandGuide/tblgen.rst
1

I'd suggest just removing the Family? Then it matches .. program:: below and the name of the rst file itself.

llvm/docs/CommandGuide/tblgen.rst
1

Sounds good. I will do this on Friday.

jrtc27 added inline comments.Thu, Apr 8, 2:15 PM
llvm/docs/CommandGuide/tblgen.rst
1

Thanks

Do you think it's necessary to have the change of document title reviewed in Phabricator?

jrtc27 added a comment.Thu, Apr 8, 2:18 PM

Do you think it's necessary to have the change of document title reviewed in Phabricator?

I wouldn't bother, especially since we've discussed the exact change already

jrtc27 added a comment.Fri, Apr 9, 7:10 AM

I pushed this patch.

Great, thanks for the quick follow-up.