linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Peter Zijlstra <peterz@infradead.org>,
	Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	"Guilherme G. Piccoli" <gpiccoli@canonical.com>,
	Andrew Morton <akpm@linux-foundation.org>,
	Daniel Borkmann <daniel@iogearbox.net>,
	Kees Cook <keescook@chromium.org>, Lepton Wu <ytht.net@gmail.com>,
	Mel Gorman <mgorman@suse.de>, Qais Yousef <qais.yousef@arm.com>,
	Randy Dunlap <rdunlap@infradead.org>,
	Rasmus Villemoes <linux@rasmusvillemoes.dk>,
	Stephen Kitt <steve@sk2.org>, Wang Qing <wangqing@vivo.com>,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH 07/12] docs: accounting: update delay-accounting.rst reference
Date: Thu, 3 Jun 2021 13:35:14 +0200	[thread overview]
Message-ID: <20210603133514.3688071f@coco.lan> (raw)
In-Reply-To: <871r9k6rmy.fsf@meer.lwn.net>

Em Wed, 02 Jun 2021 12:36:05 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:

> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:
> 
> > That's said, automarkup.py has a rule to convert Documentation/<foo>.rst
> > into :doc:`<foo>`. So, an alternative approach would be to convert
> > treewide all :doc:`<foo>` into Documentation/<foo>.rst and add something 
> > at checkpatch.pl to recommend to avoid :doc: notation.  
> 
> That seems like the right approach to me.  We have the automarkup
> capability, we might as well make use of it...

Hmm...

This patch caused a regression:

<patch>
PATCH] media: admin-guide: avoid using ReSt :doc:`foo` markup

The :doc:`foo` tag is auto-generated via automarkup.py.
So, use the filename at the sources, instead of :doc:`foo`.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

diff --git a/Documentation/admin-guide/media/index.rst b/Documentation/admin-guide/media/index.rst
index 6e0d2bae7154..5dbf6d02096a 100644
--- a/Documentation/admin-guide/media/index.rst
+++ b/Documentation/admin-guide/media/index.rst
@@ -11,10 +11,10 @@ its supported drivers.
 
 Please see:
 
-- :doc:`/userspace-api/media/index`
+- Documentation/userspace-api/media/index.rst
      for the userspace APIs used on media devices.
 
-- :doc:`/driver-api/media/index`
+- Documentation/driver-api/media/index.rst
      for driver development information and Kernel APIs used by
      media devices;
</patch>

This is the diff for the HTML output:

<diff>
diff --git a/admin-guide/media/index.html b/admin-guide/media/index.html
index 94c0cdf51579..28c083b75896 100644
--- a/admin-guide/media/index.html
+++ b/admin-guide/media/index.html
@@ -339,12 +339,12 @@ its supported drivers.</p>
 <p>Please see:</p>
 <ul class="simple">
 <li><dl class="simple">
-<dt><a class="reference internal" href="../../userspace-api/media/index.html"><span class="doc">Linux Media Infrastructure userspace API</span></a></dt><dd><p>for the userspace APIs used on media devices.</p>
+<dt>Documentation/userspace-api/media/index.rst</dt><dd><p>for the userspace APIs used on media devices.</p>
 </dd>
 </dl>
 </li>
 <li><dl class="simple">
-<dt><a class="reference internal" href="../../driver-api/media/index.html"><span class="doc">Media subsystem kernel internal API</span></a></dt><dd><p>for driver development information and Kernel APIs used by
+<dt>Documentation/driver-api/media/index.rst</dt><dd><p>for driver development information and Kernel APIs used by
 media devices;</p>
 </dd>
 </dl>
</diff>

It sounds that automarkup.py ignored it. Maybe because it is inside
a list?

Thanks,
Mauro

  parent reply	other threads:[~2021-06-03 11:35 UTC|newest]

Thread overview: 36+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-06-02 15:43 [PATCH 00/12] Fix broken docs references at next-20210602 Mauro Carvalho Chehab
2021-06-02 15:43 ` [PATCH 01/12] dt-bindings: power: supply: cpcap-battery: update cpcap-battery.yaml reference Mauro Carvalho Chehab
2021-06-03  1:54   ` Rob Herring
2021-06-02 15:43 ` [PATCH 02/12] dt-bindings: power: supply: cpcap-charger: update cpcap-charger.yaml reference Mauro Carvalho Chehab
2021-06-03  1:54   ` Rob Herring
2021-06-02 15:43 ` [PATCH 03/12] dt-bindings: soc: ti: update sci-pm-domain.yaml references Mauro Carvalho Chehab
2021-06-02 21:03   ` Rob Herring
2021-06-03 20:08   ` Wolfram Sang
2021-06-02 15:43 ` [PATCH 04/12] dt-bindings: clock: update ti,sci-clk.yaml references Mauro Carvalho Chehab
2021-06-02 21:04   ` Rob Herring
2021-06-03 20:09   ` Wolfram Sang
2021-06-02 15:43 ` [PATCH 05/12] dt-bindings: reset: update ti,sci-reset.yaml references Mauro Carvalho Chehab
2021-06-02 21:04   ` Rob Herring
2021-06-02 15:43 ` [PATCH 06/12] dt-bindings: iio: io-channel-mux.yaml: fix a typo Mauro Carvalho Chehab
2021-06-02 21:04   ` Rob Herring
2021-06-02 15:43 ` [PATCH 07/12] docs: accounting: update delay-accounting.rst reference Mauro Carvalho Chehab
2021-06-02 16:38   ` Peter Zijlstra
2021-06-02 18:01     ` Mauro Carvalho Chehab
2021-06-02 18:29       ` Peter Zijlstra
2021-06-02 18:36       ` Jonathan Corbet
2021-06-02 20:19         ` Mauro Carvalho Chehab
2021-06-03  7:20           ` Peter Zijlstra
2021-06-03  7:56           ` Mauro Carvalho Chehab
2021-07-04 13:52             ` Federico Vaga
2021-06-03 11:35         ` Mauro Carvalho Chehab [this message]
2021-06-02 15:43 ` [PATCH 08/12] MAINTAINERS: update faraday,ftrtc010.yaml reference Mauro Carvalho Chehab
2021-06-06 22:50   ` Linus Walleij
2021-06-07  8:14   ` Alexandre Belloni
2021-06-02 15:43 ` [PATCH 09/12] MAINTAINERS: update marvell,armada-3700-utmi-phy.yaml reference Mauro Carvalho Chehab
2021-06-03  6:11   ` Vinod Koul
2021-06-02 15:43 ` [PATCH 10/12] MAINTAINERS: update ti,omap-gpio.yaml reference Mauro Carvalho Chehab
2021-06-07 14:15   ` Bartosz Golaszewski
2021-06-02 15:43 ` [PATCH 11/12] MAINTAINERS: update ti,sci.yaml reference Mauro Carvalho Chehab
2021-06-02 15:43 ` [PATCH 12/12] MAINTAINERS: update nxp,imx8-jpeg.yaml reference Mauro Carvalho Chehab
2021-06-03  8:18   ` [EXT] " Mirela Rabulea
2021-06-03 20:00 ` [PATCH 00/12] Fix broken docs references at next-20210602 Rob Herring

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=20210603133514.3688071f@coco.lan \
    --to=mchehab+huawei@kernel.org \
    --cc=akpm@linux-foundation.org \
    --cc=corbet@lwn.net \
    --cc=daniel@iogearbox.net \
    --cc=gpiccoli@canonical.com \
    --cc=keescook@chromium.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@rasmusvillemoes.dk \
    --cc=mgorman@suse.de \
    --cc=peterz@infradead.org \
    --cc=qais.yousef@arm.com \
    --cc=rdunlap@infradead.org \
    --cc=steve@sk2.org \
    --cc=wangqing@vivo.com \
    --cc=ytht.net@gmail.com \
    --subject='Re: [PATCH 07/12] docs: accounting: update delay-accounting.rst reference' \
    /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

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).