doc: correct cargo doc command in contrib guide
#4933
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The command to build the documentation locally provided in the Contribution Guide did not work for all crates in the project workspace. Specifically, to build the docs for `tokio-stream` the flag `--cfg docsrs` needs to be in the environment variable `RUSTFLAGS` in addition to being in `RUSTDOCFLAGS`. Additionally, there was text describing that the docs cannot be built from the root of the workspace with a link to rust-lang/cargo#9274. That issue has since been closed as complete and the listed commands do now work from the root of the workspace. As such, that text has been removed.
hds
force-pushed
the
hds/contrib-guide-docs-command
branch
from
bf312ce to
a37f3c0
Compare
Darksonn
added
the
A-readme
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
The command to build docs listed in the contribution guide was missing an
environment variable needed to build
tokio-stream. Additionally it turns outthat there was outdated information about not being able to build docs from
the root of the workspace. After the resolution of rust-lang/cargo#9274, this
is not longer correct.
Solution
The command to build the documentation locally provided in the
Contribution Guide did not work for all crates in the project workspace.
Specifically, to build the docs for
tokio-streamthe flag--cfg docsrsneeds to be in the environment variableRUSTFLAGSin additionto being in
RUSTDOCFLAGS.Additionally, there was text describing that the docs cannot be built
from the root of the workspace with a link to rust-lang/cargo#9274. That
issue has since been closed as complete and the listed commands do now
work from the root of the workspace. As such, that text has been
removed.