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.

Sign up for GitHub

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

Jump to bottom

rust: sync: add intra-doc links to the Backend trait #1001

Closed
ojeda opened this issue Apr 21, 2023 · 8 comments
Closed

rust: sync: add intra-doc links to the Backend trait #1001

ojeda opened this issue Apr 21, 2023 · 8 comments
Labels
• docs Related to `Documentation/rust/`, `samples/`, generated docs, doctests, typos... good first issue Good for newcomers

Comments

@ojeda
Copy link
Member

ojeda commented Apr 21, 2023 •
edited
Loading

We could use intra-doc links to the Backend trait where appropriate, see https://lore.kernel.org/rust-for-linux/94625fe6-b87a-a8f0-5b2a-a8152d5f7436@proton.me/.

This requires submitting a proper patch to the LKML and the Rust for Linux mailing list. Please recall to test your changes (generate the docs), to use a proper title for the commit, to sign your commit under the Developer's Certificate of Origin, a Suggested-by: tag to Benno (see the report above) and a couple Link: tags to that report and this issue. Please see 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.
@ojeda ojeda added • docs Related to `Documentation/rust/`, `samples/`, generated docs, doctests, typos... good first issue Good for newcomers labels Apr 21, 2023
@Ben2917
Copy link

Ben2917 commented Apr 30, 2023

Hi @ojeda. I'd like to take a look at this

@ojeda
Copy link
Member Author

ojeda commented Apr 30, 2023

Sure, go ahead, thanks!

@Ben2917
Copy link

Ben2917 commented May 2, 2023

I seem to be having some trouble generating the documentation to test my changes. I've tried running make LLVM=1 rustdoc to generate the documentation as described in the docs but I'm getting no rule to make target 'rustdoc' as a result. I ran make help and see that rustdoc requires "kernel .config" but being a kernel newbie I'm not 100% sure what to do here to enable the rustdoc target. I'm sure I've missed something simple but any help to point me in the right direction would be greatly appreciated!

@bjorn3
Copy link
Member

bjorn3 commented May 3, 2023

Do you have the rust config enabled? Maybe the target doesn't exist if it isn't?

@ojeda
Copy link
Member Author

ojeda commented May 3, 2023

Yes, it requires RUST=y.

I'm sure I've missed something simple but any help to point me in the right direction would be greatly appreciated!

Did you follow the Quick Start guide? https://docs.kernel.org/rust/quick-start.html

@Ben2917
Copy link

Ben2917 commented May 3, 2023

Thanks for your help, I somehow missed the quickstart guide so I was flying a bit blind. I can successfully generate docs now so my patch should be incoming very soon

@ojeda
Copy link
Member Author

ojeda commented May 4, 2023

Glad it helped :) If you hit other roadblocks, we have also a Zulip chat (https://rust-for-linux.com/contact)

Ben2917 pushed a commit to Ben2917/linux that referenced this issue May 7, 2023
rust: lock: Add intra-doc links to the Backend trait
7404b14 
Also fix a minor typo in one of the comments

Suggested-by: Benno Lossin <benno.lossin@proton.me>
Link: https://lore.kernel.org/rust-for-linux/94625fe6-b87a-a8f0-5b2a-a8152d5f7436@proton.me/
Link: Rust-for-Linux#1001
Signed-off-by: Ben Gooding <ben.gooding.dev@gmail.com>
intel-lab-lkp pushed a commit to intel-lab-lkp/linux that referenced this issue May 7, 2023
@intel-lab-lkp
rust: lock: Add intra-doc links to the Backend trait
a04131a 
Also fix a minor typo in one of the comments

Suggested-by: Benno Lossin <benno.lossin@proton.me>
Link: https://lore.kernel.org/rust-for-linux/94625fe6-b87a-a8f0-5b2a-a8152d5f7436@proton.me/
Link: Rust-for-Linux#1001
Signed-off-by: Ben Gooding <ben.gooding.dev@gmail.com>
intel-lab-lkp pushed a commit to intel-lab-lkp/linux that referenced this issue May 9, 2023
@intel-lab-lkp
rust: lock: Add intra-doc links to the Backend trait
065e664 
Add missing intra-doc links to the Backend trait to make navigating the
documentation easier.

Suggested-by: Benno Lossin <benno.lossin@proton.me>
Link: https://lore.kernel.org/rust-for-linux/94625fe6-b87a-a8f0-5b2a-a8152d5f7436@proton.me/
Link: Rust-for-Linux#1001
Signed-off-by: Ben Gooding <ben.gooding.dev@gmail.com>
ojeda pushed a commit that referenced this issue Jul 19, 2023
@ojeda
rust: lock: Add intra-doc links to the Backend trait
c3bba9f 
Add missing intra-doc links to the Backend trait to make navigating the
documentation easier.

Suggested-by: Benno Lossin <benno.lossin@proton.me>
Link: https://lore.kernel.org/rust-for-linux/94625fe6-b87a-a8f0-5b2a-a8152d5f7436@proton.me/
Link: #1001
Signed-off-by: Ben Gooding <ben.gooding.dev@gmail.com>
Link: https://lore.kernel.org/r/20230509202314.8248-1-ben.gooding.dev@gmail.com
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
@ojeda
Copy link
Member Author

ojeda commented Jul 19, 2023

Applied to rust-next, thanks!

@ojeda ojeda closed this as completed Jul 19, 2023
ojeda pushed a commit that referenced this issue Aug 7, 2023
@ojeda
rust: lock: Add intra-doc links to the Backend trait
db7193a 
Add missing intra-doc links to the Backend trait to make navigating the
documentation easier.

Suggested-by: Benno Lossin <benno.lossin@proton.me>
Link: https://lore.kernel.org/rust-for-linux/94625fe6-b87a-a8f0-5b2a-a8152d5f7436@proton.me/
Link: #1001
Signed-off-by: Ben Gooding <ben.gooding.dev@gmail.com>
Link: https://lore.kernel.org/r/20230509202314.8248-1-ben.gooding.dev@gmail.com
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
vtta pushed a commit to vtta/linux-archive that referenced this issue Sep 29, 2023
@vtta
rust: lock: Add intra-doc links to the Backend trait
32eee6d 
Add missing intra-doc links to the Backend trait to make navigating the
documentation easier.

Suggested-by: Benno Lossin <benno.lossin@proton.me>
Link: https://lore.kernel.org/rust-for-linux/94625fe6-b87a-a8f0-5b2a-a8152d5f7436@proton.me/
Link: Rust-for-Linux#1001
Signed-off-by: Ben Gooding <ben.gooding.dev@gmail.com>
Link: https://lore.kernel.org/r/20230509202314.8248-1-ben.gooding.dev@gmail.com
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
• docs Related to `Documentation/rust/`, `samples/`, generated docs, doctests, typos... good first issue Good for newcomers
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ojeda @Ben2917 @bjorn3