Update documentation #285
Update documentation #285
Conversation
jacksonbrim
force-pushed
the
update-documentation
branch
4 times, most recently
from
dd31220
to
b830a7a
Compare
jacksonbrim
requested review from
alexandruag,
bonzini,
jiangliu and
roypat
as code owners
There was a problem hiding this comment.
Hi @jacksonbrim,
Thank you for your contribution! We've done a similar thing on some other rust-vmm crates (e.g. rust-vmm/linux-loader@26a0d86), so it'd be nice to keep the implementation consistent (e.g. use doc_auto_cfg) across the crates. Could you have a look at the comments below to see if they make sense? Thanks!
src/lib.rs
Outdated
| @@ -29,6 +30,7 @@ pub mod address; | |||
| pub use address::{Address, AddressValue}; | |||
|
|
|||
| #[cfg(feature = "backend-atomic")] | |||
| #[cfg_attr(docsrs, doc(cfg(feature = "backend-atomic")))] | |||
There was a problem hiding this comment.
| #[cfg_attr(docsrs, doc(cfg(feature = "backend-atomic")))] |
src/lib.rs
Outdated
| @@ -63,7 +65,9 @@ mod mmap_xen; | |||
| mod mmap_windows; | |||
|
|
|||
| #[cfg(feature = "backend-mmap")] | |||
| #[cfg_attr(docsrs, doc(cfg(feature = "backend-mmap")))] | |||
There was a problem hiding this comment.
| #[cfg_attr(docsrs, doc(cfg(feature = "backend-mmap")))] |
Yes, that looks much better. |
Cargo.toml
Outdated
| @@ -44,3 +44,4 @@ codegen-units = 1 | |||
|
|
|||
| [package.metadata.docs.rs] | |||
| all-features = true | |||
| rustdoc-args = ["--cfg", "docsrs", "--cfg", "feature=\"backend-mmap\"", "--cfg", "feature=\"backend-atomic\""] | |||
There was a problem hiding this comment.
My understanding is that rustdoc-args enables features in the rustdoc binary, so this only needs to be rustdoc-args = ["--cfg", "docsrs"]. The features backend-mmap etc. will be enabled by all-features = true.
There was a problem hiding this comment.
I've seen the later commit removes these, I think in this case it would make sense to squash the commits in this PR.
There was a problem hiding this comment.
Wait, we don't get paid by the commit?
Squashed it. Thanks for the patience.
* Add feature flag doc generation in lib.rs with auto_doc_cfg * Update Cargo.toml with rustdoc-args in [package.metadata.docs.rs] for docs.rs build. Local Doc Build Command: ``` RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features --open ``` Signed-off-by: Jackson Brim <jackson.cr.brim@gmail.com>
jacksonbrim
force-pushed
the
update-documentation
branch
from
3f3430c
to
7535c82
Compare
##Summary of the PR
Annotated modules in lib.rs to indicate their feature dependencies such that it is reflected in the docs, enhancing documentation clarity for users on docs.rs.
##Building Documentation Locally:
To build the documentation locally with the specified feature flags, use the following command:
This command sets the necessary RUSTDOCFLAGS to include conditional compilation flags and features specific to our project, ensuring the generated documentation reflects the same level of detail and conditions as seen on docs.rs.