LLVM Bugzilla is read-only and represents the historical archive of all LLVM issues filled before November 26, 2021. Use github to submit LLVM bugs

Bug 314 - LLVM Command Guide not complete
Summary: LLVM Command Guide not complete
Status: RESOLVED FIXED
Alias: None
Product: Website
Classification: Unclassified
Component: Documentation (show other bugs)
Version: unspecified
Hardware: All All
: P normal
Assignee: Unassigned LLVM Bugs
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2004-04-08 12:11 PDT by Tanya Lattner
Modified: 2010-03-06 14:00 PST (History)
3 users (show)

See Also:
Fixed By Commit(s):


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Tanya Lattner 2004-04-08 12:11:42 PDT
The command guide appears to be missing options for some of the tools. For
example, llc has a ton of options that you can get if you use --help-hidden. I'm
sure the same is for other tools. I think all of these should be listed on the
website.
Comment 1 Chris Lattner 2004-07-10 01:15:18 PDT
I don't think that it really makes sense to put all options in the command guide
for every tool, but you're right... we should at least point out that there are
hidden options and mention how to get them.

I updated the text at the top of the commandguide page:
http://llvm.cs.uiuc.edu/docs/CommandGuide/

Does this look reasonable?  If so I think this bug should be closed, because we
don't really want to mention every little debugging option (which might change
in the future).  If there are major options, like -o, that are not documented,
that's clearly a bug though and should be fixed :)

-Chris
Comment 2 Tanya Lattner 2004-07-10 01:30:43 PDT
Whats wrong with having these pages auto generated?
Comment 3 Chris Lattner 2004-07-10 01:43:06 PDT
That's not an unreasonable idea at all, but would be tricky to get "right".  If
you wanted to add an entry to the open projects page I think that would be fine.
 However, I think the bug is "satisfied", do you agree?

-Chris
Comment 4 Tanya Lattner 2004-07-10 01:51:07 PDT
Thats fine. 
Comment 5 Misha Brukman 2004-07-10 18:45:15 PDT
Tanya, what do you mean by "having these pages autogenerated"?  Do you mean you
want the .pod files auto-generated, or is the current .pod -> .html conversion
satisfactory?