[PATCH 2/2] drm/panic: fix overindented list items in documentation
Jocelyn Falempe
jfalempe at redhat.com
Mon Mar 3 09:41:40 UTC 2025
On 02/03/2025 00:16, Miguel Ojeda wrote:
> Starting with the upcoming Rust 1.86.0 (to be released 2025-04-03),
> Clippy warns:
>
> error: doc list item overindented
> --> drivers/gpu/drm/drm_panic_qr.rs:914:5
> |
> 914 | /// will be encoded as binary segment, otherwise it will be encoded
> | ^^^ help: try using ` ` (2 spaces)
> |
> = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_overindented_list_items
>
> The overindentation is slightly hard to notice, since all the items
> start with a backquote that makes it look OK, but it is there.
>
> Thus fix it.
Thanks, it looks good to me.
Reviewed-by: Jocelyn Falempe <jfalempe at redhat.com>
>
> Signed-off-by: Miguel Ojeda <ojeda at kernel.org>
> ---
> drivers/gpu/drm/drm_panic_qr.rs | 12 ++++++------
> 1 file changed, 6 insertions(+), 6 deletions(-)
>
> diff --git a/drivers/gpu/drm/drm_panic_qr.rs b/drivers/gpu/drm/drm_panic_qr.rs
> index 8bb5e52d75cc..6903e2010cb9 100644
> --- a/drivers/gpu/drm/drm_panic_qr.rs
> +++ b/drivers/gpu/drm/drm_panic_qr.rs
> @@ -911,16 +911,16 @@ fn draw_all(&mut self, data: impl Iterator<Item = u8>) {
> ///
> /// * `url`: The base URL of the QR code. It will be encoded as Binary segment.
> /// * `data`: A pointer to the binary data, to be encoded. if URL is NULL, it
> -/// will be encoded as binary segment, otherwise it will be encoded
> -/// efficiently as a numeric segment, and appended to the URL.
> +/// will be encoded as binary segment, otherwise it will be encoded
> +/// efficiently as a numeric segment, and appended to the URL.
> /// * `data_len`: Length of the data, that needs to be encoded, must be less
> -/// than data_size.
> +/// than data_size.
> /// * `data_size`: Size of data buffer, it should be at least 4071 bytes to hold
> -/// a V40 QR code. It will then be overwritten with the QR code image.
> +/// a V40 QR code. It will then be overwritten with the QR code image.
> /// * `tmp`: A temporary buffer that the QR code encoder will use, to write the
> -/// segments and ECC.
> +/// segments and ECC.
> /// * `tmp_size`: Size of the temporary buffer, it must be at least 3706 bytes
> -/// long for V40.
> +/// long for V40.
> ///
> /// # Safety
> ///
More information about the dri-devel
mailing list