Skip to content
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.

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

./configure --help should print --disable-docs instead of --enable-docs #131883

Open
dilyanpalauzov opened this issue Oct 18, 2024 · 0 comments
Open
Labels
C-bug Category: This is a bug. needs-triage This issue may need triage. Remove it if it has been sufficiently triaged.

Comments

@dilyanpalauzov
Copy link

With rust 1.82 ./configure --help prints:

        --enable-docs                  build standard library documentation 

This suggests, that by default the standard library documentation is not built, but with this option it can be turned on. If the --help output was

        --disable-docs                  do not build standard library documentation 

this would have suggested, that by default the documentation is built. Cf. https://ab.bapha.be/posts/help-output/)

config.example.toml contains

# Whether to build documentation by default. If false, rustdoc and
# friends will still be compiled but they will not be used to generate any
# documentation.
#
# You can still build documentation when this is disabled by explicitly passing paths,
# e.g. `x doc library`.
#docs = true

For me the last line means, that by default the documentation is build. Indeed, ./configure --disable-docs puts in config.toml: docs = false.

  • Change the output of ./configure --help from --enable-docs to --disable-docs to indicate what actions users should take in order to deviate from the default behaviour.

See also #129146.

@dilyanpalauzov dilyanpalauzov added the C-bug Category: This is a bug. label Oct 18, 2024
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-bug Category: This is a bug. needs-triage This issue may need triage. Remove it if it has been sufficiently triaged.
Projects
None yet
Development

No branches or pull requests

2 participants