mbox series

[v2,00/19] Fix broken documentation file references

Message ID cover.1617783062.git.mchehab+huawei@kernel.org
Headers show
Series Fix broken documentation file references | expand

Message

Mauro Carvalho Chehab April 7, 2021, 8:20 a.m. UTC
Hi Jon,

As files keep being moved around and DT bindings are 
converted and renamed to yaml, their doc references get 
outdated, pointing to an invalid places.

This series address those. It is based on the top of docs-next tree,
and most patches here are independent from the other ones.

v2:
  - Dropped patches that were already applied, Most of those
    will be following via Jonathan Cameron's iio tree;
  - Dropped patches that don't apply on the top of docs next.
  - Added some new patches fixing other breakages.

PS.:  
  I placed the dropped patches on a separate branch. I'll track 
  them and re-submit any missing ones after -rc1.

Mauro Carvalho Chehab (19):
  MAINTAINERS: update ste,mcde.yaml reference
  MAINTAINERS: update brcm,bcm-v3d.yaml reference
  MAINTAINERS: update fsl,dpaa2-console.yaml reference
  MAINTAINERS: update mtk-sd.yaml reference
  MAINTAINERS: update snps,dw-axi-dmac.yaml reference
  dt-bindings: don't use ../dir for doc references
  dt-bindings: fix references for iio-bindings.txt
  dt-bindings: iommu: mediatek: update mediatek,iommu.yaml references
  dt-bindings: i3c: update i3c.yaml references
  dt-bindings:iio:adc: update motorola,cpcap-adc.yaml reference
  dt-bindings:iio:adc: update dlg,da9150-gpadc.yaml reference
  dt-bindings: power: supply: da9150: update da9150-charger.txt
    reference
  dt-bindings: power: supply: da9150: update da9150-fg.txt reference
  docs: update sysfs-platform_profile.rst reference
  docs: update rcu_dereference.rst reference
  docs: vcpu-requests.rst: fix reference for atomic ops
  docs: replace transation references for reporting-bugs.rst
  docs: translations/zh_CN: fix a typo at 8.Conclusion.rst
  docs: sched-bwc.rst: fix a typo on a doc name

 .../bindings/display/mediatek/mediatek,disp.txt  |  2 +-
 .../devicetree/bindings/hwmon/ntc_thermistor.txt |  2 +-
 .../devicetree/bindings/i3c/cdns,i3c-master.txt  |  6 +++---
 .../bindings/i3c/snps,dw-i3c-master.txt          |  6 +++---
 .../devicetree/bindings/iio/adc/ingenic,adc.yaml |  5 +++--
 .../devicetree/bindings/input/adc-joystick.yaml  |  4 +++-
 .../input/touchscreen/resistive-adc-touch.txt    |  5 ++++-
 .../bindings/media/mediatek-jpeg-decoder.txt     |  2 +-
 .../bindings/media/mediatek-jpeg-encoder.txt     |  2 +-
 .../devicetree/bindings/media/mediatek-mdp.txt   |  2 +-
 .../bindings/media/mediatek-vcodec.txt           |  2 +-
 Documentation/devicetree/bindings/mfd/ab8500.txt |  4 +++-
 Documentation/devicetree/bindings/mfd/da9150.txt |  8 ++++----
 .../devicetree/bindings/mfd/motorola-cpcap.txt   | 16 ++++++++--------
 .../bindings/power/supply/da9150-charger.txt     |  2 +-
 Documentation/scheduler/sched-bwc.rst            |  2 +-
 .../translations/it_IT/process/howto.rst         |  2 +-
 Documentation/translations/ja_JP/howto.rst       |  2 +-
 Documentation/translations/zh_CN/SecurityBugs    |  2 +-
 .../zh_CN/admin-guide/reporting-issues.rst       |  4 ++--
 .../translations/zh_CN/process/8.Conclusion.rst  |  2 +-
 .../translations/zh_CN/process/howto.rst         |  2 +-
 Documentation/virt/kvm/vcpu-requests.rst         |  2 +-
 MAINTAINERS                                      | 10 +++++-----
 include/linux/platform_profile.h                 |  2 +-
 tools/memory-model/Documentation/glossary.txt    |  2 +-
 26 files changed, 54 insertions(+), 46 deletions(-)

Comments

Jonathan Cameron April 7, 2021, 10:19 a.m. UTC | #1
On Wed, 7 Apr 2021 10:20:50 +0200
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:

> Changeset e13b686b18e3 ("dt-bindings:iio:adc:dlg,da9150-gpadc yaml conversion")
> renamed: Documentation/devicetree/bindings/iio/adc/da9150-gpadc.txt
> to: Documentation/devicetree/bindings/iio/adc/dlg,da9150-gpadc.yaml.
> 
> Update its cross-reference accordingly.
> 
> Fixes: e13b686b18e3 ("dt-bindings:iio:adc:dlg,da9150-gpadc yaml conversion")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>

> ---
>  Documentation/devicetree/bindings/mfd/da9150.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/devicetree/bindings/mfd/da9150.txt b/Documentation/devicetree/bindings/mfd/da9150.txt
> index 763e0b639a82..b7afa39d6260 100644
> --- a/Documentation/devicetree/bindings/mfd/da9150.txt
> +++ b/Documentation/devicetree/bindings/mfd/da9150.txt
> @@ -19,7 +19,7 @@ Required properties:
>     further information relating to interrupt properties)
>  
>  Sub-devices:
> -- da9150-gpadc: See Documentation/devicetree/bindings/iio/adc/da9150-gpadc.txt
> +- da9150-gpadc: See Documentation/devicetree/bindings/iio/adc/dlg,da9150-gpadc.yaml
>  - da9150-charger: See Documentation/devicetree/bindings/power/da9150-charger.txt
>  - da9150-fg: See Documentation/devicetree/bindings/power/da9150-fg.txt
>
Sebastian Reichel April 7, 2021, 7:14 p.m. UTC | #2
Hi,

On Wed, Apr 07, 2021 at 10:20:51AM +0200, Mauro Carvalho Chehab wrote:
> Changeset f3332532463f ("power/supply: unify DT documentation")
> renamed: Documentation/devicetree/bindings/power/da9150-charger.txt
> to: Documentation/devicetree/bindings/power/supply/da9150-charger.txt.
> 
> Update its cross-reference accordingly.
> 
> Fixes: f3332532463f ("power/supply: unify DT documentation")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
>  Documentation/devicetree/bindings/mfd/da9150.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/devicetree/bindings/mfd/da9150.txt b/Documentation/devicetree/bindings/mfd/da9150.txt
> index b7afa39d6260..f4db2b520327 100644
> --- a/Documentation/devicetree/bindings/mfd/da9150.txt
> +++ b/Documentation/devicetree/bindings/mfd/da9150.txt
> @@ -20,7 +20,7 @@ Required properties:
>  
>  Sub-devices:
>  - da9150-gpadc: See Documentation/devicetree/bindings/iio/adc/dlg,da9150-gpadc.yaml
> -- da9150-charger: See Documentation/devicetree/bindings/power/da9150-charger.txt
> +- da9150-charger: See Documentation/devicetree/bindings/power/supply/da9150-charger.txt
>  - da9150-fg: See Documentation/devicetree/bindings/power/da9150-fg.txt

This got "renamed" again in -next. Also I do not see the point to
update the next line in its own patch.

git show --stat 59604ba75633
commit 59604ba756334377deca54bc0526da739bfc0c51
Author: Sebastian Reichel <sebastian.reichel@collabora.com>
Date:   Wed Mar 17 14:48:55 2021 +0100

    dt-bindings: power: supply: da9150: Convert to DT schema format
    
    Convert the binding to DT schema format.
    
    Signed-off-by: Sebastian Reichel <sebastian.reichel@collabora.com>
    Reviewed-by: Rob Herring <robh@kernel.org>

 Documentation/devicetree/bindings/power/supply/da9150-charger.txt         | 26 --------------------------
 Documentation/devicetree/bindings/power/supply/da9150-fg.txt              | 23 -----------------------
 Documentation/devicetree/bindings/power/supply/dlg,da9150-charger.yaml    | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 Documentation/devicetree/bindings/power/supply/dlg,da9150-fuel-gauge.yaml | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 103 insertions(+), 49 deletions(-)

Thanks,

-- Sebastian