Skip to content

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

Closed
@dilyanpalauzov

Description

@dilyanpalauzov

With rust 1.80 ./configure --help prints:

        --enable-docs                  build standard library documentation 

This means, that by default the standard librarly documentation is not built, but with this option it can be turned on.

However, 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.

Metadata

Metadata

Assignees

Labels

E-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.E-help-wantedCall for participation: Help is requested to fix this issue.T-bootstrapRelevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions