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>, corbet@lwn.net
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>,
	linux-kernel@vger.kernel.org,
	"Peter Zijlstra (Intel)" <peterz@infradead.org>,
	Akira Yokosawa <akiyks@gmail.com>, Alex Shi <alexs@kernel.org>,
	Andrew Morton <akpm@linux-foundation.org>,
	Andrey Grodzovsky <andrey.grodzovsky@amd.com>,
	Bagas Sanjaya <bagasdotme@gmail.com>,
	Dan Williams <dan.j.williams@intel.com>,
	Daniel Vetter <daniel@ffwll.ch>, David Airlie <airlied@linux.ie>,
	David Howells <dhowells@redhat.com>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Ilya Dryomov <idryomov@gmail.com>, Jiri Kosina <jkosina@suse.cz>,
	Jiri Slaby <jirislaby@kernel.org>,
	Kajol Jain <kjain@linux.ibm.com>,
	Kosuke Fujimoto <fujimotokosuke0@gmail.com>,
	Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>,
	Leo Yan <leo.yan@linaro.org>,
	Luis Chamberlain <mcgrof@kernel.org>,
	Lukas Bulwahn <lukas.bulwahn@gmail.com>,
	Madhavan Srinivasan <maddy@in.ibm.com>,
	Mathieu Poirier <mathieu.poirier@linaro.org>,
	Mike Kravetz <mike.kravetz@oracle.com>,
	Mike Leach <mike.leach@linaro.org>,
	Mike Rapoport <rppt@kernel.org>,
	Muchun Song <songmuchun@bytedance.com>,
	Rob Herring <robh@kernel.org>,
	Sebastian Andrzej Siewior <bigeasy@linutronix.de>,
	Suzuki K Poulose <suzuki.poulose@arm.com>,
	Tsugikazu Shibata <shibata@linuxfoundation.org>,
	Wu XiangCheng <bobwxc@email.cn>, Xiubo Li <xiubli@redhat.com>,
	Yanteng Si <siyanteng@loongson.cn>,
	coresight@lists.linaro.org, dri-devel@lists.freedesktop.org,
	linux-arm-kernel@lists.infradead.org, linux-cachefs@redhat.com,
	linux-mm@kvack.org
Subject: [PATCH 00/13] Fix documentation build warnings against 6.0-rc1
Date: Thu, 18 Aug 2022 15:38:46 +0200	[thread overview]
Message-ID: <cover.1660829433.git.mchehab@kernel.org> (raw)

Hi Jon,

This series is against 6.0-rc1, so it should apply fine on the top of your tree.

After applying one fix sent to ACPI:

https://lore.kernel.org/linux-acpi/20220818055156.7456-1-sakari.ailus@linux.intel.com/T/#u

make htmldocs (with Sphinx 2.4.4) produces a very clean result:
:

	Warning: Documentation/devicetree/bindings/regulator/siliconmitus,sm5703
-regulator.yaml references a file that doesn't exist: Documentation/devicetree/b
indings/mfd/siliconmitus,sm5703.yaml
	  SPHINX  htmldocs --> file:///new_devel/v4l/docs/Documentation/output
	  PARSE   include/uapi/linux/dvb/ca.h
	  PARSE   include/uapi/linux/dvb/dmx.h
	  PARSE   include/uapi/linux/dvb/frontend.h
	  PARSE   include/uapi/linux/dvb/net.h
	  PARSE   include/uapi/linux/videodev2.h
	  PARSE   include/uapi/linux/media.h
	  PARSE   include/uapi/linux/cec.h
	  PARSE   include/uapi/linux/lirc.h
	Using sphinx_rtd_theme theme

The only warning is due to a driver that got its upstream way for MFD, but it seems that
the corresponding regulator driver has lost its way.

If we can fix such warning, we could add a sort of "Werror" for:

	- some ABI issues;
	- kernel-doc warnings/errors;
	- broken kernel-doc warnings.

Although there will still have Sphinx warnings that can come up from various sources,
this could help to keep documentation on a better shape, as time goes by.

Regards,
Mauro


Mauro Carvalho Chehab (13):
  scripts: kernel-doc: add support for EXPORT_SYMBOL variants
  docs: update vmemmap_dedup.rst reference
  docs: ja_JP: remove SubmittingPatches
  docs: zh_CN: remove references to rust documentation
  dt-bindings: arm: update arm,coresight-cpu-debug.yaml reference
  Documentation: coresight: fix a documentation build warning
  MAINTAINERS: fix wildcard for mfd da90* files
  MAINTAINERS: fix a typo for hpe,gxp-spifi.yaml
  ABI: sysfs-bus-nvdimm: fix a doc build warning
  docs: leds: add leds-qcom-lpg.rst to the index file
  fscache: fix kernel-doc markup on two functions
  serial: document start_rx member at struct uart_ops
  fs/dcache: fix a kernel-doc markup

 Documentation/ABI/testing/sysfs-bus-nvdimm    |   2 +
 Documentation/leds/index.rst                  |   1 +
 .../trace/coresight/coresight-cpu-debug.rst   |   2 +-
 Documentation/trace/coresight/coresight.rst   |   2 +-
 .../translations/ja_JP/SubmittingPatches      | 722 ------------------
 .../zh_CN/doc-guide/kernel-doc.rst            |   2 -
 MAINTAINERS                                   |   4 +-
 drivers/gpu/drm/scheduler/sched_main.c        |   1 +
 include/drm/gpu_scheduler.h                   |   1 +
 include/linux/dcache.h                        |  10 +-
 include/linux/fscache.h                       |   4 +-
 include/linux/serial_core.h                   |   8 +
 mm/hugetlb_vmemmap.h                          |   2 +-
 scripts/kernel-doc                            |   8 +-
 14 files changed, 33 insertions(+), 736 deletions(-)
 delete mode 100644 Documentation/translations/ja_JP/SubmittingPatches

-- 
2.37.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>, corbet@lwn.net
Cc: Kosuke Fujimoto <fujimotokosuke0@gmail.com>,
	"Peter Zijlstra \(Intel\)" <peterz@infradead.org>,
	Sebastian Andrzej Siewior <bigeasy@linutronix.de>,
	Akira Yokosawa <akiyks@gmail.com>,
	dri-devel@lists.freedesktop.org,
	David Howells <dhowells@redhat.com>,
	linux-mm@kvack.org, Bagas Sanjaya <bagasdotme@gmail.com>,
	Jiri Slaby <jirislaby@kernel.org>, Alex Shi <alexs@kernel.org>,
	Xiubo Li <xiubli@redhat.com>,
	Luis Chamberlain <mcgrof@kernel.org>,
	David Airlie <airlied@linux.ie>,
	linux-cachefs@redhat.com, Lukas Bulwahn <lukas.bulwahn@gmail.com>,
	Ilya Dryomov <idryomov@gmail.com>,
	Mike Leach <mike.leach@linaro.org>,
	Madhavan Srinivasan <maddy@in.ibm.com>,
	Suzuki K Poulose <suzuki.poulose@arm.com>,
	Kajol Jain <kjain@linux.ibm.com>,
	coresight@lists.linaro.org, Wu XiangCheng <bobwxc@email.cn>,
	Tsugikazu Shibata <shibata@linuxfoundation.org>,
	Yanteng Si <siyanteng@loongson.cn>,
	Muchun Song <songmuchun@bytedance.com>,
	Dan Williams <dan.j.williams@intel.com>,
	Mauro Carvalho Chehab <mchehab@kernel.org>,
	linux-arm-kernel@lists.infradead.org,
	Mathieu Poirier <mathieu.poirier@linaro.org>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	linux-kernel@vger.kernel.org,
	Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>,
	Leo Yan <leo.yan@linaro.org>, Jiri Kosina <jkosina@suse.cz>,
	Andrew Morton <akpm@linux-foundation.org>,
	Mike Rapoport <rppt@kernel.org>,
	Mike Kravetz <mike.kravetz@oracle.com>
Subject: [PATCH 00/13] Fix documentation build warnings against 6.0-rc1
Date: Thu, 18 Aug 2022 15:38:46 +0200	[thread overview]
Message-ID: <cover.1660829433.git.mchehab@kernel.org> (raw)

Hi Jon,

This series is against 6.0-rc1, so it should apply fine on the top of your tree.

After applying one fix sent to ACPI:

https://lore.kernel.org/linux-acpi/20220818055156.7456-1-sakari.ailus@linux.intel.com/T/#u

make htmldocs (with Sphinx 2.4.4) produces a very clean result:
:

	Warning: Documentation/devicetree/bindings/regulator/siliconmitus,sm5703
-regulator.yaml references a file that doesn't exist: Documentation/devicetree/b
indings/mfd/siliconmitus,sm5703.yaml
	  SPHINX  htmldocs --> file:///new_devel/v4l/docs/Documentation/output
	  PARSE   include/uapi/linux/dvb/ca.h
	  PARSE   include/uapi/linux/dvb/dmx.h
	  PARSE   include/uapi/linux/dvb/frontend.h
	  PARSE   include/uapi/linux/dvb/net.h
	  PARSE   include/uapi/linux/videodev2.h
	  PARSE   include/uapi/linux/media.h
	  PARSE   include/uapi/linux/cec.h
	  PARSE   include/uapi/linux/lirc.h
	Using sphinx_rtd_theme theme

The only warning is due to a driver that got its upstream way for MFD, but it seems that
the corresponding regulator driver has lost its way.

If we can fix such warning, we could add a sort of "Werror" for:

	- some ABI issues;
	- kernel-doc warnings/errors;
	- broken kernel-doc warnings.

Although there will still have Sphinx warnings that can come up from various sources,
this could help to keep documentation on a better shape, as time goes by.

Regards,
Mauro


Mauro Carvalho Chehab (13):
  scripts: kernel-doc: add support for EXPORT_SYMBOL variants
  docs: update vmemmap_dedup.rst reference
  docs: ja_JP: remove SubmittingPatches
  docs: zh_CN: remove references to rust documentation
  dt-bindings: arm: update arm,coresight-cpu-debug.yaml reference
  Documentation: coresight: fix a documentation build warning
  MAINTAINERS: fix wildcard for mfd da90* files
  MAINTAINERS: fix a typo for hpe,gxp-spifi.yaml
  ABI: sysfs-bus-nvdimm: fix a doc build warning
  docs: leds: add leds-qcom-lpg.rst to the index file
  fscache: fix kernel-doc markup on two functions
  serial: document start_rx member at struct uart_ops
  fs/dcache: fix a kernel-doc markup

 Documentation/ABI/testing/sysfs-bus-nvdimm    |   2 +
 Documentation/leds/index.rst                  |   1 +
 .../trace/coresight/coresight-cpu-debug.rst   |   2 +-
 Documentation/trace/coresight/coresight.rst   |   2 +-
 .../translations/ja_JP/SubmittingPatches      | 722 ------------------
 .../zh_CN/doc-guide/kernel-doc.rst            |   2 -
 MAINTAINERS                                   |   4 +-
 drivers/gpu/drm/scheduler/sched_main.c        |   1 +
 include/drm/gpu_scheduler.h                   |   1 +
 include/linux/dcache.h                        |  10 +-
 include/linux/fscache.h                       |   4 +-
 include/linux/serial_core.h                   |   8 +
 mm/hugetlb_vmemmap.h                          |   2 +-
 scripts/kernel-doc                            |   8 +-
 14 files changed, 33 insertions(+), 736 deletions(-)
 delete mode 100644 Documentation/translations/ja_JP/SubmittingPatches

-- 
2.37.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>, corbet@lwn.net
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>,
	linux-kernel@vger.kernel.org,
	"Peter Zijlstra (Intel)" <peterz@infradead.org>,
	Akira Yokosawa <akiyks@gmail.com>, Alex Shi <alexs@kernel.org>,
	Andrew Morton <akpm@linux-foundation.org>,
	Andrey Grodzovsky <andrey.grodzovsky@amd.com>,
	Bagas Sanjaya <bagasdotme@gmail.com>,
	Dan Williams <dan.j.williams@intel.com>,
	Daniel Vetter <daniel@ffwll.ch>, David Airlie <airlied@linux.ie>,
	David Howells <dhowells@redhat.com>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Ilya Dryomov <idryomov@gmail.com>, Jiri Kosina <jkosina@suse.cz>,
	Jiri Slaby <jirislaby@kernel.org>,
	Kajol Jain <kjain@linux.ibm.com>,
	Kosuke Fujimoto <fujimotokosuke0@gmail.com>,
	Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>,
	Leo Yan <leo.yan@linaro.org>,
	Luis Chamberlain <mcgrof@kernel.org>,
	Lukas Bulwahn <lukas.bulwahn@gmail.com>,
	Madhavan Srinivasan <maddy@in.ibm.com>,
	Mathieu Poirier <mathieu.poirier@linaro.org>,
	Mike Kravetz <mike.kravetz@oracle.com>,
	Mike Leach <mike.leach@linaro.org>,
	Mike Rapoport <rppt@kernel.org>,
	Muchun Song <songmuchun@bytedance.com>,
	Rob Herring <robh@kernel.org>,
	Sebastian Andrzej Siewior <bigeasy@linutronix.de>,
	Suzuki K Poulose <suzuki.poulose@arm.com>,
	Tsugikazu Shibata <shibata@linuxfoundation.org>,
	Wu XiangCheng <bobwxc@email.cn>, Xiubo Li <xiubli@redhat.com>,
	Yanteng Si <siyanteng@loongson.cn>,
	coresight@lists.linaro.org, dri-devel@lists.freedesktop.org,
	linux-arm-kernel@lists.infradead.org, linux-cachefs@redhat.com,
	linux-mm@kvack.org
Subject: [PATCH 00/13] Fix documentation build warnings against 6.0-rc1
Date: Thu, 18 Aug 2022 15:38:46 +0200	[thread overview]
Message-ID: <cover.1660829433.git.mchehab@kernel.org> (raw)

Hi Jon,

This series is against 6.0-rc1, so it should apply fine on the top of your tree.

After applying one fix sent to ACPI:

https://lore.kernel.org/linux-acpi/20220818055156.7456-1-sakari.ailus@linux.intel.com/T/#u

make htmldocs (with Sphinx 2.4.4) produces a very clean result:
:

	Warning: Documentation/devicetree/bindings/regulator/siliconmitus,sm5703
-regulator.yaml references a file that doesn't exist: Documentation/devicetree/b
indings/mfd/siliconmitus,sm5703.yaml
	  SPHINX  htmldocs --> file:///new_devel/v4l/docs/Documentation/output
	  PARSE   include/uapi/linux/dvb/ca.h
	  PARSE   include/uapi/linux/dvb/dmx.h
	  PARSE   include/uapi/linux/dvb/frontend.h
	  PARSE   include/uapi/linux/dvb/net.h
	  PARSE   include/uapi/linux/videodev2.h
	  PARSE   include/uapi/linux/media.h
	  PARSE   include/uapi/linux/cec.h
	  PARSE   include/uapi/linux/lirc.h
	Using sphinx_rtd_theme theme

The only warning is due to a driver that got its upstream way for MFD, but it seems that
the corresponding regulator driver has lost its way.

If we can fix such warning, we could add a sort of "Werror" for:

	- some ABI issues;
	- kernel-doc warnings/errors;
	- broken kernel-doc warnings.

Although there will still have Sphinx warnings that can come up from various sources,
this could help to keep documentation on a better shape, as time goes by.

Regards,
Mauro


Mauro Carvalho Chehab (13):
  scripts: kernel-doc: add support for EXPORT_SYMBOL variants
  docs: update vmemmap_dedup.rst reference
  docs: ja_JP: remove SubmittingPatches
  docs: zh_CN: remove references to rust documentation
  dt-bindings: arm: update arm,coresight-cpu-debug.yaml reference
  Documentation: coresight: fix a documentation build warning
  MAINTAINERS: fix wildcard for mfd da90* files
  MAINTAINERS: fix a typo for hpe,gxp-spifi.yaml
  ABI: sysfs-bus-nvdimm: fix a doc build warning
  docs: leds: add leds-qcom-lpg.rst to the index file
  fscache: fix kernel-doc markup on two functions
  serial: document start_rx member at struct uart_ops
  fs/dcache: fix a kernel-doc markup

 Documentation/ABI/testing/sysfs-bus-nvdimm    |   2 +
 Documentation/leds/index.rst                  |   1 +
 .../trace/coresight/coresight-cpu-debug.rst   |   2 +-
 Documentation/trace/coresight/coresight.rst   |   2 +-
 .../translations/ja_JP/SubmittingPatches      | 722 ------------------
 .../zh_CN/doc-guide/kernel-doc.rst            |   2 -
 MAINTAINERS                                   |   4 +-
 drivers/gpu/drm/scheduler/sched_main.c        |   1 +
 include/drm/gpu_scheduler.h                   |   1 +
 include/linux/dcache.h                        |  10 +-
 include/linux/fscache.h                       |   4 +-
 include/linux/serial_core.h                   |   8 +
 mm/hugetlb_vmemmap.h                          |   2 +-
 scripts/kernel-doc                            |   8 +-
 14 files changed, 33 insertions(+), 736 deletions(-)
 delete mode 100644 Documentation/translations/ja_JP/SubmittingPatches

-- 
2.37.1



_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

             reply	other threads:[~2022-08-18 13:39 UTC|newest]

Thread overview: 33+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-08-18 13:38 Mauro Carvalho Chehab [this message]
2022-08-18 13:38 ` [PATCH 00/13] Fix documentation build warnings against 6.0-rc1 Mauro Carvalho Chehab
2022-08-18 13:38 ` Mauro Carvalho Chehab
2022-08-18 13:38 ` [PATCH 01/13] scripts: kernel-doc: add support for EXPORT_SYMBOL variants Mauro Carvalho Chehab
2022-08-18 13:38 ` [PATCH 02/13] docs: update vmemmap_dedup.rst reference Mauro Carvalho Chehab
2022-08-18 14:58   ` Wu XiangCheng
2022-08-19  2:49   ` Muchun Song
2022-08-18 13:38 ` [PATCH 03/13] docs: ja_JP: remove SubmittingPatches Mauro Carvalho Chehab
2022-08-18 14:27   ` Akira Yokosawa
2022-08-18 14:49     ` Akira Yokosawa
2022-08-18 13:38 ` [PATCH 04/13] docs: zh_CN: remove references to rust documentation Mauro Carvalho Chehab
2022-08-20  2:20   ` YanTeng Si
2022-08-18 13:38 ` [PATCH 05/13] dt-bindings: arm: update arm,coresight-cpu-debug.yaml reference Mauro Carvalho Chehab
2022-08-18 13:38   ` Mauro Carvalho Chehab
2022-09-12  8:39   ` Suzuki K Poulose
2022-09-12  8:39     ` Suzuki K Poulose
2022-08-18 13:38 ` [PATCH 06/13] Documentation: coresight: fix a documentation build warning Mauro Carvalho Chehab
2022-08-18 13:38   ` Mauro Carvalho Chehab
2022-08-19  3:35   ` Bagas Sanjaya
2022-08-19  3:35     ` Bagas Sanjaya
2022-09-12  9:39   ` Suzuki K Poulose
2022-09-12  9:39     ` Suzuki K Poulose
2022-08-18 13:38 ` [PATCH 07/13] MAINTAINERS: fix wildcard for mfd da90* files Mauro Carvalho Chehab
2022-08-18 13:38 ` [PATCH 08/13] MAINTAINERS: fix a typo for hpe,gxp-spifi.yaml Mauro Carvalho Chehab
2022-08-18 13:38 ` [PATCH 09/13] ABI: sysfs-bus-nvdimm: fix a doc build warning Mauro Carvalho Chehab
2022-08-18 13:38 ` [PATCH 10/13] docs: leds: add leds-qcom-lpg.rst to the index file Mauro Carvalho Chehab
2022-08-18 13:38   ` Mauro Carvalho Chehab
2022-08-19  3:49   ` Bagas Sanjaya
2022-08-19  3:49     ` Bagas Sanjaya
2022-08-18 13:38 ` [PATCH 11/13] fscache: fix kernel-doc markup on two functions Mauro Carvalho Chehab
2022-08-18 13:38 ` [PATCH 12/13] serial: document start_rx member at struct uart_ops Mauro Carvalho Chehab
2022-08-19  5:20   ` Jiri Slaby
2022-08-18 13:38 ` [PATCH 13/13] fs/dcache: fix a kernel-doc markup 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.1660829433.git.mchehab@kernel.org \
    --to=mchehab@kernel.org \
    --cc=airlied@linux.ie \
    --cc=akiyks@gmail.com \
    --cc=akpm@linux-foundation.org \
    --cc=alexs@kernel.org \
    --cc=andrey.grodzovsky@amd.com \
    --cc=bagasdotme@gmail.com \
    --cc=bigeasy@linutronix.de \
    --cc=bobwxc@email.cn \
    --cc=corbet@lwn.net \
    --cc=coresight@lists.linaro.org \
    --cc=dan.j.williams@intel.com \
    --cc=daniel@ffwll.ch \
    --cc=dhowells@redhat.com \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=fujimotokosuke0@gmail.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=idryomov@gmail.com \
    --cc=jirislaby@kernel.org \
    --cc=jkosina@suse.cz \
    --cc=kjain@linux.ibm.com \
    --cc=krzysztof.kozlowski@linaro.org \
    --cc=leo.yan@linaro.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-cachefs@redhat.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mm@kvack.org \
    --cc=lukas.bulwahn@gmail.com \
    --cc=maddy@in.ibm.com \
    --cc=mathieu.poirier@linaro.org \
    --cc=mcgrof@kernel.org \
    --cc=mike.kravetz@oracle.com \
    --cc=mike.leach@linaro.org \
    --cc=peterz@infradead.org \
    --cc=robh@kernel.org \
    --cc=rppt@kernel.org \
    --cc=shibata@linuxfoundation.org \
    --cc=siyanteng@loongson.cn \
    --cc=songmuchun@bytedance.com \
    --cc=suzuki.poulose@arm.com \
    --cc=xiubli@redhat.com \
    /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.