linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	"Martin K. Petersen" <martin.petersen@oracle.com>,
	Paul Mackerras <paulus@samba.org>,
	Madhuparna Bhowmik <madhuparnabhowmik04@gmail.com>,
	"David S. Miller" <davem@davemloft.net>,
	Ricardo Ribalda Delgado <ribalda@kernel.org>,
	Luca Ceresoli <luca@lucaceresoli.net>,
	dmaengine@vger.kernel.org,
	Matthias Maennich <maennich@google.com>,
	Harry Wei <harryxiyou@gmail.com>,
	x86@kernel.org, ecryptfs@vger.kernel.org,
	Jakub Kicinski <kuba@kernel.org>,
	target-devel@vger.kernel.org, "H. Peter Anvin" <hpa@zytor.com>,
	Hans Verkuil <hverkuil-cisco@xs4all.nl>,
	Benjamin Herrenschmidt <benh@kernel.crashing.org>,
	Johannes Berg <johannes.berg@intel.com>,
	Jacopo Mondi <jacopo@jmondi.org>, Tyler Hicks <code@tyhicks.com>,
	Vinod Koul <vkoul@kernel.org>,
	Alex Shi <alex.shi@linux.alibaba.com>,
	Thomas Gleixner <tglx@linutronix.de>,
	Ingo Molnar <mingo@redhat.com>,
	linux-scsi@vger.kernel.org, Michael Ellerman <mpe@ellerman.id.au>,
	netdev@vger.kernel.org,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	linuxppc-dev@lists.ozlabs.org, Borislav Petkov <bp@alien8.de>
Subject: [PATCH v2 0/2] Don't generate thousands of new warnings when building docs
Date: Fri, 20 Mar 2020 16:11:01 +0100	[thread overview]
Message-ID: <cover.1584716446.git.mchehab+huawei@kernel.org> (raw)

This small series address a regression caused by a new patch at
docs-next (and at linux-next).

Before this patch, when a cross-reference to a chapter within the
documentation is needed, we had to add a markup like:

	.. _foo:

	foo
	===

This behavor is now different after this patch:

	58ad30cf91f0 ("docs: fix reference to core-api/namespaces.rst")

As a Sphinx extension now creates automatically a reference
like the above, without requiring any extra markup.

That, however, comes with a price: it is not possible anymore to have
two sections with the same name within the entire Kernel docs!

This causes thousands of warnings, as we have sections named
"introduction" on lots of places.

This series solve this regression by doing two changes:

1) The references are now prefixed by the document name. So,
   a file named "bar" would have the "foo" reference as "bar:foo".

2) It will only use the first two levels. The first one is (usually) the
   name of the document, and the second one the chapter name.

This solves almost all problems we have. Still, there are a few places
where we have two chapters at the same document with the
same name. The first patch addresses this problem.

The second patch limits the escope of the autosectionlabel.

Mauro Carvalho Chehab (2):
  docs: prevent warnings due to autosectionlabel
  docs: conf.py: avoid thousands of duplicate label warning on Sphinx

 Documentation/conf.py                                 |  4 ++++
 Documentation/driver-api/80211/mac80211-advanced.rst  |  8 ++++----
 Documentation/driver-api/dmaengine/index.rst          |  4 ++--
 Documentation/filesystems/ecryptfs.rst                | 11 +++++------
 Documentation/kernel-hacking/hacking.rst              |  4 ++--
 Documentation/media/kapi/v4l2-controls.rst            |  8 ++++----
 Documentation/networking/snmp_counter.rst             |  4 ++--
 Documentation/powerpc/ultravisor.rst                  |  4 ++--
 Documentation/security/siphash.rst                    |  8 ++++----
 Documentation/target/tcmu-design.rst                  |  6 +++---
 .../translations/zh_CN/process/5.Posting.rst          |  2 +-
 Documentation/x86/intel-iommu.rst                     |  3 ++-
 12 files changed, 35 insertions(+), 31 deletions(-)

-- 
2.24.1



             reply	other threads:[~2020-03-20 15:11 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-03-20 15:11 Mauro Carvalho Chehab [this message]
2020-03-20 15:11 ` [PATCH v2 1/2] docs: prevent warnings due to autosectionlabel Mauro Carvalho Chehab
2020-03-20 15:11 ` [PATCH v2 2/2] docs: conf.py: avoid thousands of duplicate label warning on Sphinx Mauro Carvalho Chehab
2020-03-20 23:10 ` [PATCH v2 0/2] Don't generate thousands of new warnings when building docs Jonathan Corbet
2020-04-16 10:05   ` Jani Nikula
2020-04-07  3:46 ` Michael Ellerman
2020-04-08 11:40   ` 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=cover.1584716446.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.org \
    --cc=alex.shi@linux.alibaba.com \
    --cc=benh@kernel.crashing.org \
    --cc=bp@alien8.de \
    --cc=code@tyhicks.com \
    --cc=corbet@lwn.net \
    --cc=davem@davemloft.net \
    --cc=dmaengine@vger.kernel.org \
    --cc=ecryptfs@vger.kernel.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=harryxiyou@gmail.com \
    --cc=hpa@zytor.com \
    --cc=hverkuil-cisco@xs4all.nl \
    --cc=jacopo@jmondi.org \
    --cc=johannes.berg@intel.com \
    --cc=kuba@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-scsi@vger.kernel.org \
    --cc=linuxppc-dev@lists.ozlabs.org \
    --cc=luca@lucaceresoli.net \
    --cc=madhuparnabhowmik04@gmail.com \
    --cc=maennich@google.com \
    --cc=martin.petersen@oracle.com \
    --cc=mingo@redhat.com \
    --cc=mpe@ellerman.id.au \
    --cc=netdev@vger.kernel.org \
    --cc=paulus@samba.org \
    --cc=ribalda@kernel.org \
    --cc=target-devel@vger.kernel.org \
    --cc=tglx@linutronix.de \
    --cc=vkoul@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;
as well as URLs for NNTP newsgroup(s).