Use Markdown autolinks in normal comments #1153
Labels
easy
Expected to be an easy issue to resolve.
good first issue
Good for newcomers
• lib
Related to the `rust/` library.
Comments
ojeda
added
easy
This was referenced Apr 1, 2025
|
Hi, I'm new here and I want to try this as my first contribution.😊 |
|
Sure! |
|
@ojeda please can you assign this to me , i also wanted to try |
|
@ojeda please review this |
|
Please do not send pings that frequently -- one message is enough. As for your PR, please send the patch to the mailing list, but I think you are missing other instances in the tree and the commit message is not correct. @xizheyin please also feel free to send it too. Thanks both of you! |
brambhattabhishek
added a commit
to brambhattabhishek/linux
that referenced
this issue
Apr 4, 2025
Fixes Rust-for-Linux#1153 – some comments in Rust files were using plain URLs instead of Markdown autolink syntax. This change updates them to use proper autolinks for consistency and improved rendering in documentation tools. Link: Rust-for-Linux#1153 Signed-off-by: Abhishek Brahmbhatt <[email protected]>
xizheyin
added a commit
to xizheyin/linux
that referenced
this issue
Apr 6, 2025
Some comments in Rust files use raw URLs (http://example.com) rather than Markdown autolinks [text](URL). This inconsistency makes the documentation less uniform and harder to maintain. This patch converts all remaining raw URLs in Rust code comments to use the Markdown autolink format, maintaining consistency with the rest of the codebase which already uses this style. Link: Rust-for-Linux#1153 Suggested-by: Miguel Ojeda <[email protected]> Signed-off-by: Xizhe Yin <[email protected]>
|
I've sent the patch to the specified mailing list in the format requested in the guide. You can review it if you have time, thanks! I hope to be able to contribute to this project on an ongoing basis. @ojeda |
intel-lab-lkp
pushed a commit
to intel-lab-lkp/linux
that referenced
this issue
Apr 6, 2025
Some comments in Rust files use raw URLs (http://example.com) rather than Markdown autolinks [text](URL). This inconsistency makes the documentation less uniform and harder to maintain. This patch converts all remaining raw URLs in Rust code comments to use the Markdown autolink format, maintaining consistency with the rest of the codebase which already uses this style. Link: Rust-for-Linux#1153 Suggested-by: Miguel Ojeda <[email protected]> Signed-off-by: Xizhe Yin <[email protected]>
xizheyin
added a commit
to xizheyin/linux
that referenced
this issue
Apr 6, 2025
Some comments in Rust files use raw URLs (http://example.com) rather than Markdown autolinks [text](URL). This inconsistency makes the documentation less uniform and harder to maintain. This patch converts all remaining raw URLs in Rust code comments to use the Markdown autolink format, maintaining consistency with the rest of the codebase which already uses this style. Link: Rust-for-Linux#1153 Suggested-by: Miguel Ojeda <[email protected]> Signed-off-by: xizheyin <[email protected]>
intel-lab-lkp
pushed a commit
to intel-lab-lkp/linux
that referenced
this issue
Apr 6, 2025
Some comments in Rust files use raw URLs (http://example.com) rather than Markdown autolinks [text](URL). This inconsistency makes the documentation less uniform and harder to maintain. This patch converts all remaining raw URLs in Rust code comments to use the Markdown autolink format, maintaining consistency with the rest of the codebase which already uses this style. Link: Rust-for-Linux#1153 Suggested-by: Miguel Ojeda <[email protected]> Signed-off-by: xizheyin <[email protected]>
intel-lab-lkp
pushed a commit
to intel-lab-lkp/linux
that referenced
this issue
Apr 6, 2025
Some comments in Rust files use raw URLs (http://example.com) rather than Markdown autolinks <URL>. This inconsistency makes the documentation less uniform and harder to maintain. This patch converts all remaining raw URLs in Rust code comments to use the Markdown autolink format, maintaining consistency with the rest of the codebase which already uses this style. Link: Rust-for-Linux#1153 Suggested-by: Miguel Ojeda <[email protected]> Signed-off-by: xizheyin <[email protected]>
intel-lab-lkp
pushed a commit
to intel-lab-lkp/linux
that referenced
this issue
Apr 7, 2025
Some comments in Rust files use raw URLs (http://example.com) rather than Markdown autolinks <URL>. This inconsistency makes the documentation less uniform and harder to maintain. This patch converts all remaining raw URLs in Rust code comments to use the Markdown autolink format, maintaining consistency with the rest of the codebase which already uses this style. Link: Rust-for-Linux#1153 Suggested-by: Miguel Ojeda <[email protected]> Signed-off-by: xizheyin <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
There are a few comments in Rust files that do not use a Markdown autolink (and others that do) -- to be consistent, and since generally we try to use Markdown in comments, mark the remaining ones.
This requires submitting a proper patch to the LKML and the Rust for Linux mailing list. Please recall to test your changes (including generating the documentation if changed, running the Rust doctests if changed, etc.), to use a proper title for the commit, to sign your commit under the Developer's Certificate of Origin and to add a
Suggested-by:tag, and aLink:tag to this issue. 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: