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

Improper rendering of table cell in Arch Support page #1069

Open
ojeda opened this issue Mar 17, 2024 · 7 comments
Open

Improper rendering of table cell in Arch Support page #1069

ojeda opened this issue Mar 17, 2024 · 7 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 Mar 17, 2024

The Arch Support documentation page renders one of the table cells improperly (as an empty bullet list). Please fix it so that the intended rendering (a dash, or similar, meaning "empty/nothing") is used instead.

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 Reported-by: and a Closes: tag to 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. Please do not take it if you do not plan to make other contributions to the kernel.
@ojeda ojeda added • docs Related to `Documentation/rust/`, `samples/`, generated docs, doctests, typos... good first issue Good for newcomers labels Mar 17, 2024
@BWbwchen
Copy link

Hi, I want to work on this issue.

@ojeda
Copy link
Member Author

ojeda commented Mar 22, 2024

Of course, please go ahead!

@BWbwchen
Copy link

Hi @ojeda,

I have sent the patch. 😃

@ojeda
Copy link
Member Author

ojeda commented Mar 23, 2024

Thanks!

https://lore.kernel.org/rust-for-linux/20240323074006.2940679-1-tim.chenbw@gmail.com/

@BWbwchen
Copy link

Hi @ojeda,

I have sent another patch
https://lore.kernel.org/rust-for-linux/20240324010915.3089934-1-tim.chenbw@gmail.com/

Could you help me to review it? Thank you for your help.

@ojeda
Copy link
Member Author

ojeda commented Mar 28, 2024

The patch looked good overall to me (I didn't try rendering yet, but I assume you tried and it works). We will start taking patches for the cycle soon, no worries. Thanks!

@BWbwchen
Copy link

Yes, I have rendered it and it worked well.
Screenshot_20240328_222600

ojeda pushed a commit to ojeda/linux that referenced this issue Mar 31, 2024
@BWbwchen @ojeda
docs: rust: fix improper rendering in Arch Support page
01848ee 
Fix improper rendering of table cell (empty bullet list) by rendering
as a dash using the backslash escaping mechanism [1].

Link: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#escaping-mechanism [1]
Reported-by: Miguel Ojeda <ojeda@kernel.org>
Closes: Rust-for-Linux#1069
Signed-off-by: Bo-Wei Chen <tim.chenbw@gmail.com>
Reviewed-by: Benno Lossin <benno.lossin@proton.me>
Fixes: 90868ff ("LoongArch: Enable initial Rust support")
Link: https://lore.kernel.org/r/20240324010915.3089934-1-tim.chenbw@gmail.com
[ Reworded slightly title and message; use "Link:" tag. ]
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
2 participants
@ojeda @BWbwchen