linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Peter Zijlstra <peterz@infradead.org>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	"Guilherme G. Piccoli" <gpiccoli@canonical.com>,
	Jonathan Corbet <corbet@lwn.net>,
	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: Wed, 2 Jun 2021 20:01:21 +0200	[thread overview]
Message-ID: <20210602200121.64a828a1@coco.lan> (raw)
In-Reply-To: <YLe0BQcrnfRgH1dV@hirez.programming.kicks-ass.net>

Em Wed, 2 Jun 2021 18:38:29 +0200
Peter Zijlstra <peterz@infradead.org> escreveu:

> On Wed, Jun 02, 2021 at 05:43:13PM +0200, Mauro Carvalho Chehab wrote:
> > When :doc: is used, the .rst should be removed. Also, the patches
> > are relative to the current directory.
> > 
> > So, the right reference should be:
> > 
> > 	:doc:`/accounting/delay-accounting`
> > 
> > Fixes: fcb501704554 ("delayacct: Document task_delayacct sysctl")
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> > ---
> >  Documentation/admin-guide/sysctl/kernel.rst | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/Documentation/admin-guide/sysctl/kernel.rst b/Documentation/admin-guide/sysctl/kernel.rst
> > index b2057173fe07..7f36cba3204b 100644
> > --- a/Documentation/admin-guide/sysctl/kernel.rst
> > +++ b/Documentation/admin-guide/sysctl/kernel.rst
> > @@ -1097,7 +1097,7 @@ task_delayacct
> >  ===============
> >  
> >  Enables/disables task delay accounting (see
> > -:doc:`accounting/delay-accounting.rst`). Enabling this feature incurs
> > +:doc:`/accounting/delay-accounting`). Enabling this feature incurs  
> 
> This breaks any chance of using 'goto file' like features in text
> editors :/ 

This is a feature of your favorite text editor. Not all have it.

> Can we please not do crap like this.

See, this is not the only place on this document using :doc:``. It is just
the one using it wrong:

	$ git grep :doc: Documentation/admin-guide/sysctl/kernel.rst
	Documentation/admin-guide/sysctl/kernel.rst:For general info and legal blurb, please look in :doc:`index`.
	Documentation/admin-guide/sysctl/kernel.rst:See :doc:`/power/video`. This allows the video resume mode to be set,
	Documentation/admin-guide/sysctl/kernel.rst::doc:`/x86/boot` for additional information.
	Documentation/admin-guide/sysctl/kernel.rst::doc:`/x86/boot` for additional information.
	Documentation/admin-guide/sysctl/kernel.rst:See :doc:`/driver-api/firmware/fallback-mechanisms`.
	Documentation/admin-guide/sysctl/kernel.rst:See :doc:`/trace/ftrace`.
	Documentation/admin-guide/sysctl/kernel.rst:See :doc:`/admin-guide/lockup-watchdogs` for more information.
	Documentation/admin-guide/sysctl/kernel.rst:to the guest kernel command line (see :doc:`/admin-guide/kernel-parameters`).
	Documentation/admin-guide/sysctl/kernel.rst:See :doc:`/admin-guide/initrd`.
	Documentation/admin-guide/sysctl/kernel.rst::doc:`accounting/delay-accounting.rst`). Enabling this feature incurs
	Documentation/admin-guide/sysctl/kernel.rst:See :doc:`/userspace-api/seccomp_filter`.
	Documentation/admin-guide/sysctl/kernel.rst:See :doc:`/admin-guide/sysrq`.
	Documentation/admin-guide/sysctl/kernel.rst:See :doc:`/admin-guide/tainted-kernels` for more information.
	Documentation/admin-guide/sysctl/kernel.rst:  See :doc:`/admin-guide/kernel-parameters` for more details on that particular
	Documentation/admin-guide/sysctl/kernel.rst:When set, disables tracing (see :doc:`/trace/ftrace`) when a
	Documentation/admin-guide/sysctl/kernel.rst:See :doc:`/admin-guide/kernel-parameters` and
	Documentation/admin-guide/sysctl/kernel.rst::doc:`/trace/boottime-trace`.

-

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.

Tests are needed, though, to be sure that automarkup.py won't miss
something, as the regex there might require tweaks to cover some
border cases.

Thanks,
Mauro

  reply	other threads:[~2021-06-02 18:01 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 [this message]
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
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=20210602200121.64a828a1@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).