mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: "Habil Eren Türker" <habilerenturker@gmail.com>,
	clemens@ladisch.de, tglx@kernel.org
Cc: skhan@linuxfoundation.org, anna-maria@linutronix.de,
	frederic@kernel.org, linux-doc@vger.kernel.org, x86@kernel.org,
	linux-kernel@vger.kernel.org,
	"Habil Eren Türker" <habilerenturker@hotmail.com>
Subject: Re: [PATCH v2 1/2] [PATCH v2 1/2] docs: timers: hpet: Modernize file references
Date: Sat, 26 Sep 2026 15:46:23 -0600	[thread overview]
Message-ID: <87o6dj4rf4.fsf@trenco.lwn.net> (raw)
In-Reply-To: <20260926180838.8145-2-habilerenturker@hotmail.com>

"Habil Eren Türker" <habilerenturker@gmail.com> writes:

> The current HPET documentation contains outdated 'file:' prefixes for
> source tree references, which breaks proper rendering and hyperlink
> generation under the modern Sphinx-based documentation ecosystem.
>
> Fix this by modernizing the paths using the standard literal backticks
> formatting.
>
> Signed-off-by: Habil Eren Türker <habilerenturker@hotmail.com>
> ---
>  Documentation/timers/hpet.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/timers/hpet.rst b/Documentation/timers/hpet.rst
> index c9d05d3ca..fe02bfd5d 100644
> --- a/Documentation/timers/hpet.rst
> +++ b/Documentation/timers/hpet.rst
> @@ -23,8 +23,8 @@ The driver supports detection of HPET driver allocation and initialization
>  of the HPET before the driver module_init routine is called.  This enables
>  platform code which uses timer 0 or 1 as the main timer to intercept HPET
>  initialization.  An example of this initialization can be found in
> -arch/x86/kernel/hpet.c.
> +``arch/x86/kernel/hpet.c``.
>  
>  The driver provides a userspace API which resembles the API found in the
>  RTC driver framework.  An example user space program is provided in
> -file:samples/timers/hpet_example.c
> +``samples/timers/hpet_example.c``
> \ No newline at end of file

That last line is something you should really have fixed before sending
this patch.

Thanks,

jon

  reply	other threads:[~2026-09-26 21:46 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <87o72mg21g.fsf@moria.home.lwn.net>
2026-09-26 18:08 ` [PATCH v2 0/2] docs: timers: hpet: Modernize and document API Habil Eren Türker
2026-09-26 18:08   ` [PATCH v2 1/2] [PATCH v2 1/2] docs: timers: hpet: Modernize file references Habil Eren Türker
2026-09-26 21:46     ` Jonathan Corbet [this message]
2026-09-26 21:48       ` Jonathan Corbet
2026-09-27  7:19         ` Habil Eren Türker
2026-09-27  7:23         ` [PATCH v3 0/2] docs: timers: hpet: Modernize and document API Habil Eren Türker
2026-09-27  7:23           ` [PATCH v3 1/2] docs: timers: hpet: Modernize file references Habil Eren Türker
2026-09-27  7:23           ` [PATCH v3 2/2] docs: timers: hpet: Document userspace API and ioctl commands Habil Eren Türker
2026-09-26 18:08   ` [PATCH v2 2/2] [PATCH v2 " Habil Eren Türker

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=87o6dj4rf4.fsf@trenco.lwn.net \
    --to=corbet@lwn.net \
    --cc=anna-maria@linutronix.de \
    --cc=clemens@ladisch.de \
    --cc=frederic@kernel.org \
    --cc=habilerenturker@gmail.com \
    --cc=habilerenturker@hotmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=skhan@linuxfoundation.org \
    --cc=tglx@kernel.org \
    --cc=x86@kernel.org \
    /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

all inboxes | Powered by JetHome®