docs: rust: fix formatting of Hacking quick-start list

[PATCH] docs: rust: fix formatting of Hacking quick-start list

Posted by Jon Mulder 1 year, 3 months ago

Patch to remove indentation within the "hacking" section of the Rust
quick-start guide. This removes a `<blockquote>` HTML element from the
rendered documentation.

Reported-by: Miguel Ojeda <ojeda@kernel.org>
Closes: https://github.com/Rust-for-Linux/linux/issues/1103
Signed-off-by: Jon Mulder <jon.e.mulder@gmail.com>
---
Patch to remove indentation within the "hacking" section of the Rust
quick-start guide. This removes a `<blockquote>` HTML element from the
rendered documentation.
---
 Documentation/rust/quick-start.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/rust/quick-start.rst b/Documentation/rust/quick-start.rst
index ed5af2b5339a..2d107982c87b 100644
--- a/Documentation/rust/quick-start.rst
+++ b/Documentation/rust/quick-start.rst
@@ -305,7 +305,7 @@ If GDB/Binutils is used and Rust symbols are not getting demangled, the reason
 is the toolchain does not support Rust's new v0 mangling scheme yet.
 There are a few ways out:
 
-  - Install a newer release (GDB >= 10.2, Binutils >= 2.36).
+- Install a newer release (GDB >= 10.2, Binutils >= 2.36).
 
-  - Some versions of GDB (e.g. vanilla GDB 10.1) are able to use
-    the pre-demangled names embedded in the debug info (``CONFIG_DEBUG_INFO``).
+- Some versions of GDB (e.g. vanilla GDB 10.1) are able to use
+  the pre-demangled names embedded in the debug info (``CONFIG_DEBUG_INFO``).

---
base-commit: 6e6efc5fef4a1cdcccca3cffd5b73fd25d093352
change-id: 20240826-pr-docs-rust-remove-quickstart-blockquote-59af11a84c1a

Best regards,
-- 
Jon Mulder <jon.e.mulder@gmail.com>

Re: [PATCH] docs: rust: fix formatting of Hacking quick-start list

Posted by Miguel Ojeda 1 year, 3 months ago

On Mon, Aug 26, 2024 at 11:11 PM Jon Mulder <jon.e.mulder@gmail.com> wrote:
>
> Patch to remove indentation within the "hacking" section of the Rust
> quick-start guide. This removes a `<blockquote>` HTML element from the
> rendered documentation.
>
> Reported-by: Miguel Ojeda <ojeda@kernel.org>
> Closes: https://github.com/Rust-for-Linux/linux/issues/1103
> Signed-off-by: Jon Mulder <jon.e.mulder@gmail.com>

Applied to `rust-fixes` -- thanks!

    [ Added Fixes tag, reworded slightly and matched title to a previous,
      similar commit. - Miguel ]

Cheers,
Miguel