-
Notifications
You must be signed in to change notification settings - Fork 420
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
Move proc-macro documentation into the kernel
crate
#1076
Comments
It should be possible to build the macro crate as rmeta, then build the kernel crate as rmeta and finally rustdoc the macro crate with the kernel crate as dependency, right? It just needs both version of the macro crate to be compiled with different |
Hmm I have no idea if that works, but if anyone wants to try it, feel free to do so. |
I plan on submitting a patch series for this either tonight or tomorrow. The approach I took to enable these tests is mostly similar to what @bjorn3 suggested above, only I haven't found so far that explicit distinct |
Surprising. I did still recommend using a distinct |
Currently all examples in the
macros
crate areignore
d, since they are depending on stuff from thekernel
crate. There are several reasons for why we would like them to not be ignored:A solution is to move the documentation from the
macros
crate into thekernel
crate via using re-exports. When doing this, please also ensure that the tests compile.This requires submitting a proper patch to the LKML and the Rust for Linux mailing list. Please recall to test your changes, to use a proper title for the commit, to sign your commit under the Developer's Certificate of Origin and so on. Please see https://docs.kernel.org/process/submitting-patches.html and https://rust-for-linux.com/contributing for details.
Please take this issue only if you are new to the kernel development process and you would like to use it as a test to submit your first patch to the kernel. Please do not take it if you do not plan to make other contributions to the kernel.
The text was updated successfully, but these errors were encountered: