Skip to content

rustdoc man page out of date #13622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
exscape opened this issue Apr 19, 2014 · 0 comments · Fixed by #21309
Closed

rustdoc man page out of date #13622

exscape opened this issue Apr 19, 2014 · 0 comments · Fixed by #21309

Comments

@exscape
Copy link
Contributor

exscape commented Apr 19, 2014

The following options are shown in rustdoc --help but not in man rustdoc:

--version           print rustdoc's version
--cfg               pass a --cfg to rustc
--test              run code examples as tests
--test-args ARGS    arguments to pass to the test runner
--markdown-css FILES
                    CSS files to include via <link> in a rendered Markdown
                    file
--markdown-in-header FILES
                    files to include inline in the <head> section of a
                    rendered Markdown file
--markdown-before-content FILES
                    files to include inline between <body> and the content
                    of a rendered Markdown file
--markdown-after-content FILES
                    files to include inline between the content and
                    </body> of a rendered Markdown file

Indeed, the man page doesn't in any way mention the ability to test documentation or modify the output (except for choosing between HTML and JSON).
@thorncp thorncp mentioned this issue Jan 17, 2015
Merged
alexcrichton added a commit to alexcrichton/rust that referenced this issue Jan 19, 2015
@alexcrichton
Rollup merge of rust-lang#21309 - thorncp:rustdoc-man-page, r=kmcalli…
9489d82 
…ster

Brings the rustdoc man page in sync with the options specified in
src/librustdoc/lib.rs. The text was taken verbatim, but I tweaked the
order to be (what I think is) somewhat logical.

This should close rust-lang#13622.
barosl added a commit to barosl/rust that referenced this issue Jan 20, 2015
@barosl
Rollup merge of rust-lang#21309 - thorncp:rustdoc-man-page, r=kmcalli…
409c997 
…ster

Brings the rustdoc man page in sync with the options specified in
src/librustdoc/lib.rs. The text was taken verbatim, but I tweaked the
order to be (what I think is) somewhat logical.

This should close rust-lang#13622.
Manishearth pushed a commit to Manishearth/rust that referenced this issue Nov 23, 2022
@bors
Auto merge of rust-lang#13622 - jonas-schievink:fix-gat-completions, …
a516b90 
…r=jonas-schievink

fix: include generic parameter in GAT completions

Fixes rust-lang/rust-analyzer#13586
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update rustdoc man page thorncp/rust
2 participants
@alexcrichton @exscape