All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: "Mauro Carvalho Chehab" <mchehab@kernel.org>,
	"Mauro Carvalho Chehab" <mchehab+huawei@kernel.org>,
	linux-kernel@vger.kernel.org, "Jonathan Corbet" <corbet@lwn.net>,
	"Christian König" <christian.koenig@amd.com>,
	"David S. Miller" <davem@davemloft.net>,
	"H. Peter Anvin" <hpa@zytor.com>,
	"Krzysztof Wilczyński" <kw@linux.com>,
	"Theodore Ts'o" <tytso@mit.edu>, "Alex Shi" <alexs@kernel.org>,
	"Alexander Potapenko" <glider@google.com>,
	"Alexander Viro" <viro@zeniv.linux.org.uk>,
	"Andreas Dilger" <adilger.kernel@dilger.ca>,
	"Andrew Morton" <akpm@linux-foundation.org>,
	"Andrey Grodzovsky" <andrey.grodzovsky@amd.com>,
	"Borislav Petkov" <bp@alien8.de>,
	"Daniel Vetter" <daniel@ffwll.ch>,
	"Dave Hansen" <dave.hansen@linux.intel.com>,
	"David Airlie" <airlied@linux.ie>,
	"Dmitry Vyukov" <dvyukov@google.com>,
	"Eric Dumazet" <edumazet@google.com>,
	"Ingo Molnar" <mingo@redhat.com>,
	"Jakub Kicinski" <kuba@kernel.org>,
	"Leo Yan" <leo.yan@linaro.org>,
	"Marc Kleine-Budde" <mkl@pengutronix.de>,
	"Marco Elver" <elver@google.com>,
	"Mathieu Poirier" <mathieu.poirier@linaro.org>,
	"Max Staudt" <max@enpas.org>,
	"Mike Kravetz" <mike.kravetz@oracle.com>,
	"Mike Leach" <mike.leach@linaro.org>,
	"Muchun Song" <songmuchun@bytedance.com>,
	"Paolo Abeni" <pabeni@redhat.com>,
	"Sumit Semwal" <sumit.semwal@linaro.org>,
	"Suzuki K Poulose" <suzuki.poulose@arm.com>,
	"Thomas Gleixner" <tglx@linutronix.de>,
	"Wolfgang Grandegger" <wg@grandegger.com>,
	"Yanteng Si" <siyanteng@loongson.cn>,
	coresight@lists.linaro.org, dri-devel@lists.freedesktop.org,
	kasan-dev@googlegroups.com, kvm@vger.kernel.org,
	linaro-mm-sig@lists.linaro.org,
	linux-arm-kernel@lists.infradead.org, linux-cachefs@redhat.com,
	linux-can@vger.kernel.org, linux-ext4@vger.kernel.org,
	linux-fsdevel@vger.kernel.org, linux-media@vger.kernel.org,
	linux-mm@kvack.org, linux-pci@vger.kernel.org,
	linux-sgx@vger.kernel.org, netdev@vger.kernel.org,
	x86@kernel.org
Subject: [PATCH v3 00/21] Update Documentation/ cross references and fix issues
Date: Sat,  9 Jul 2022 11:07:13 +0100	[thread overview]
Message-ID: <cover.1657360984.git.mchehab@kernel.org> (raw)

This series fix almost all fixable issues when building the html docs at
linux-next (next-20220608):

- Address some broken cross-references;
- Fix kernel-doc warnings;
- Fix bad tags on ReST files.

With this series applied, plus other pending patches that should hopefully
be merged in time for the next merge window, htmldocs build will produce
just 4 warnings with Sphinx 2.4.4.

Sphinx >=3 will produce some extra false-positive warnings due to conflicts
between structs and functions sharing the same name. Hopefully this will
be fixed either on a new Sphinx 5.x version or Sphinx 6.0.

Mauro Carvalho Chehab (21):
  docs: networking: update netdevices.rst reference
  docs: update vmalloced-kernel-stacks.rst reference
  docs: update vmemmap_dedup.rst reference
  docs: zh_CN: page_migration: fix reference to mm index.rst
  dt-bindings: arm: update arm,coresight-cpu-debug.yaml reference
  x86/sgx: fix kernel-doc markups
  fscache: fix kernel-doc documentation
  fs: namei: address some kernel-doc issues
  drm/scheduler: fix a kernel-doc warning
  drm/scheduler: add a missing kernel-doc parameter
  kfence: fix a kernel-doc parameter
  genalloc: add a description for start_addr parameter
  textsearch: document list inside struct ts_ops
  dcache: fix a kernel-doc warning
  docs: ext4: blockmap.rst: fix a broken table
  docs: PCI: pci-vntb-function.rst: Properly include ascii artwork
  docs: PCI: pci-vntb-howto.rst: fix a title markup
  docs: virt: kvm: fix a title markup at api.rst
  docs: ABI: sysfs-bus-nvdimm
  docs: leds: index.rst: add leds-qcom-lpg to it
  Documentation: coresight: fix binding wildcards

 Documentation/ABI/testing/sysfs-bus-nvdimm             |  2 ++
 Documentation/PCI/endpoint/pci-vntb-function.rst       |  2 +-
 Documentation/PCI/endpoint/pci-vntb-howto.rst          |  2 +-
 Documentation/filesystems/ext4/blockmap.rst            |  2 +-
 Documentation/leds/index.rst                           |  1 +
 Documentation/trace/coresight/coresight-cpu-debug.rst  |  2 +-
 Documentation/trace/coresight/coresight.rst            |  2 +-
 Documentation/translations/zh_CN/mm/page_migration.rst |  2 +-
 .../translations/zh_CN/mm/vmalloced-kernel-stacks.rst  |  2 +-
 Documentation/virt/kvm/api.rst                         |  6 +++---
 arch/x86/include/uapi/asm/sgx.h                        | 10 ++++++++--
 drivers/gpu/drm/scheduler/sched_main.c                 |  1 +
 drivers/net/can/can327.c                               |  2 +-
 fs/namei.c                                             |  3 +++
 include/drm/gpu_scheduler.h                            |  1 +
 include/linux/dcache.h                                 |  2 +-
 include/linux/fscache.h                                |  4 ++--
 include/linux/genalloc.h                               |  1 +
 include/linux/kfence.h                                 |  1 +
 include/linux/textsearch.h                             |  1 +
 mm/hugetlb_vmemmap.h                                   |  2 +-
 21 files changed, 34 insertions(+), 17 deletions(-)

-- 
2.36.1



WARNING: multiple messages have this Message-ID (diff)
From: Mauro Carvalho Chehab <mchehab@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: "Krzysztof Wilczyński" <kw@linux.com>,
	linux-cachefs@redhat.com, kvm@vger.kernel.org,
	"David Airlie" <airlied@linux.ie>,
	linux-pci@vger.kernel.org,
	"Dave Hansen" <dave.hansen@linux.intel.com>,
	dri-devel@lists.freedesktop.org, linux-mm@kvack.org,
	"Eric Dumazet" <edumazet@google.com>,
	"Alexander Potapenko" <glider@google.com>,
	"H. Peter Anvin" <hpa@zytor.com>,
	"Marc Kleine-Budde" <mkl@pengutronix.de>,
	"Sumit Semwal" <sumit.semwal@linaro.org>,
	"Alex Shi" <alexs@kernel.org>,
	"Yanteng Si" <siyanteng@loongson.cn>,
	"Jonathan Corbet" <corbet@lwn.net>,
	"Mauro Carvalho Chehab" <mchehab+huawei@kernel.org>,
	x86@kernel.org, kasan-dev@googlegroups.com,
	"Ingo Molnar" <mingo@redhat.com>,
	linux-arm-kernel@lists.infradead.org,
	"Jakub Kicinski" <kuba@kernel.org>,
	"Paolo Abeni" <pabeni@redhat.com>,
	"Wolfgang Grandegger" <wg@grandegger.com>,
	"Mike Leach" <mike.leach@linaro.org>,
	"Marco Elver" <elver@google.com>,
	"Suzuki K Poulose" <suzuki.poulose@arm.com>,
	coresight@lists.linaro.org, linux-can@vger.kernel.org,
	"Max Staudt" <max@enpas.org>, "Borislav Petkov" <bp@alien8.de>,
	"Alexander Viro" <viro@zeniv.linux.org.uk>,
	"Muchun Song" <songmuchun@bytedance.com>,
	"Thomas Gleixner" <tglx@linutronix.de>,
	"Mauro Carvalho Chehab" <mchehab@kernel.org>,
	"Dmitry Vyukov" <dvyukov@google.com>,
	linux-sgx@vger.kernel.org, linaro-mm-sig@lists.linaro.org,
	linux-ext4@vger.kernel.org, "Theodore Ts'o" <tytso@mit.edu>,
	"Mathieu Poirier" <mathieu.poirier@linaro.org>,
	netdev@vger.kernel.org, linux-kernel@vger.kernel.org,
	"David S. Miller" <davem@davemloft.net>,
	"Leo Yan" <leo.yan@linaro.org>,
	linux-fsdevel@vger.kernel.org,
	"Andreas Dilger" <adilger.kernel@dilger.ca>,
	"Andrew Morton" <akpm@linux-foundation.org>,
	linux-media@vger.kernel.org,
	"Christian König" <christian.koenig@amd.com>,
	"Mike Kravetz" <mike.kravetz@oracle.com>
Subject: [PATCH v3 00/21] Update Documentation/ cross references and fix issues
Date: Sat,  9 Jul 2022 11:07:13 +0100	[thread overview]
Message-ID: <cover.1657360984.git.mchehab@kernel.org> (raw)

This series fix almost all fixable issues when building the html docs at
linux-next (next-20220608):

- Address some broken cross-references;
- Fix kernel-doc warnings;
- Fix bad tags on ReST files.

With this series applied, plus other pending patches that should hopefully
be merged in time for the next merge window, htmldocs build will produce
just 4 warnings with Sphinx 2.4.4.

Sphinx >=3 will produce some extra false-positive warnings due to conflicts
between structs and functions sharing the same name. Hopefully this will
be fixed either on a new Sphinx 5.x version or Sphinx 6.0.

Mauro Carvalho Chehab (21):
  docs: networking: update netdevices.rst reference
  docs: update vmalloced-kernel-stacks.rst reference
  docs: update vmemmap_dedup.rst reference
  docs: zh_CN: page_migration: fix reference to mm index.rst
  dt-bindings: arm: update arm,coresight-cpu-debug.yaml reference
  x86/sgx: fix kernel-doc markups
  fscache: fix kernel-doc documentation
  fs: namei: address some kernel-doc issues
  drm/scheduler: fix a kernel-doc warning
  drm/scheduler: add a missing kernel-doc parameter
  kfence: fix a kernel-doc parameter
  genalloc: add a description for start_addr parameter
  textsearch: document list inside struct ts_ops
  dcache: fix a kernel-doc warning
  docs: ext4: blockmap.rst: fix a broken table
  docs: PCI: pci-vntb-function.rst: Properly include ascii artwork
  docs: PCI: pci-vntb-howto.rst: fix a title markup
  docs: virt: kvm: fix a title markup at api.rst
  docs: ABI: sysfs-bus-nvdimm
  docs: leds: index.rst: add leds-qcom-lpg to it
  Documentation: coresight: fix binding wildcards

 Documentation/ABI/testing/sysfs-bus-nvdimm             |  2 ++
 Documentation/PCI/endpoint/pci-vntb-function.rst       |  2 +-
 Documentation/PCI/endpoint/pci-vntb-howto.rst          |  2 +-
 Documentation/filesystems/ext4/blockmap.rst            |  2 +-
 Documentation/leds/index.rst                           |  1 +
 Documentation/trace/coresight/coresight-cpu-debug.rst  |  2 +-
 Documentation/trace/coresight/coresight.rst            |  2 +-
 Documentation/translations/zh_CN/mm/page_migration.rst |  2 +-
 .../translations/zh_CN/mm/vmalloced-kernel-stacks.rst  |  2 +-
 Documentation/virt/kvm/api.rst                         |  6 +++---
 arch/x86/include/uapi/asm/sgx.h                        | 10 ++++++++--
 drivers/gpu/drm/scheduler/sched_main.c                 |  1 +
 drivers/net/can/can327.c                               |  2 +-
 fs/namei.c                                             |  3 +++
 include/drm/gpu_scheduler.h                            |  1 +
 include/linux/dcache.h                                 |  2 +-
 include/linux/fscache.h                                |  4 ++--
 include/linux/genalloc.h                               |  1 +
 include/linux/kfence.h                                 |  1 +
 include/linux/textsearch.h                             |  1 +
 mm/hugetlb_vmemmap.h                                   |  2 +-
 21 files changed, 34 insertions(+), 17 deletions(-)

-- 
2.36.1



             reply	other threads:[~2022-07-09 10:07 UTC|newest]

Thread overview: 36+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-09 10:07 Mauro Carvalho Chehab [this message]
2022-07-09 10:07 ` [PATCH v3 00/21] Update Documentation/ cross references and fix issues Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 01/21] docs: networking: update netdevices.rst reference Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 02/21] docs: update vmalloced-kernel-stacks.rst reference Mauro Carvalho Chehab
2022-07-09 13:37   ` Wu XiangCheng
2022-07-11  2:32   ` YanTeng Si
2022-07-09 10:07 ` [PATCH v3 03/21] docs: update vmemmap_dedup.rst reference Mauro Carvalho Chehab
2022-07-11  6:05   ` Muchun Song
2022-07-09 10:07 ` [PATCH v3 04/21] docs: zh_CN: page_migration: fix reference to mm index.rst Mauro Carvalho Chehab
2022-07-09 10:41   ` Wu XiangCheng
2022-07-11  2:28   ` YanTeng Si
2022-07-09 10:07 ` [PATCH v3 05/21] dt-bindings: arm: update arm,coresight-cpu-debug.yaml reference Mauro Carvalho Chehab
2022-07-09 10:07   ` Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 06/21] x86/sgx: fix kernel-doc markups Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 07/21] fscache: fix kernel-doc documentation Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 08/21] fs: namei: address some kernel-doc issues Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 09/21] drm/scheduler: fix a kernel-doc warning Mauro Carvalho Chehab
2022-07-09 10:07   ` Mauro Carvalho Chehab
2022-08-11 16:32   ` Alex Deucher
2022-08-11 16:32     ` Alex Deucher
2022-07-09 10:07 ` [PATCH v3 10/21] drm/scheduler: add a missing kernel-doc parameter Mauro Carvalho Chehab
2022-07-09 10:07   ` Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 11/21] kfence: fix a " Mauro Carvalho Chehab
2022-07-09 10:07   ` Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 12/21] genalloc: add a description for start_addr parameter Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 13/21] textsearch: document list inside struct ts_ops Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 14/21] dcache: fix a kernel-doc warning Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 15/21] docs: ext4: blockmap.rst: fix a broken table Mauro Carvalho Chehab
2022-07-09 15:37   ` Theodore Ts'o
2022-07-09 10:07 ` [PATCH v3 16/21] docs: PCI: pci-vntb-function.rst: Properly include ascii artwork Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 17/21] docs: PCI: pci-vntb-howto.rst: fix a title markup Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 18/21] docs: virt: kvm: fix a title markup at api.rst Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 19/21] docs: ABI: sysfs-bus-nvdimm Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 20/21] docs: leds: index.rst: add leds-qcom-lpg to it Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 21/21] Documentation: coresight: fix binding wildcards Mauro Carvalho Chehab
2022-07-09 10:07   ` 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.1657360984.git.mchehab@kernel.org \
    --to=mchehab@kernel.org \
    --cc=adilger.kernel@dilger.ca \
    --cc=airlied@linux.ie \
    --cc=akpm@linux-foundation.org \
    --cc=alexs@kernel.org \
    --cc=andrey.grodzovsky@amd.com \
    --cc=bp@alien8.de \
    --cc=christian.koenig@amd.com \
    --cc=corbet@lwn.net \
    --cc=coresight@lists.linaro.org \
    --cc=daniel@ffwll.ch \
    --cc=dave.hansen@linux.intel.com \
    --cc=davem@davemloft.net \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=dvyukov@google.com \
    --cc=edumazet@google.com \
    --cc=elver@google.com \
    --cc=glider@google.com \
    --cc=hpa@zytor.com \
    --cc=kasan-dev@googlegroups.com \
    --cc=kuba@kernel.org \
    --cc=kvm@vger.kernel.org \
    --cc=kw@linux.com \
    --cc=leo.yan@linaro.org \
    --cc=linaro-mm-sig@lists.linaro.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-cachefs@redhat.com \
    --cc=linux-can@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-ext4@vger.kernel.org \
    --cc=linux-fsdevel@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=linux-mm@kvack.org \
    --cc=linux-pci@vger.kernel.org \
    --cc=linux-sgx@vger.kernel.org \
    --cc=mathieu.poirier@linaro.org \
    --cc=max@enpas.org \
    --cc=mchehab+huawei@kernel.org \
    --cc=mike.kravetz@oracle.com \
    --cc=mike.leach@linaro.org \
    --cc=mingo@redhat.com \
    --cc=mkl@pengutronix.de \
    --cc=netdev@vger.kernel.org \
    --cc=pabeni@redhat.com \
    --cc=siyanteng@loongson.cn \
    --cc=songmuchun@bytedance.com \
    --cc=sumit.semwal@linaro.org \
    --cc=suzuki.poulose@arm.com \
    --cc=tglx@linutronix.de \
    --cc=tytso@mit.edu \
    --cc=viro@zeniv.linux.org.uk \
    --cc=wg@grandegger.com \
    --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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.