public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Petr Vorel <pvorel@suse.cz>, linux-doc@vger.kernel.org
Cc: Petr Vorel <pvorel@suse.cz>
Subject: Re: [PATCH 1/2] Documentation: bug-hunting.rst: Remove wrong 'file:' syntax
Date: Fri, 09 Jan 2026 08:51:57 -0700	[thread overview]
Message-ID: <874iou4wde.fsf@trenco.lwn.net> (raw)
In-Reply-To: <20260109152336.84674-1-pvorel@suse.cz>

Thanks for working to improve our docs

Petr Vorel <pvorel@suse.cz> writes:

> Link to another document does not require 'file:', therefore it was
> shown in generated html.
>
> Preformatted text requires just ``...``.
>
> Signed-off-by: Petr Vorel <pvorel@suse.cz>
> ---
>  Documentation/admin-guide/bug-hunting.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/admin-guide/bug-hunting.rst b/Documentation/admin-guide/bug-hunting.rst
> index 7da0504388ece..32b1b0c3d7ee4 100644
> --- a/Documentation/admin-guide/bug-hunting.rst
> +++ b/Documentation/admin-guide/bug-hunting.rst
> @@ -52,14 +52,14 @@ line is usually required to identify and handle the bug. Along this chapter,
>  we'll refer to "Oops" for all kinds of stack traces that need to be analyzed.
>  
>  If the kernel is compiled with ``CONFIG_DEBUG_INFO``, you can enhance the
> -quality of the stack trace by using file:`scripts/decode_stacktrace.sh`.
> +quality of the stack trace by using ``scripts/decode_stacktrace.sh``.
>  
>  Modules linked in
>  -----------------
>  
>  Modules that are tainted or are being loaded or unloaded are marked with
>  "(...)", where the taint flags are described in
> -file:`Documentation/admin-guide/tainted-kernels.rst`, "being loaded" is
> +`Documentation/admin-guide/tainted-kernels.rst`, "being loaded" is

Can I ask you to remove the `quotes` too?  They aren't needed and can
prevent the automarkup code from doing its thing.

Thanks,

jon

  parent reply	other threads:[~2026-01-09 15:52 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-01-09 15:23 [PATCH 1/2] Documentation: bug-hunting.rst: Remove wrong 'file:' syntax Petr Vorel
2026-01-09 15:23 ` [PATCH 2/2] Documentation/trace: Fix links to other documents Petr Vorel
2026-01-09 15:51 ` Jonathan Corbet [this message]
2026-01-09 17:25   ` [PATCH 1/2] Documentation: bug-hunting.rst: Remove wrong 'file:' syntax Petr Vorel
2026-01-09 20:40     ` Jonathan Corbet
2026-01-11 22:28       ` Petr Vorel

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=874iou4wde.fsf@trenco.lwn.net \
    --to=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=pvorel@suse.cz \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox