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

Consider allowing to build docs for the current kernel config #447

Closed
ojeda opened this issue Jul 15, 2021 · 1 comment
Closed

Consider allowing to build docs for the current kernel config #447

ojeda opened this issue Jul 15, 2021 · 1 comment
Labels
• docs Related to `Documentation/rust/`, `samples/`, generated docs, doctests, typos...

Comments

@ojeda
Copy link
Member

ojeda commented Jul 15, 2021

Initially, we had the rustdoc target build customized docs for the current kernel configuration. Then, in #446 (suggested in #442) we started using doc_cfg and the intention is that we build all the docs.

However, it could perhaps be useful to still allow users to build a customized version of the docs for the kernel configuration, e.g. for local development (i.e. faster generation) or for distributions that wish to provide trimmed down docs for the kernels they release. See discussion at #446 for details.

For the moment, let's keep things simple. If somebody needs the feature, it is easy to implement (although it may require some churn to move to a doc_all gate instead of the doc one).

@ojeda ojeda added • docs Related to `Documentation/rust/`, `samples/`, generated docs, doctests, typos... prio: low labels Jul 15, 2021
@ojeda ojeda removed the prio: low label Feb 17, 2023
@ojeda
Copy link
Member Author

ojeda commented Oct 29, 2024

Closing -- currently we build docs for the current kernel configuration only, which is likely to remain the case for the time being given how rustdoc works. For news on this, please see "Documentation under conditional compilation." in #350.

@ojeda ojeda closed this as completed Oct 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
• docs Related to `Documentation/rust/`, `samples/`, generated docs, doctests, typos...
Development

No branches or pull requests

1 participant