[PATCH 0/7] Fix broken references to files under Documentation/*

[PATCH 0/7] Fix broken references to files under Documentation/*

[Mauro Carvalho Chehab]

Solves most of the pending broken references upstream, except for two of
them:

	$ ./scripts/documentation-file-ref-check 
	Documentation/riscv/boot-image-header.txt: Documentation/riscv/booting.txt
	MAINTAINERS: Documentation/devicetree/bindings/rng/samsung,exynos5250-trng.txt

As written at boot-image-header.txt, it is waiting for the addition of
a future file: 

	"The complete booting guide will be available at
	  Documentation/riscv/booting.txt."

The second is due to this patch, pending to be merged:
	https://lore.kernel.org/patchwork/patch/994210/

I'm not a DT expert, but I can't see any issue with this patch, except
for a missing acked-by a DT maintainer, and a possible conversion to
yaml. IMO, the best fix for this would be to merge the DT patch.

Patch 1 was already submitted before, together with the v1 of
my PDF fix series.

Mauro Carvalho Chehab (7):
  docs: fix broken doc references due to renames
  docs: generic-counter.rst: fix broken references for ABI file
  MAINTAINERS: fix reference to net phy ABI file
  MAINTAINERS: fix a renamed DT reference
  docs: cgroup-v1/blkio-controller.rst: remove a CFQ left over
  docs: zh_CN: howto.rst: fix a broken reference
  docs: dt: fix a sound binding broken reference

 Documentation/RCU/rculist_nulls.txt                |  2 +-
 .../admin-guide/cgroup-v1/blkio-controller.rst     |  6 ------
 .../devicetree/bindings/arm/idle-states.txt        |  2 +-
 .../devicetree/bindings/sound/sun8i-a33-codec.txt  |  2 +-
 Documentation/driver-api/generic-counter.rst       |  4 ++--
 Documentation/locking/spinlocks.rst                |  4 ++--
 Documentation/memory-barriers.txt                  |  2 +-
 .../translations/ko_KR/memory-barriers.txt         |  2 +-
 Documentation/translations/zh_CN/process/howto.rst |  2 +-
 Documentation/watchdog/hpwdt.rst                   |  2 +-
 MAINTAINERS                                        | 14 +++++++-------
 drivers/gpu/drm/drm_modes.c                        |  2 +-
 drivers/i2c/busses/i2c-nvidia-gpu.c                |  2 +-
 drivers/scsi/hpsa.c                                |  4 ++--
 14 files changed, 22 insertions(+), 28 deletions(-)

-- 
2.21.0

[PATCH 1/7] docs: fix broken doc references due to renames

[Mauro Carvalho Chehab]

Some files got renamed but probably due to some merge conflicts,
a few references still point to the old locations.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Acked-by: Wolfram Sang <wsa@the-dreams.de> # I2C part
Reviewed-by: Jerry Hoemann <jerry.hoemann@hpe.com> # hpwdt.rst
---
 Documentation/RCU/rculist_nulls.txt                   |  2 +-
 Documentation/devicetree/bindings/arm/idle-states.txt |  2 +-
 Documentation/locking/spinlocks.rst                   |  4 ++--
 Documentation/memory-barriers.txt                     |  2 +-
 Documentation/translations/ko_KR/memory-barriers.txt  |  2 +-
 Documentation/watchdog/hpwdt.rst                      |  2 +-
 MAINTAINERS                                           | 10 +++++-----
 drivers/gpu/drm/drm_modes.c                           |  2 +-
 drivers/i2c/busses/i2c-nvidia-gpu.c                   |  2 +-
 drivers/scsi/hpsa.c                                   |  4 ++--
 10 files changed, 16 insertions(+), 16 deletions(-)

diff --git a/Documentation/RCU/rculist_nulls.txt b/Documentation/RCU/rculist_nulls.txt
index 8151f0195f76..23f115dc87cf 100644
--- a/Documentation/RCU/rculist_nulls.txt
+++ b/Documentation/RCU/rculist_nulls.txt
@@ -1,7 +1,7 @@
 Using hlist_nulls to protect read-mostly linked lists and
 objects using SLAB_TYPESAFE_BY_RCU allocations.
 
-Please read the basics in Documentation/RCU/listRCU.txt
+Please read the basics in Documentation/RCU/listRCU.rst
 
 Using special makers (called 'nulls') is a convenient way
 to solve following problem :
diff --git a/Documentation/devicetree/bindings/arm/idle-states.txt b/Documentation/devicetree/bindings/arm/idle-states.txt
index 326f29b270ad..2d325bed37e5 100644
--- a/Documentation/devicetree/bindings/arm/idle-states.txt
+++ b/Documentation/devicetree/bindings/arm/idle-states.txt
@@ -703,4 +703,4 @@ cpus {
     https://www.devicetree.org/specifications/
 
 [6] ARM Linux Kernel documentation - Booting AArch64 Linux
-    Documentation/arm64/booting.txt
+    Documentation/arm64/booting.rst
diff --git a/Documentation/locking/spinlocks.rst b/Documentation/locking/spinlocks.rst
index 098107fb7d86..e93ec6645238 100644
--- a/Documentation/locking/spinlocks.rst
+++ b/Documentation/locking/spinlocks.rst
@@ -82,7 +82,7 @@ itself.  The read lock allows many concurrent readers.  Anything that
 **changes** the list will have to get the write lock.
 
    NOTE! RCU is better for list traversal, but requires careful
-   attention to design detail (see Documentation/RCU/listRCU.txt).
+   attention to design detail (see Documentation/RCU/listRCU.rst).
 
 Also, you cannot "upgrade" a read-lock to a write-lock, so if you at _any_
 time need to do any changes (even if you don't do it every time), you have
@@ -90,7 +90,7 @@ to get the write-lock at the very beginning.
 
    NOTE! We are working hard to remove reader-writer spinlocks in most
    cases, so please don't add a new one without consensus.  (Instead, see
-   Documentation/RCU/rcu.txt for complete information.)
+   Documentation/RCU/rcu.rst for complete information.)
 
 ----
 
diff --git a/Documentation/memory-barriers.txt b/Documentation/memory-barriers.txt
index 045bb8148fe9..1adbb8a371c7 100644
--- a/Documentation/memory-barriers.txt
+++ b/Documentation/memory-barriers.txt
@@ -548,7 +548,7 @@ There are certain things that the Linux kernel memory barriers do not guarantee:
 
 	[*] For information on bus mastering DMA and coherency please read:
 
-	    Documentation/PCI/pci.rst
+	    Documentation/driver-api/pci/pci.rst
 	    Documentation/DMA-API-HOWTO.txt
 	    Documentation/DMA-API.txt
 
diff --git a/Documentation/translations/ko_KR/memory-barriers.txt b/Documentation/translations/ko_KR/memory-barriers.txt
index a33c2a536542..2774624ee843 100644
--- a/Documentation/translations/ko_KR/memory-barriers.txt
+++ b/Documentation/translations/ko_KR/memory-barriers.txt
@@ -569,7 +569,7 @@ ACQUIRE 는 해당 오퍼레이션의 로드 부분에만 적용되고 RELEASE 
 
 	[*] 버스 마스터링 DMA 와 일관성에 대해서는 다음을 참고하시기 바랍니다:
 
-	    Documentation/PCI/pci.rst
+	    Documentation/driver-api/pci/pci.rst
 	    Documentation/DMA-API-HOWTO.txt
 	    Documentation/DMA-API.txt
 
diff --git a/Documentation/watchdog/hpwdt.rst b/Documentation/watchdog/hpwdt.rst
index c165d92cfd12..c824cd7f6e32 100644
--- a/Documentation/watchdog/hpwdt.rst
+++ b/Documentation/watchdog/hpwdt.rst
@@ -63,7 +63,7 @@ Last reviewed: 08/20/2018
  and loop forever.  This is generally not what a watchdog user wants.
 
  For those wishing to learn more please see:
-	Documentation/kdump/kdump.rst
+	Documentation/admin-guide/kdump/kdump.rst
 	Documentation/admin-guide/kernel-parameters.txt (panic=)
 	Your Linux Distribution specific documentation.
 
diff --git a/MAINTAINERS b/MAINTAINERS
index 4e2a525e22c0..51bdbd230174 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -899,7 +899,7 @@ L:	linux-iio@vger.kernel.org
 W:	http://ez.analog.com/community/linux-device-drivers
 S:	Supported
 F:	drivers/iio/adc/ad7124.c
-F:	Documentation/devicetree/bindings/iio/adc/adi,ad7124.txt
+F:	Documentation/devicetree/bindings/iio/adc/adi,ad7124.yaml
 
 ANALOG DEVICES INC AD7606 DRIVER
 M:	Stefan Popa <stefan.popa@analog.com>
@@ -4190,7 +4190,7 @@ M:	Jens Axboe <axboe@kernel.dk>
 L:	cgroups@vger.kernel.org
 L:	linux-block@vger.kernel.org
 T:	git git://git.kernel.dk/linux-block
-F:	Documentation/cgroup-v1/blkio-controller.rst
+F:	Documentation/admin-guide/cgroup-v1/blkio-controller.rst
 F:	block/blk-cgroup.c
 F:	include/linux/blk-cgroup.h
 F:	block/blk-throttle.c
@@ -6317,7 +6317,7 @@ FLEXTIMER FTM-QUADDEC DRIVER
 M:	Patrick Havelange <patrick.havelange@essensium.com>
 L:	linux-iio@vger.kernel.org
 S:	Maintained
-F:	Documentation/ABI/testing/sysfs-bus-counter-ftm-quadddec
+F:	Documentation/ABI/testing/sysfs-bus-counter-ftm-quaddec
 F:	Documentation/devicetree/bindings/counter/ftm-quaddec.txt
 F:	drivers/counter/ftm-quaddec.c
 
@@ -6856,7 +6856,7 @@ R:	Sagi Shahar <sagis@google.com>
 R:	Jon Olson <jonolson@google.com>
 L:	netdev@vger.kernel.org
 S:	Supported
-F:	Documentation/networking/device_drivers/google/gve.txt
+F:	Documentation/networking/device_drivers/google/gve.rst
 F:	drivers/net/ethernet/google
 
 GPD POCKET FAN DRIVER
@@ -12137,7 +12137,7 @@ M:	Thomas Hellstrom <thellstrom@vmware.com>
 M:	"VMware, Inc." <pv-drivers@vmware.com>
 L:	virtualization@lists.linux-foundation.org
 S:	Supported
-F:	Documentation/virt/paravirt_ops.txt
+F:	Documentation/virt/paravirt_ops.rst
 F:	arch/*/kernel/paravirt*
 F:	arch/*/include/asm/paravirt*.h
 F:	include/linux/hypervisor.h
diff --git a/drivers/gpu/drm/drm_modes.c b/drivers/gpu/drm/drm_modes.c
index 74a5739df506..80fcd5dc1558 100644
--- a/drivers/gpu/drm/drm_modes.c
+++ b/drivers/gpu/drm/drm_modes.c
@@ -1686,7 +1686,7 @@ static int drm_mode_parse_cmdline_options(char *str, size_t len,
  *
  * Additionals options can be provided following the mode, using a comma to
  * separate each option. Valid options can be found in
- * Documentation/fb/modedb.txt.
+ * Documentation/fb/modedb.rst.
  *
  * The intermediate drm_cmdline_mode structure is required to store additional
  * options from the command line modline like the force-enable/disable flag.
diff --git a/drivers/i2c/busses/i2c-nvidia-gpu.c b/drivers/i2c/busses/i2c-nvidia-gpu.c
index cfc76b5de726..5a1235fd86bb 100644
--- a/drivers/i2c/busses/i2c-nvidia-gpu.c
+++ b/drivers/i2c/busses/i2c-nvidia-gpu.c
@@ -364,7 +364,7 @@ static void gpu_i2c_remove(struct pci_dev *pdev)
 /*
  * We need gpu_i2c_suspend() even if it is stub, for runtime pm to work
  * correctly. Without it, lspci shows runtime pm status as "D0" for the card.
- * Documentation/power/pci.txt also insists for driver to provide this.
+ * Documentation/power/pci.rst also insists for driver to provide this.
  */
 static __maybe_unused int gpu_i2c_suspend(struct device *dev)
 {
diff --git a/drivers/scsi/hpsa.c b/drivers/scsi/hpsa.c
index 43a6b5350775..eaf6177ac9ee 100644
--- a/drivers/scsi/hpsa.c
+++ b/drivers/scsi/hpsa.c
@@ -7798,7 +7798,7 @@ static void hpsa_free_pci_init(struct ctlr_info *h)
 	hpsa_disable_interrupt_mode(h);		/* pci_init 2 */
 	/*
 	 * call pci_disable_device before pci_release_regions per
-	 * Documentation/PCI/pci.rst
+	 * Documentation/driver-api/pci/pci.rst
 	 */
 	pci_disable_device(h->pdev);		/* pci_init 1 */
 	pci_release_regions(h->pdev);		/* pci_init 2 */
@@ -7881,7 +7881,7 @@ static int hpsa_pci_init(struct ctlr_info *h)
 clean1:
 	/*
 	 * call pci_disable_device before pci_release_regions per
-	 * Documentation/PCI/pci.rst
+	 * Documentation/driver-api/pci/pci.rst
 	 */
 	pci_disable_device(h->pdev);
 	pci_release_regions(h->pdev);
-- 
2.21.0

Re: [PATCH 1/7] docs: fix broken doc references due to renames

[Rob Herring]

On Fri, Jul 26, 2019 at 5:47 AM Mauro Carvalho Chehab
<mchehab+samsung@kernel.org> wrote:
>
> Some files got renamed but probably due to some merge conflicts,
> a few references still point to the old locations.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> Acked-by: Wolfram Sang <wsa@the-dreams.de> # I2C part
> Reviewed-by: Jerry Hoemann <jerry.hoemann@hpe.com> # hpwdt.rst
> ---
>  Documentation/RCU/rculist_nulls.txt                   |  2 +-
>  Documentation/devicetree/bindings/arm/idle-states.txt |  2 +-
>  Documentation/locking/spinlocks.rst                   |  4 ++--
>  Documentation/memory-barriers.txt                     |  2 +-
>  Documentation/translations/ko_KR/memory-barriers.txt  |  2 +-
>  Documentation/watchdog/hpwdt.rst                      |  2 +-
>  MAINTAINERS                                           | 10 +++++-----
>  drivers/gpu/drm/drm_modes.c                           |  2 +-
>  drivers/i2c/busses/i2c-nvidia-gpu.c                   |  2 +-
>  drivers/scsi/hpsa.c                                   |  4 ++--
>  10 files changed, 16 insertions(+), 16 deletions(-)

Acked-by: Rob Herring <robh@kernel.org>

Re: [PATCH 1/7] docs: fix broken doc references due to renames

[Daniel Vetter]

On Fri, Jul 26, 2019 at 07:41:35AM -0600, Rob Herring wrote:
> On Fri, Jul 26, 2019 at 5:47 AM Mauro Carvalho Chehab
> <mchehab+samsung@kernel.org> wrote:
> >
> > Some files got renamed but probably due to some merge conflicts,
> > a few references still point to the old locations.
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> > Acked-by: Wolfram Sang <wsa@the-dreams.de> # I2C part
> > Reviewed-by: Jerry Hoemann <jerry.hoemann@hpe.com> # hpwdt.rst
> > ---
> >  Documentation/RCU/rculist_nulls.txt                   |  2 +-
> >  Documentation/devicetree/bindings/arm/idle-states.txt |  2 +-
> >  Documentation/locking/spinlocks.rst                   |  4 ++--
> >  Documentation/memory-barriers.txt                     |  2 +-
> >  Documentation/translations/ko_KR/memory-barriers.txt  |  2 +-
> >  Documentation/watchdog/hpwdt.rst                      |  2 +-
> >  MAINTAINERS                                           | 10 +++++-----
> >  drivers/gpu/drm/drm_modes.c                           |  2 +-

for the drm part:

Acked-by: Daniel Vetter <daniel.vetter@ffwll.ch>

> >  drivers/i2c/busses/i2c-nvidia-gpu.c                   |  2 +-
> >  drivers/scsi/hpsa.c                                   |  4 ++--
> >  10 files changed, 16 insertions(+), 16 deletions(-)
> 
> Acked-by: Rob Herring <robh@kernel.org>

-- 
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch

Re: [PATCH 1/7] docs: fix broken doc references due to renames

[Paul E. McKenney]

On Fri, Jul 26, 2019 at 08:47:21AM -0300, Mauro Carvalho Chehab wrote:
> Some files got renamed but probably due to some merge conflicts,
> a few references still point to the old locations.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> Acked-by: Wolfram Sang <wsa@the-dreams.de> # I2C part
> Reviewed-by: Jerry Hoemann <jerry.hoemann@hpe.com> # hpwdt.rst

Acked-by: Paul E. McKenney <paulmck@linux.ibm.com>

> ---
>  Documentation/RCU/rculist_nulls.txt                   |  2 +-
>  Documentation/devicetree/bindings/arm/idle-states.txt |  2 +-
>  Documentation/locking/spinlocks.rst                   |  4 ++--
>  Documentation/memory-barriers.txt                     |  2 +-
>  Documentation/translations/ko_KR/memory-barriers.txt  |  2 +-
>  Documentation/watchdog/hpwdt.rst                      |  2 +-
>  MAINTAINERS                                           | 10 +++++-----
>  drivers/gpu/drm/drm_modes.c                           |  2 +-
>  drivers/i2c/busses/i2c-nvidia-gpu.c                   |  2 +-
>  drivers/scsi/hpsa.c                                   |  4 ++--
>  10 files changed, 16 insertions(+), 16 deletions(-)
> 
> diff --git a/Documentation/RCU/rculist_nulls.txt b/Documentation/RCU/rculist_nulls.txt
> index 8151f0195f76..23f115dc87cf 100644
> --- a/Documentation/RCU/rculist_nulls.txt
> +++ b/Documentation/RCU/rculist_nulls.txt
> @@ -1,7 +1,7 @@
>  Using hlist_nulls to protect read-mostly linked lists and
>  objects using SLAB_TYPESAFE_BY_RCU allocations.
>  
> -Please read the basics in Documentation/RCU/listRCU.txt
> +Please read the basics in Documentation/RCU/listRCU.rst
>  
>  Using special makers (called 'nulls') is a convenient way
>  to solve following problem :
> diff --git a/Documentation/devicetree/bindings/arm/idle-states.txt b/Documentation/devicetree/bindings/arm/idle-states.txt
> index 326f29b270ad..2d325bed37e5 100644
> --- a/Documentation/devicetree/bindings/arm/idle-states.txt
> +++ b/Documentation/devicetree/bindings/arm/idle-states.txt
> @@ -703,4 +703,4 @@ cpus {
>      https://www.devicetree.org/specifications/
>  
>  [6] ARM Linux Kernel documentation - Booting AArch64 Linux
> -    Documentation/arm64/booting.txt
> +    Documentation/arm64/booting.rst
> diff --git a/Documentation/locking/spinlocks.rst b/Documentation/locking/spinlocks.rst
> index 098107fb7d86..e93ec6645238 100644
> --- a/Documentation/locking/spinlocks.rst
> +++ b/Documentation/locking/spinlocks.rst
> @@ -82,7 +82,7 @@ itself.  The read lock allows many concurrent readers.  Anything that
>  **changes** the list will have to get the write lock.
>  
>     NOTE! RCU is better for list traversal, but requires careful
> -   attention to design detail (see Documentation/RCU/listRCU.txt).
> +   attention to design detail (see Documentation/RCU/listRCU.rst).
>  
>  Also, you cannot "upgrade" a read-lock to a write-lock, so if you at _any_
>  time need to do any changes (even if you don't do it every time), you have
> @@ -90,7 +90,7 @@ to get the write-lock at the very beginning.
>  
>     NOTE! We are working hard to remove reader-writer spinlocks in most
>     cases, so please don't add a new one without consensus.  (Instead, see
> -   Documentation/RCU/rcu.txt for complete information.)
> +   Documentation/RCU/rcu.rst for complete information.)
>  
>  ----
>  
> diff --git a/Documentation/memory-barriers.txt b/Documentation/memory-barriers.txt
> index 045bb8148fe9..1adbb8a371c7 100644
> --- a/Documentation/memory-barriers.txt
> +++ b/Documentation/memory-barriers.txt
> @@ -548,7 +548,7 @@ There are certain things that the Linux kernel memory barriers do not guarantee:
>  
>  	[*] For information on bus mastering DMA and coherency please read:
>  
> -	    Documentation/PCI/pci.rst
> +	    Documentation/driver-api/pci/pci.rst
>  	    Documentation/DMA-API-HOWTO.txt
>  	    Documentation/DMA-API.txt
>  
> diff --git a/Documentation/translations/ko_KR/memory-barriers.txt b/Documentation/translations/ko_KR/memory-barriers.txt
> index a33c2a536542..2774624ee843 100644
> --- a/Documentation/translations/ko_KR/memory-barriers.txt
> +++ b/Documentation/translations/ko_KR/memory-barriers.txt
> @@ -569,7 +569,7 @@ ACQUIRE 는 해당 오퍼레이션의 로드 부분에만 적용되고 RELEASE 
>  
>  	[*] 버스 마스터링 DMA 와 일관성에 대해서는 다음을 참고하시기 바랍니다:
>  
> -	    Documentation/PCI/pci.rst
> +	    Documentation/driver-api/pci/pci.rst
>  	    Documentation/DMA-API-HOWTO.txt
>  	    Documentation/DMA-API.txt
>  
> diff --git a/Documentation/watchdog/hpwdt.rst b/Documentation/watchdog/hpwdt.rst
> index c165d92cfd12..c824cd7f6e32 100644
> --- a/Documentation/watchdog/hpwdt.rst
> +++ b/Documentation/watchdog/hpwdt.rst
> @@ -63,7 +63,7 @@ Last reviewed: 08/20/2018
>   and loop forever.  This is generally not what a watchdog user wants.
>  
>   For those wishing to learn more please see:
> -	Documentation/kdump/kdump.rst
> +	Documentation/admin-guide/kdump/kdump.rst
>  	Documentation/admin-guide/kernel-parameters.txt (panic=)
>  	Your Linux Distribution specific documentation.
>  
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 4e2a525e22c0..51bdbd230174 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -899,7 +899,7 @@ L:	linux-iio@vger.kernel.org
>  W:	http://ez.analog.com/community/linux-device-drivers
>  S:	Supported
>  F:	drivers/iio/adc/ad7124.c
> -F:	Documentation/devicetree/bindings/iio/adc/adi,ad7124.txt
> +F:	Documentation/devicetree/bindings/iio/adc/adi,ad7124.yaml
>  
>  ANALOG DEVICES INC AD7606 DRIVER
>  M:	Stefan Popa <stefan.popa@analog.com>
> @@ -4190,7 +4190,7 @@ M:	Jens Axboe <axboe@kernel.dk>
>  L:	cgroups@vger.kernel.org
>  L:	linux-block@vger.kernel.org
>  T:	git git://git.kernel.dk/linux-block
> -F:	Documentation/cgroup-v1/blkio-controller.rst
> +F:	Documentation/admin-guide/cgroup-v1/blkio-controller.rst
>  F:	block/blk-cgroup.c
>  F:	include/linux/blk-cgroup.h
>  F:	block/blk-throttle.c
> @@ -6317,7 +6317,7 @@ FLEXTIMER FTM-QUADDEC DRIVER
>  M:	Patrick Havelange <patrick.havelange@essensium.com>
>  L:	linux-iio@vger.kernel.org
>  S:	Maintained
> -F:	Documentation/ABI/testing/sysfs-bus-counter-ftm-quadddec
> +F:	Documentation/ABI/testing/sysfs-bus-counter-ftm-quaddec
>  F:	Documentation/devicetree/bindings/counter/ftm-quaddec.txt
>  F:	drivers/counter/ftm-quaddec.c
>  
> @@ -6856,7 +6856,7 @@ R:	Sagi Shahar <sagis@google.com>
>  R:	Jon Olson <jonolson@google.com>
>  L:	netdev@vger.kernel.org
>  S:	Supported
> -F:	Documentation/networking/device_drivers/google/gve.txt
> +F:	Documentation/networking/device_drivers/google/gve.rst
>  F:	drivers/net/ethernet/google
>  
>  GPD POCKET FAN DRIVER
> @@ -12137,7 +12137,7 @@ M:	Thomas Hellstrom <thellstrom@vmware.com>
>  M:	"VMware, Inc." <pv-drivers@vmware.com>
>  L:	virtualization@lists.linux-foundation.org
>  S:	Supported
> -F:	Documentation/virt/paravirt_ops.txt
> +F:	Documentation/virt/paravirt_ops.rst
>  F:	arch/*/kernel/paravirt*
>  F:	arch/*/include/asm/paravirt*.h
>  F:	include/linux/hypervisor.h
> diff --git a/drivers/gpu/drm/drm_modes.c b/drivers/gpu/drm/drm_modes.c
> index 74a5739df506..80fcd5dc1558 100644
> --- a/drivers/gpu/drm/drm_modes.c
> +++ b/drivers/gpu/drm/drm_modes.c
> @@ -1686,7 +1686,7 @@ static int drm_mode_parse_cmdline_options(char *str, size_t len,
>   *
>   * Additionals options can be provided following the mode, using a comma to
>   * separate each option. Valid options can be found in
> - * Documentation/fb/modedb.txt.
> + * Documentation/fb/modedb.rst.
>   *
>   * The intermediate drm_cmdline_mode structure is required to store additional
>   * options from the command line modline like the force-enable/disable flag.
> diff --git a/drivers/i2c/busses/i2c-nvidia-gpu.c b/drivers/i2c/busses/i2c-nvidia-gpu.c
> index cfc76b5de726..5a1235fd86bb 100644
> --- a/drivers/i2c/busses/i2c-nvidia-gpu.c
> +++ b/drivers/i2c/busses/i2c-nvidia-gpu.c
> @@ -364,7 +364,7 @@ static void gpu_i2c_remove(struct pci_dev *pdev)
>  /*
>   * We need gpu_i2c_suspend() even if it is stub, for runtime pm to work
>   * correctly. Without it, lspci shows runtime pm status as "D0" for the card.
> - * Documentation/power/pci.txt also insists for driver to provide this.
> + * Documentation/power/pci.rst also insists for driver to provide this.
>   */
>  static __maybe_unused int gpu_i2c_suspend(struct device *dev)
>  {
> diff --git a/drivers/scsi/hpsa.c b/drivers/scsi/hpsa.c
> index 43a6b5350775..eaf6177ac9ee 100644
> --- a/drivers/scsi/hpsa.c
> +++ b/drivers/scsi/hpsa.c
> @@ -7798,7 +7798,7 @@ static void hpsa_free_pci_init(struct ctlr_info *h)
>  	hpsa_disable_interrupt_mode(h);		/* pci_init 2 */
>  	/*
>  	 * call pci_disable_device before pci_release_regions per
> -	 * Documentation/PCI/pci.rst
> +	 * Documentation/driver-api/pci/pci.rst
>  	 */
>  	pci_disable_device(h->pdev);		/* pci_init 1 */
>  	pci_release_regions(h->pdev);		/* pci_init 2 */
> @@ -7881,7 +7881,7 @@ static int hpsa_pci_init(struct ctlr_info *h)
>  clean1:
>  	/*
>  	 * call pci_disable_device before pci_release_regions per
> -	 * Documentation/PCI/pci.rst
> +	 * Documentation/driver-api/pci/pci.rst
>  	 */
>  	pci_disable_device(h->pdev);
>  	pci_release_regions(h->pdev);
> -- 
> 2.21.0
> 

[PATCH 2/7] docs: generic-counter.rst: fix broken references for ABI file

[Mauro Carvalho Chehab]

There are two references to the generic counter ABI, with was added
on a separate patch. Both point to a non-existing file.

Fix them.

Fixes: ea2b23b89579 ("counter: Documentation: Add Generic Counter sysfs documentation")
Fixes: 09e7d4ed8991 ("docs: Add Generic Counter interface documentation")
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/driver-api/generic-counter.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/driver-api/generic-counter.rst b/Documentation/driver-api/generic-counter.rst
index 0c161b1a3be6..8382f01a53e3 100644
--- a/Documentation/driver-api/generic-counter.rst
+++ b/Documentation/driver-api/generic-counter.rst
@@ -233,7 +233,7 @@ Userspace Interface
 Several sysfs attributes are generated by the Generic Counter interface,
 and reside under the /sys/bus/counter/devices/counterX directory, where
 counterX refers to the respective counter device. Please see
-Documentation/ABI/testing/sys-bus-counter-generic-sysfs for detailed
+Documentation/ABI/testing/sysfs-bus-counter for detailed
 information on each Generic Counter interface sysfs attribute.
 
 Through these sysfs attributes, programs and scripts may interact with
@@ -325,7 +325,7 @@ sysfs attributes, where Y is the unique ID of the respective Count:
 
 For a more detailed breakdown of the available Generic Counter interface
 sysfs attributes, please refer to the
-Documentation/ABI/testing/sys-bus-counter file.
+Documentation/ABI/testing/sysfs-bus-counter file.
 
 The Signals and Counts associated with the Counter device are registered
 to the system as well by the counter_register function. The
-- 
2.21.0

Re: [PATCH 2/7] docs: generic-counter.rst: fix broken references for ABI file

[Jonathan Cameron]

On Fri, 26 Jul 2019 08:47:22 -0300
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> wrote:

> There are two references to the generic counter ABI, with was added
> on a separate patch. Both point to a non-existing file.
> 
> Fix them.
> 
> Fixes: ea2b23b89579 ("counter: Documentation: Add Generic Counter sysfs documentation")
> Fixes: 09e7d4ed8991 ("docs: Add Generic Counter interface documentation")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>

Applied to the fixes-togreg branch of iio.git.

Thanks,

Jonathan

> ---
>  Documentation/driver-api/generic-counter.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/driver-api/generic-counter.rst b/Documentation/driver-api/generic-counter.rst
> index 0c161b1a3be6..8382f01a53e3 100644
> --- a/Documentation/driver-api/generic-counter.rst
> +++ b/Documentation/driver-api/generic-counter.rst
> @@ -233,7 +233,7 @@ Userspace Interface
>  Several sysfs attributes are generated by the Generic Counter interface,
>  and reside under the /sys/bus/counter/devices/counterX directory, where
>  counterX refers to the respective counter device. Please see
> -Documentation/ABI/testing/sys-bus-counter-generic-sysfs for detailed
> +Documentation/ABI/testing/sysfs-bus-counter for detailed
>  information on each Generic Counter interface sysfs attribute.
>  
>  Through these sysfs attributes, programs and scripts may interact with
> @@ -325,7 +325,7 @@ sysfs attributes, where Y is the unique ID of the respective Count:
>  
>  For a more detailed breakdown of the available Generic Counter interface
>  sysfs attributes, please refer to the
> -Documentation/ABI/testing/sys-bus-counter file.
> +Documentation/ABI/testing/sysfs-bus-counter file.
>  
>  The Signals and Counts associated with the Counter device are registered
>  to the system as well by the counter_register function. The

[PATCH 3/7] MAINTAINERS: fix reference to net phy ABI file

[Mauro Carvalho Chehab]

The file sysfs-bus-mdio got removed in favor of sysfs-class-net-phydev,
with contained a duplicated set of information.

Fixes: a6cd0d2d493a ("Documentation: net-sysfs: Remove duplicate PHY device documentation")
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 MAINTAINERS | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/MAINTAINERS b/MAINTAINERS
index 51bdbd230174..17ec9abcce52 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -6061,7 +6061,7 @@ M:	Florian Fainelli <f.fainelli@gmail.com>
 M:	Heiner Kallweit <hkallweit1@gmail.com>
 L:	netdev@vger.kernel.org
 S:	Maintained
-F:	Documentation/ABI/testing/sysfs-bus-mdio
+F:	Documentation/ABI/testing/sysfs-class-net-phydev
 F:	Documentation/devicetree/bindings/net/ethernet-phy.yaml
 F:	Documentation/devicetree/bindings/net/mdio*
 F:	Documentation/networking/phy.rst
-- 
2.21.0

[PATCH 4/7] MAINTAINERS: fix a renamed DT reference

[Mauro Carvalho Chehab]

Fix this rename:

	Documentation/devicetree/bindings/i2c/{i2c-mv64xxx.txt -> marvell,mv64xxx-i2c.yaml}

Fixes: f8bbde72ef44 ("dt-bindings: i2c: mv64xxx: Add YAML schemas")
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 MAINTAINERS | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/MAINTAINERS b/MAINTAINERS
index 17ec9abcce52..ea7ad0d08c96 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -7507,7 +7507,7 @@ I2C MV64XXX MARVELL AND ALLWINNER DRIVER
 M:	Gregory CLEMENT <gregory.clement@bootlin.com>
 L:	linux-i2c@vger.kernel.org
 S:	Maintained
-F:	Documentation/devicetree/bindings/i2c/i2c-mv64xxx.txt
+F:	Documentation/devicetree/bindings/i2c/marvell,mv64xxx-i2c.yaml
 F:	drivers/i2c/busses/i2c-mv64xxx.c
 
 I2C OVER PARALLEL PORT
-- 
2.21.0

[PATCH 5/7] docs: cgroup-v1/blkio-controller.rst: remove a CFQ left over

[Mauro Carvalho Chehab]

changeset fb5772cbfe48 ("blkio-controller.txt: Remove references to CFQ")
removed cgroup references to CFQ, but it kept one left. Get rid of
it.

Fixes: fb5772cbfe48 ("blkio-controller.txt: Remove references to CFQ")
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/admin-guide/cgroup-v1/blkio-controller.rst | 6 ------
 1 file changed, 6 deletions(-)

diff --git a/Documentation/admin-guide/cgroup-v1/blkio-controller.rst b/Documentation/admin-guide/cgroup-v1/blkio-controller.rst
index 1d7d962933be..36d43ae7dc13 100644
--- a/Documentation/admin-guide/cgroup-v1/blkio-controller.rst
+++ b/Documentation/admin-guide/cgroup-v1/blkio-controller.rst
@@ -130,12 +130,6 @@ Proportional weight policy files
 	    dev     weight
 	    8:16    300
 
-- blkio.leaf_weight[_device]
-	- Equivalents of blkio.weight[_device] for the purpose of
-          deciding how much weight tasks in the given cgroup has while
-          competing with the cgroup's child cgroups. For details,
-          please refer to Documentation/block/cfq-iosched.txt.
-
 - blkio.time
 	- disk time allocated to cgroup per device in milliseconds. First
 	  two fields specify the major and minor number of the device and
-- 
2.21.0

[PATCH 6/7] docs: zh_CN: howto.rst: fix a broken reference

[Mauro Carvalho Chehab]

There's a broken reference there pointing to the long gone
DocBook dir.

While I don't read chinese, Google translator translates it
to:
	"The generated documentation will be placed in
	 the Documentation/DocBook/ directory."

Well, we know that the output will be Documentation/output
dir. So, let's fix this one.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/translations/zh_CN/process/howto.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/translations/zh_CN/process/howto.rst b/Documentation/translations/zh_CN/process/howto.rst
index 5b671178b17b..c4ff8356b88d 100644
--- a/Documentation/translations/zh_CN/process/howto.rst
+++ b/Documentation/translations/zh_CN/process/howto.rst
@@ -147,7 +147,7 @@ Linux内核代码中包含有大量的文档。这些文档对于学习如何与
     关于补丁是什么以及如何将它打在不同内核开发分支上的好介绍
 
 内核还拥有大量从代码自动生成的文档。它包含内核内部API的全面介绍以及如何
-妥善处理加锁的规则。生成的文档会放在 Documentation/DocBook/目录下。在内
+妥善处理加锁的规则。生成的文档会放在 Documentation/output/目录下。在内
 核源码的主目录中使用以下不同命令将会分别生成PDF、Postscript、HTML和手册
 页等不同格式的文档::
 
-- 
2.21.0

[PATCH 7/7] docs: dt: fix a sound binding broken reference

[Mauro Carvalho Chehab]

Address this rename:
	Documentation/devicetree/bindings/sound/{sun4i-i2s.txt -> allwinner,sun4i-a10-i2s.yaml}

Fixes: 0a0ca8e94ca3 ("dt-bindings: sound: Convert Allwinner I2S binding to YAML")
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/devicetree/bindings/sound/sun8i-a33-codec.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/devicetree/bindings/sound/sun8i-a33-codec.txt b/Documentation/devicetree/bindings/sound/sun8i-a33-codec.txt
index 2ca3d138528e..7ecf6bd60d27 100644
--- a/Documentation/devicetree/bindings/sound/sun8i-a33-codec.txt
+++ b/Documentation/devicetree/bindings/sound/sun8i-a33-codec.txt
@@ -4,7 +4,7 @@ Allwinner SUN8I audio codec
 On Sun8i-A33 SoCs, the audio is separated in different parts:
 	  - A DAI driver. It uses the "sun4i-i2s" driver which is
 	  documented here:
-	  Documentation/devicetree/bindings/sound/sun4i-i2s.txt
+	  Documentation/devicetree/bindings/sound/allwinner,sun4i-a10-i2s.yaml
 	  - An analog part of the codec which is handled as PRCM registers.
 	  See Documentation/devicetree/bindings/sound/sun8i-codec-analog.txt
 	  - An digital part of the codec which is documented in this current
-- 
2.21.0

Re: [PATCH 0/7] Fix broken references to files under Documentation/*

[Atish Patra]

On 7/26/19 4:47 AM, Mauro Carvalho Chehab wrote:
> Solves most of the pending broken references upstream, except for two of
> them:
> 
> 	$ ./scripts/documentation-file-ref-check
> 	Documentation/riscv/boot-image-header.txt: Documentation/riscv/booting.txt
> 	MAINTAINERS: Documentation/devicetree/bindings/rng/samsung,exynos5250-trng.txt
> 
> As written at boot-image-header.txt, it is waiting for the addition of
> a future file:
> 
> 	"The complete booting guide will be available at
> 	  Documentation/riscv/booting.txt."
> 

Yeah. We don't have complete booting guide defined in RISC-V land.
Documentation/riscv/booting.txt will be available once we have that.

In the mean time, do we need to convert boot-image-header.txt to 
boot-image-header.rst and fix the reference to 
Documentation/riscv/booting.rst as well ?

> The second is due to this patch, pending to be merged:
> 	https://lore.kernel.org/patchwork/patch/994210/
> 
> I'm not a DT expert, but I can't see any issue with this patch, except
> for a missing acked-by a DT maintainer, and a possible conversion to
> yaml. IMO, the best fix for this would be to merge the DT patch.
> 
> Patch 1 was already submitted before, together with the v1 of
> my PDF fix series.
> 
> Mauro Carvalho Chehab (7):
>    docs: fix broken doc references due to renames
>    docs: generic-counter.rst: fix broken references for ABI file
>    MAINTAINERS: fix reference to net phy ABI file
>    MAINTAINERS: fix a renamed DT reference
>    docs: cgroup-v1/blkio-controller.rst: remove a CFQ left over
>    docs: zh_CN: howto.rst: fix a broken reference
>    docs: dt: fix a sound binding broken reference
> 
>   Documentation/RCU/rculist_nulls.txt                |  2 +-
>   .../admin-guide/cgroup-v1/blkio-controller.rst     |  6 ------
>   .../devicetree/bindings/arm/idle-states.txt        |  2 +-
>   .../devicetree/bindings/sound/sun8i-a33-codec.txt  |  2 +-
>   Documentation/driver-api/generic-counter.rst       |  4 ++--
>   Documentation/locking/spinlocks.rst                |  4 ++--
>   Documentation/memory-barriers.txt                  |  2 +-
>   .../translations/ko_KR/memory-barriers.txt         |  2 +-
>   Documentation/translations/zh_CN/process/howto.rst |  2 +-
>   Documentation/watchdog/hpwdt.rst                   |  2 +-
>   MAINTAINERS                                        | 14 +++++++-------
>   drivers/gpu/drm/drm_modes.c                        |  2 +-
>   drivers/i2c/busses/i2c-nvidia-gpu.c                |  2 +-
>   drivers/scsi/hpsa.c                                |  4 ++--
>   14 files changed, 22 insertions(+), 28 deletions(-)
> 


-- 
Regards,
Atish

Re: [PATCH 0/7] Fix broken references to files under Documentation/*

[Mauro Carvalho Chehab]

Em Fri, 26 Jul 2019 12:55:36 -0700
Atish Patra <atish.patra@wdc.com> escreveu:

> On 7/26/19 4:47 AM, Mauro Carvalho Chehab wrote:
> > Solves most of the pending broken references upstream, except for two of
> > them:
> > 
> > 	$ ./scripts/documentation-file-ref-check
> > 	Documentation/riscv/boot-image-header.txt: Documentation/riscv/booting.txt
> > 	MAINTAINERS: Documentation/devicetree/bindings/rng/samsung,exynos5250-trng.txt
> > 
> > As written at boot-image-header.txt, it is waiting for the addition of
> > a future file:
> > 
> > 	"The complete booting guide will be available at
> > 	  Documentation/riscv/booting.txt."
> >   
> 
> Yeah. We don't have complete booting guide defined in RISC-V land.
> Documentation/riscv/booting.txt will be available once we have that.
> 
> In the mean time, do we need to convert boot-image-header.txt to 
> boot-image-header.rst and fix the reference to 
> Documentation/riscv/booting.rst as well ?

Well, in the mean time, every time someone builds the Kernel with
COMPILE_TEST enabled, a warning will be produced.

So, my suggestion would be to write it on a different way, like:

	"A complete booting guide is being written and should be
	 available on future versions."

Or:
	TODO:
	   Write a complete booting guide.

And update this once the guide is finished. This should be enough
to prevent the warning.

With regards to converting it to ReST, that's recommended. I suspect
we could be able to finish the entire doc conversion in a couple
Kernel versions. 

Also, it should be really trivial to convert this one to ReST.

Thanks,
Mauro

Re: [PATCH 0/7] Fix broken references to files under Documentation/*

[Atish Patra]

On 7/26/19 1:14 PM, Mauro Carvalho Chehab wrote:
> Em Fri, 26 Jul 2019 12:55:36 -0700
> Atish Patra <atish.patra@wdc.com> escreveu:
> 
>> On 7/26/19 4:47 AM, Mauro Carvalho Chehab wrote:
>>> Solves most of the pending broken references upstream, except for two of
>>> them:
>>>
>>> 	$ ./scripts/documentation-file-ref-check
>>> 	Documentation/riscv/boot-image-header.txt: Documentation/riscv/booting.txt
>>> 	MAINTAINERS: Documentation/devicetree/bindings/rng/samsung,exynos5250-trng.txt
>>>
>>> As written at boot-image-header.txt, it is waiting for the addition of
>>> a future file:
>>>
>>> 	"The complete booting guide will be available at
>>> 	  Documentation/riscv/booting.txt."
>>>    
>>
>> Yeah. We don't have complete booting guide defined in RISC-V land.
>> Documentation/riscv/booting.txt will be available once we have that.
>>
>> In the mean time, do we need to convert boot-image-header.txt to
>> boot-image-header.rst and fix the reference to
>> Documentation/riscv/booting.rst as well ?
> 
> Well, in the mean time, every time someone builds the Kernel with
> COMPILE_TEST enabled, a warning will be produced.
> 
> So, my suggestion would be to write it on a different way, like:
> 
> 	"A complete booting guide is being written and should be
> 	 available on future versions."
> 
> Or:
> 	TODO:
> 	   Write a complete booting guide.
> 
> And update this once the guide is finished. This should be enough
> to prevent the warning.
> 

Sounds good to me.

> With regards to converting it to ReST, that's recommended. I suspect
> we could be able to finish the entire doc conversion in a couple
> Kernel versions.
> 
Sure.

> Also, it should be really trivial to convert this one to ReST.
> 

Yes. Let me know if you prefer to update it along with your series or I 
will send the patch.

> Thanks,
> Mauro
> 


-- 
Regards,
Atish

Re: [PATCH 0/7] Fix broken references to files under Documentation/*

[Mauro Carvalho Chehab]

Em Fri, 26 Jul 2019 13:18:30 -0700
Atish Patra <atish.patra@wdc.com> escreveu:

> On 7/26/19 1:14 PM, Mauro Carvalho Chehab wrote:
> > Em Fri, 26 Jul 2019 12:55:36 -0700
> > Atish Patra <atish.patra@wdc.com> escreveu:
> >   
> >> On 7/26/19 4:47 AM, Mauro Carvalho Chehab wrote:  
> >>> Solves most of the pending broken references upstream, except for two of
> >>> them:
> >>>
> >>> 	$ ./scripts/documentation-file-ref-check
> >>> 	Documentation/riscv/boot-image-header.txt: Documentation/riscv/booting.txt
> >>> 	MAINTAINERS: Documentation/devicetree/bindings/rng/samsung,exynos5250-trng.txt
> >>>
> >>> As written at boot-image-header.txt, it is waiting for the addition of
> >>> a future file:
> >>>
> >>> 	"The complete booting guide will be available at
> >>> 	  Documentation/riscv/booting.txt."
> >>>      
> >>
> >> Yeah. We don't have complete booting guide defined in RISC-V land.
> >> Documentation/riscv/booting.txt will be available once we have that.
> >>
> >> In the mean time, do we need to convert boot-image-header.txt to
> >> boot-image-header.rst and fix the reference to
> >> Documentation/riscv/booting.rst as well ?  
> > 
> > Well, in the mean time, every time someone builds the Kernel with
> > COMPILE_TEST enabled, a warning will be produced.
> > 
> > So, my suggestion would be to write it on a different way, like:
> > 
> > 	"A complete booting guide is being written and should be
> > 	 available on future versions."
> > 
> > Or:
> > 	TODO:
> > 	   Write a complete booting guide.
> > 
> > And update this once the guide is finished. This should be enough
> > to prevent the warning.
> >   
> 
> Sounds good to me.
> 
> > With regards to converting it to ReST, that's recommended. I suspect
> > we could be able to finish the entire doc conversion in a couple
> > Kernel versions.
> >   
> Sure.
> 
> > Also, it should be really trivial to convert this one to ReST.
> >   
> 
> Yes. Let me know if you prefer to update it along with your series or I 
> will send the patch.

I suspect it would be quicker if I write it. I'm sending it in a
few.

Thanks,
Mauro

Re: [PATCH 0/7] Fix broken references to files under Documentation/*

[Atish Patra]

On 7/26/19 2:01 PM, Mauro Carvalho Chehab wrote:
> Em Fri, 26 Jul 2019 13:18:30 -0700
> Atish Patra <atish.patra@wdc.com> escreveu:
> 
>> On 7/26/19 1:14 PM, Mauro Carvalho Chehab wrote:
>>> Em Fri, 26 Jul 2019 12:55:36 -0700
>>> Atish Patra <atish.patra@wdc.com> escreveu:
>>>    
>>>> On 7/26/19 4:47 AM, Mauro Carvalho Chehab wrote:
>>>>> Solves most of the pending broken references upstream, except for two of
>>>>> them:
>>>>>
>>>>> 	$ ./scripts/documentation-file-ref-check
>>>>> 	Documentation/riscv/boot-image-header.txt: Documentation/riscv/booting.txt
>>>>> 	MAINTAINERS: Documentation/devicetree/bindings/rng/samsung,exynos5250-trng.txt
>>>>>
>>>>> As written at boot-image-header.txt, it is waiting for the addition of
>>>>> a future file:
>>>>>
>>>>> 	"The complete booting guide will be available at
>>>>> 	  Documentation/riscv/booting.txt."
>>>>>       
>>>>
>>>> Yeah. We don't have complete booting guide defined in RISC-V land.
>>>> Documentation/riscv/booting.txt will be available once we have that.
>>>>
>>>> In the mean time, do we need to convert boot-image-header.txt to
>>>> boot-image-header.rst and fix the reference to
>>>> Documentation/riscv/booting.rst as well ?
>>>
>>> Well, in the mean time, every time someone builds the Kernel with
>>> COMPILE_TEST enabled, a warning will be produced.
>>>
>>> So, my suggestion would be to write it on a different way, like:
>>>
>>> 	"A complete booting guide is being written and should be
>>> 	 available on future versions."
>>>
>>> Or:
>>> 	TODO:
>>> 	   Write a complete booting guide.
>>>
>>> And update this once the guide is finished. This should be enough
>>> to prevent the warning.
>>>    
>>
>> Sounds good to me.
>>
>>> With regards to converting it to ReST, that's recommended. I suspect
>>> we could be able to finish the entire doc conversion in a couple
>>> Kernel versions.
>>>    
>> Sure.
>>
>>> Also, it should be really trivial to convert this one to ReST.
>>>    
>>
>> Yes. Let me know if you prefer to update it along with your series or I
>> will send the patch.
> 
> I suspect it would be quicker if I write it. I'm sending it in a
> few.
> 
Thanks!!

> Thanks,
> Mauro
> 


-- 
Regards,
Atish

[PATCH] docs: riscv: convert boot-image-header.txt to ReST

[Mauro Carvalho Chehab]

Convert this small file to ReST format by:
   - Using a proper markup for the document title;
   - marking a code block as such;
   - use tags for Author and date;
   - use tables for bit map fields.

While here, fix a broken reference for a document with is
planned but is not here yet.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 ...image-header.txt => boot-image-header.rst} | 39 ++++++++++++-------
 Documentation/riscv/index.rst                 |  1 +
 2 files changed, 26 insertions(+), 14 deletions(-)
 rename Documentation/riscv/{boot-image-header.txt => boot-image-header.rst} (72%)

diff --git a/Documentation/riscv/boot-image-header.txt b/Documentation/riscv/boot-image-header.rst
similarity index 72%
rename from Documentation/riscv/boot-image-header.txt
rename to Documentation/riscv/boot-image-header.rst
index 1b73fea23b39..43e9bd0731d5 100644
--- a/Documentation/riscv/boot-image-header.txt
+++ b/Documentation/riscv/boot-image-header.rst
@@ -1,22 +1,25 @@
-				Boot image header in RISC-V Linux
-			=============================================
+=================================
+Boot image header in RISC-V Linux
+=================================
 
-Author: Atish Patra <atish.patra@wdc.com>
-Date  : 20 May 2019
+:Author: Atish Patra <atish.patra@wdc.com>
+:Date:   20 May 2019
 
 This document only describes the boot image header details for RISC-V Linux.
-The complete booting guide will be available at Documentation/riscv/booting.txt.
 
-The following 64-byte header is present in decompressed Linux kernel image.
+TODO:
+  Write a complete booting guide.
+
+The following 64-byte header is present in decompressed Linux kernel image::
 
 	u32 code0;		  /* Executable code */
-	u32 code1; 		  /* Executable code */
+	u32 code1;		  /* Executable code */
 	u64 text_offset;	  /* Image load offset, little endian */
 	u64 image_size;		  /* Effective Image size, little endian */
 	u64 flags;		  /* kernel flags, little endian */
 	u32 version;		  /* Version of this header */
-	u32 res1  = 0;		  /* Reserved */
-	u64 res2  = 0;    	  /* Reserved */
+	u32 res1 = 0;		  /* Reserved */
+	u64 res2 = 0;		  /* Reserved */
 	u64 magic = 0x5643534952; /* Magic number, little endian, "RISCV" */
 	u32 res3;		  /* Reserved for additional RISC-V specific header */
 	u32 res4;		  /* Reserved for PE COFF offset */
@@ -25,16 +28,21 @@ This header format is compliant with PE/COFF header and largely inspired from
 ARM64 header. Thus, both ARM64 & RISC-V header can be combined into one common
 header in future.
 
-Notes:
+Notes
+=====
+
 - This header can also be reused to support EFI stub for RISC-V in future. EFI
   specification needs PE/COFF image header in the beginning of the kernel image
   in order to load it as an EFI application. In order to support EFI stub,
   code0 should be replaced with "MZ" magic string and res5(at offset 0x3c) should
   point to the rest of the PE/COFF header.
 
-- version field indicate header version number.
-	Bits 0:15  - Minor version
-	Bits 16:31 - Major version
+- version field indicate header version number
+
+	==========  =============
+	Bits 0:15   Minor version
+	Bits 16:31  Major version
+	==========  =============
 
   This preserves compatibility across newer and older version of the header.
   The current version is defined as 0.1.
@@ -44,7 +52,10 @@ Notes:
   extension for RISC-V in future. For current version, it is set to be zero.
 
 - In current header, the flag field has only one field.
-	Bit 0: Kernel endianness. 1 if BE, 0 if LE.
+
+	=====  ====================================
+	Bit 0  Kernel endianness. 1 if BE, 0 if LE.
+	=====  ====================================
 
 - Image size is mandatory for boot loader to load kernel image. Booting will
   fail otherwise.
diff --git a/Documentation/riscv/index.rst b/Documentation/riscv/index.rst
index e3ca0922a8c2..215fd3c1f2d5 100644
--- a/Documentation/riscv/index.rst
+++ b/Documentation/riscv/index.rst
@@ -5,6 +5,7 @@ RISC-V architecture
 .. toctree::
     :maxdepth: 1
 
+    boot-image-header
     pmu
 
 .. only::  subproject and html
-- 
2.21.0

Re: [PATCH] docs: riscv: convert boot-image-header.txt to ReST

[Atish Patra]

On 7/26/19 2:02 PM, Mauro Carvalho Chehab wrote:
> Convert this small file to ReST format by:
>     - Using a proper markup for the document title;
>     - marking a code block as such;
>     - use tags for Author and date;
>     - use tables for bit map fields.
> 
> While here, fix a broken reference for a document with is
> planned but is not here yet.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> ---
>   ...image-header.txt => boot-image-header.rst} | 39 ++++++++++++-------
>   Documentation/riscv/index.rst                 |  1 +
>   2 files changed, 26 insertions(+), 14 deletions(-)
>   rename Documentation/riscv/{boot-image-header.txt => boot-image-header.rst} (72%)
> 
> diff --git a/Documentation/riscv/boot-image-header.txt b/Documentation/riscv/boot-image-header.rst
> similarity index 72%
> rename from Documentation/riscv/boot-image-header.txt
> rename to Documentation/riscv/boot-image-header.rst
> index 1b73fea23b39..43e9bd0731d5 100644
> --- a/Documentation/riscv/boot-image-header.txt
> +++ b/Documentation/riscv/boot-image-header.rst
> @@ -1,22 +1,25 @@
> -				Boot image header in RISC-V Linux
> -			=============================================
> +=================================
> +Boot image header in RISC-V Linux
> +=================================
>   
> -Author: Atish Patra <atish.patra@wdc.com>
> -Date  : 20 May 2019
> +:Author: Atish Patra <atish.patra@wdc.com>
> +:Date:   20 May 2019
>   
>   This document only describes the boot image header details for RISC-V Linux.
> -The complete booting guide will be available at Documentation/riscv/booting.txt.
>   
> -The following 64-byte header is present in decompressed Linux kernel image.
> +TODO:
> +  Write a complete booting guide.
> +
> +The following 64-byte header is present in decompressed Linux kernel image::
>   
>   	u32 code0;		  /* Executable code */
> -	u32 code1; 		  /* Executable code */
> +	u32 code1;		  /* Executable code */
>   	u64 text_offset;	  /* Image load offset, little endian */
>   	u64 image_size;		  /* Effective Image size, little endian */
>   	u64 flags;		  /* kernel flags, little endian */
>   	u32 version;		  /* Version of this header */
> -	u32 res1  = 0;		  /* Reserved */
> -	u64 res2  = 0;    	  /* Reserved */
> +	u32 res1 = 0;		  /* Reserved */
> +	u64 res2 = 0;		  /* Reserved */
>   	u64 magic = 0x5643534952; /* Magic number, little endian, "RISCV" */
>   	u32 res3;		  /* Reserved for additional RISC-V specific header */
>   	u32 res4;		  /* Reserved for PE COFF offset */
> @@ -25,16 +28,21 @@ This header format is compliant with PE/COFF header and largely inspired from
>   ARM64 header. Thus, both ARM64 & RISC-V header can be combined into one common
>   header in future.
>   
> -Notes:
> +Notes
> +=====
> +
>   - This header can also be reused to support EFI stub for RISC-V in future. EFI
>     specification needs PE/COFF image header in the beginning of the kernel image
>     in order to load it as an EFI application. In order to support EFI stub,
>     code0 should be replaced with "MZ" magic string and res5(at offset 0x3c) should
>     point to the rest of the PE/COFF header.
>   
> -- version field indicate header version number.
> -	Bits 0:15  - Minor version
> -	Bits 16:31 - Major version
> +- version field indicate header version number
> +
> +	==========  =============
> +	Bits 0:15   Minor version
> +	Bits 16:31  Major version
> +	==========  =============
>   
>     This preserves compatibility across newer and older version of the header.
>     The current version is defined as 0.1.
> @@ -44,7 +52,10 @@ Notes:
>     extension for RISC-V in future. For current version, it is set to be zero.
>   
>   - In current header, the flag field has only one field.
> -	Bit 0: Kernel endianness. 1 if BE, 0 if LE.
> +
> +	=====  ====================================
> +	Bit 0  Kernel endianness. 1 if BE, 0 if LE.
> +	=====  ====================================
>   
>   - Image size is mandatory for boot loader to load kernel image. Booting will
>     fail otherwise.
> diff --git a/Documentation/riscv/index.rst b/Documentation/riscv/index.rst
> index e3ca0922a8c2..215fd3c1f2d5 100644
> --- a/Documentation/riscv/index.rst
> +++ b/Documentation/riscv/index.rst
> @@ -5,6 +5,7 @@ RISC-V architecture
>   .. toctree::
>       :maxdepth: 1
>   
> +    boot-image-header
>       pmu
>   
>   .. only::  subproject and html
> 

Thanks for the quick patch.

Reviewed-by: Atish Patra <atish.patra@wdc.com>

-- 
Regards,
Atish

Re: [PATCH] docs: riscv: convert boot-image-header.txt to ReST

[Jonathan Corbet]

On Fri, 26 Jul 2019 18:01:55 -0300
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> wrote:

> Convert this small file to ReST format by:
>    - Using a proper markup for the document title;
>    - marking a code block as such;
>    - use tags for Author and date;
>    - use tables for bit map fields.
> 
> While here, fix a broken reference for a document with is
> planned but is not here yet.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>

Applied, thanks.

jon

Re: [PATCH 0/7] Fix broken references to files under Documentation/*

[Łukasz Stelmach]

[-- Attachment #1: Type: text/plain, Size: 2503 bytes --]

It was <2019-07-26 pią 13:47>, when Mauro Carvalho Chehab wrote:
> Solves most of the pending broken references upstream, except for two of
> them:
>
> 	$ ./scripts/documentation-file-ref-check 
> 	Documentation/riscv/boot-image-header.txt: Documentation/riscv/booting.txt
> 	MAINTAINERS: Documentation/devicetree/bindings/rng/samsung,exynos5250-trng.txt

Please apply the patch https://patchwork.kernel.org/patch/10758009/

> As written at boot-image-header.txt, it is waiting for the addition of
> a future file: 
>
> 	"The complete booting guide will be available at
> 	  Documentation/riscv/booting.txt."
>
> The second is due to this patch, pending to be merged:
> 	https://lore.kernel.org/patchwork/patch/994210/
>
> I'm not a DT expert, but I can't see any issue with this patch, except
> for a missing acked-by a DT maintainer, and a possible conversion to
> yaml. IMO, the best fix for this would be to merge the DT patch.
>
> Patch 1 was already submitted before, together with the v1 of
> my PDF fix series.
>
> Mauro Carvalho Chehab (7):
>   docs: fix broken doc references due to renames
>   docs: generic-counter.rst: fix broken references for ABI file
>   MAINTAINERS: fix reference to net phy ABI file
>   MAINTAINERS: fix a renamed DT reference
>   docs: cgroup-v1/blkio-controller.rst: remove a CFQ left over
>   docs: zh_CN: howto.rst: fix a broken reference
>   docs: dt: fix a sound binding broken reference
>
>  Documentation/RCU/rculist_nulls.txt                |  2 +-
>  .../admin-guide/cgroup-v1/blkio-controller.rst     |  6 ------
>  .../devicetree/bindings/arm/idle-states.txt        |  2 +-
>  .../devicetree/bindings/sound/sun8i-a33-codec.txt  |  2 +-
>  Documentation/driver-api/generic-counter.rst       |  4 ++--
>  Documentation/locking/spinlocks.rst                |  4 ++--
>  Documentation/memory-barriers.txt                  |  2 +-
>  .../translations/ko_KR/memory-barriers.txt         |  2 +-
>  Documentation/translations/zh_CN/process/howto.rst |  2 +-
>  Documentation/watchdog/hpwdt.rst                   |  2 +-
>  MAINTAINERS                                        | 14 +++++++-------
>  drivers/gpu/drm/drm_modes.c                        |  2 +-
>  drivers/i2c/busses/i2c-nvidia-gpu.c                |  2 +-
>  drivers/scsi/hpsa.c                                |  4 ++--
>  14 files changed, 22 insertions(+), 28 deletions(-)

-- 
Łukasz Stelmach
Samsung R&D Institute Poland
Samsung Electronics

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 487 bytes --]