public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Miguel Ojeda <miguel.ojeda.sandonis@gmail.com>
Cc: "Jonathan Corbet" <corbet@lwn.net>,
	"Linux Doc Mailing List" <linux-doc@vger.kernel.org>,
	"Mauro Carvalho Chehab" <mchehab@kernel.org>,
	linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org,
	"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
	"Alice Ryhl" <aliceryhl@google.com>,
	"Andreas Hindborg" <a.hindborg@kernel.org>,
	"Benno Lossin" <lossin@kernel.org>,
	"Boqun Feng" <boqun@kernel.org>,
	"Danilo Krummrich" <dakr@kernel.org>,
	"Gary Guo" <gary@garyguo.net>, "Miguel Ojeda" <ojeda@kernel.org>,
	"Shuah Khan" <skhan@linuxfoundation.org>,
	"Trevor Gross" <tmgross@umich.edu>
Subject: Re: [PATCH 8/9] docs: maintainers_include: don't ignore invalid profile entries
Date: Mon, 4 May 2026 22:26:37 +0200	[thread overview]
Message-ID: <20260504222637.176edc7c@foz.lan> (raw)
In-Reply-To: <CANiq72n+y0AerfiUzh5fLpMRiGGFq5rMxqweHG-TsmX_05vxBA@mail.gmail.com>

On Mon, 4 May 2026 18:08:06 +0200
Miguel Ojeda <miguel.ojeda.sandonis@gmail.com> wrote:

> On Mon, May 4, 2026 at 5:51 PM Mauro Carvalho Chehab
> <mchehab+huawei@kernel.org> wrote:
> >
> > Currently, there is a "P" entry for Rust pin-point that is
> > neither a valid ReST file nor an hyperlink. While the real  
> 
> I guess you mean pin-init above, i.e. this entry:
> 
>     P: rust/pin-init/CONTRIBUTING.md
> 
> It would be nice to clarify it in the commit message that it refers to
> a file (which is allowed for `P:` entries according to the docs).

It is not written there, but by file, it would actually be expected
a file within Documentation in ReST format ;-)

> And, yeah, ideally we could make it a hyperlink to the raw file.

I'm afraid that this is not possible. Sphinx doesn't allow
hyperlinks to point to files outside the documentation root
(which is Documentation/ when SPHINXDIRS is not used).

IMO the best would be to run:

	pandoc -i rust/pin-init/CONTRIBUTING.md -t rst -o Documentation/rust/pin-init-profile.rst
	sed s,rust/pin-init/CONTRIBUTING.md,Documentation/rust/pin-init-profile.rst, -i MAINTAINERS

This way, it will generate a proper hyperlink.

Thanks,
Mauro

  reply	other threads:[~2026-05-04 20:26 UTC|newest]

Thread overview: 30+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-05-04 15:51 [PATCH 0/9] Improve process/maintainers output Mauro Carvalho Chehab
2026-05-04 15:51 ` [PATCH 1/9] docs: maintainers_include: keep hidden TOC sorted Mauro Carvalho Chehab
2026-05-04 15:51 ` [PATCH 2/9] docs: escape ** glob pattern in MAINTAINERS descriptions Mauro Carvalho Chehab
2026-05-04 21:20   ` Randy Dunlap
2026-05-05  3:19     ` Joe Perches
2026-05-05  5:57       ` Mauro Carvalho Chehab
2026-05-05  6:46         ` Mauro Carvalho Chehab
2026-05-04 15:51 ` [PATCH 3/9] docs: maintainers_include.py: split state machine on multiple funcs Mauro Carvalho Chehab
2026-05-04 15:51 ` [PATCH 4/9] docs: maintainers_include: cleanup the code Mauro Carvalho Chehab
2026-05-04 15:51 ` [PATCH 5/9] docs: maintainers_include.py: clean most SPHINXDIRS=process warnings Mauro Carvalho Chehab
2026-05-04 15:51 ` [PATCH 6/9] docs: maintainers_include: do some coding style cleanups Mauro Carvalho Chehab
2026-05-04 15:51 ` [PATCH 7/9] docs: maintainers_include: store maintainers entries on a dict Mauro Carvalho Chehab
2026-05-04 15:51 ` [PATCH 8/9] docs: maintainers_include: don't ignore invalid profile entries Mauro Carvalho Chehab
2026-05-04 16:08   ` Miguel Ojeda
2026-05-04 20:26     ` Mauro Carvalho Chehab [this message]
2026-05-04 22:37       ` Gary Guo
2026-05-04 23:23         ` Mauro Carvalho Chehab
2026-05-05  0:25           ` Gary Guo
2026-05-04 23:34       ` Miguel Ojeda
2026-05-05  0:08         ` Mauro Carvalho Chehab
2026-05-05  0:20           ` Miguel Ojeda
2026-05-05  5:45             ` Mauro Carvalho Chehab
2026-05-05 11:16               ` Gary Guo
2026-05-05 13:09                 ` Mauro Carvalho Chehab
2026-05-05 14:37               ` Miguel Ojeda
2026-05-04 15:51 ` [PATCH 9/9] docs: maintainers: add a filtering javascript Mauro Carvalho Chehab
2026-05-04 21:12   ` Randy Dunlap
2026-05-05 13:00     ` Mauro Carvalho Chehab
2026-05-04 21:13 ` [PATCH 0/9] Improve process/maintainers output Randy Dunlap
2026-05-05 12:50   ` Mauro Carvalho Chehab

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=20260504222637.176edc7c@foz.lan \
    --to=mchehab+huawei@kernel.org \
    --cc=a.hindborg@kernel.org \
    --cc=aliceryhl@google.com \
    --cc=bjorn3_gh@protonmail.com \
    --cc=boqun@kernel.org \
    --cc=corbet@lwn.net \
    --cc=dakr@kernel.org \
    --cc=gary@garyguo.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lossin@kernel.org \
    --cc=mchehab@kernel.org \
    --cc=miguel.ojeda.sandonis@gmail.com \
    --cc=ojeda@kernel.org \
    --cc=rust-for-linux@vger.kernel.org \
    --cc=skhan@linuxfoundation.org \
    --cc=tmgross@umich.edu \
    /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