Generating cargo doc for both userland and eBPF program

[ErrorTeaPot]

I am trying to generate documentation using cargo doc in my aya-rs program, but it is only generating the userland part.

I am following the aya-rs template for my project with all the defaults regarding build.rs files and Cargo.toml files. When running cargo doc -r --open --no-deps I have at the end all the documentation of the foo and foo-common part, but foo-ebpf only returns the content of foo-ebpf/src/lib.rs.

How could I generate documentation for all the project at once, with everything at the right place ? (I would like to avoid generating 2 different docs).

[tamird]

I am not sure this is possible, as the userland and ebpf portions build on different targets.

[miniduikboot]

It's possible, and not actually that difficult. If you run cargo doc --workspace you get a helpful error message:

error: document output filename collision
The bin `asdfghjkl` in package `asdfghjkl-ebpf v0.1.0 (/tmp/asdfghjkl/asdfghjkl-ebpf)` has the same name as the bin `asdfghjkl` in package `asdfghjkl v0.1.0 (/tmp/asdfghjkl/asdfghjkl)`.
Only one may be documented at once since they output to the same path.
Consider documenting only one, renaming one, or marking one with `doc = false` in Cargo.toml.

If you rename the output of your ebpf module, it's possible to generate docs for both platforms. PR to the template incoming :)

Unfortunately you do need to pass --workspace (or --all, but it's deprecated) to cargo doc, and the Cargo Book doesn't list a way around this, adding the ebpf crate to default-members causes more issues: https://doc.rust-lang.org/cargo/commands/cargo-doc.html#package-selection

[ErrorTeaPot]

Ok, thank you, I have seen this solution, but I was not sure if renaming the module would cause problems.
Thank you for your answer, and I hope that the PR on the template will help !