Fix broken documentation file references

PATCH Applied Mauro Carvalho Chehab 5 participants 16 messages Apr 9, 2021 – Apr 15, 2021

Subsystems (11)

Device tree bindings Documentation KVM HID +7 more subsystems

lore

Share & tools

lore

Mauro Carvalho Chehab

author

2021-04-09 12:48 UTC #0 lore raw

v3 cover Fix broken documentation file references

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.

v3:
- Dropped patches already applied at next-20210409 and

    changes that would cause conflicts there;

- Added received acks.

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.

Mauro Carvalho Chehab (8):
dt-bindings: don't use ../dir for doc references
dt-bindings: fix references for iio-bindings.txt dt-bindings:iio:adc: update motorola,cpcap-adc.yaml reference
docs: update sysfs-platform_profile.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

 .../devicetree/bindings/hwmon/ntc_thermistor.txt |  2 +-
 .../devicetree/bindings/iio/adc/ingenic,adc.yaml |  5 +++--
 .../devicetree/bindings/input/adc-joystick.yaml  |  4 +++-
 .../input/touchscreen/resistive-adc-touch.txt    |  5 ++++-
 Documentation/devicetree/bindings/mfd/ab8500.txt |  4 +++-
 .../devicetree/bindings/mfd/motorola-cpcap.txt   | 16 ++++++++--------
 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 +-
 include/linux/platform_profile.h                 |  2 +-
 15 files changed, 32 insertions(+), 24 deletions(-)

Signature · 1 line

2.30.2

Mauro Carvalho Chehab

author

2021-04-09 12:48 UTC #1 lore raw

PATCH v3 1/8 dt-bindings: don't use ../dir for doc references

As documents have been renamed and moved around, their references will break, but this will be unnoticed, as the script which checks for it won't handle "../" references.

So, replace them by the full patch.

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---
 .../input/touchscreen/resistive-adc-touch.txt    |  2 +-
 .../devicetree/bindings/mfd/motorola-cpcap.txt   | 16 ++++++++--------
 2 files changed, 9 insertions(+), 9 deletions(-)

Documentation/devicetree/bindings/input/touchscreen/resistive-adc-touch.txt +1 -1

index 51456c0e9a27..fee0da12474e 100644
@@ -5,7 +5,7 @@ Required properties:
  - compatible: must be "resistive-adc-touch"
 The device must be connected to an ADC device that provides channels for
 position measurement and optional pressure.
-Refer to ../iio/iio-bindings.txt for details
+Refer to Documentation/devicetree/bindings/iio/iio-bindings.txt for details
  - iio-channels: must have at least two channels connected to an ADC device.
 These should correspond to the channels exposed by the ADC device and should
 have the right index as the ADC device registers them. These channels

Documentation/devicetree/bindings/mfd/motorola-cpcap.txt +8 -8

index 5ddcc8f4febc..ebdccfb600b9 100644
@@ -16,14 +16,14 @@ Optional subnodes:
 The sub-functions of CPCAP get their own node with their own compatible values,
 which are described in the following files:
 
-- ../power/supply/cpcap-battery.txt
-- ../power/supply/cpcap-charger.txt
-- ../regulator/cpcap-regulator.txt
-- ../phy/phy-cpcap-usb.txt
-- ../input/cpcap-pwrbutton.txt
-- ../rtc/cpcap-rtc.txt
-- ../leds/leds-cpcap.txt
-- ../iio/adc/cpcap-adc.txt
+- Documentation/devicetree/bindings/power/supply/cpcap-battery.txt
+- Documentation/devicetree/bindings/power/supply/cpcap-charger.txt
+- Documentation/devicetree/bindings/regulator/cpcap-regulator.txt
+- Documentation/devicetree/bindings/phy/phy-cpcap-usb.txt
+- Documentation/devicetree/bindings/input/cpcap-pwrbutton.txt
+- Documentation/devicetree/bindings/rtc/cpcap-rtc.txt
+- Documentation/devicetree/bindings/leds/leds-cpcap.txt
+- Documentation/devicetree/bindings/iio/adc/cpcap-adc.txt
 
 The only exception is the audio codec. Instead of a compatible value its
 node must be named "audio-codec".

Signature · 1 line

2.30.2

Rob Herring

2021-04-09 16:30 UTC #2 lore raw

Re: [PATCH v3 1/8] dt-bindings: don't use ../dir for doc references

Quoted 18 lines · Mauro Carvalho Chehab

As documents have been renamed and moved around, their references will break, but this will be unnoticed, as the script which checks for it won't handle "../" references.
So, replace them by the full patch.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
---
 .../input/touchscreen/resistive-adc-touch.txt    |  2 +-
 .../devicetree/bindings/mfd/motorola-cpcap.txt   | 16 ++++++++--------
 2 files changed, 9 insertions(+), 9 deletions(-)
Documentation/devicetree/bindings/input/touchscreen/resistive-adc-touch.txt +0 -0
index 51456c0e9a27..fee0da12474e 100644

Documentation/devicetree/bindings/input/touchscreen/resistive-adc-touch.txt Required properties: · line 8

Quoted 5 lines

Documentation/devicetree/bindings/input/touchscreen/resistive-adc-touch.txt +1 -1

@@ -5,7 +5,7 @@ Required properties:
  - compatible: must be "resistive-adc-touch"
 The device must be connected to an ADC device that provides channels for
 position measurement and optional pressure.
-Refer to ../iio/iio-bindings.txt for details
+Refer to Documentation/devicetree/bindings/iio/iio-bindings.txt for details

There's a downside to this in that the DT only repo[1] will have wrong paths, but we no doubt already have lots of those. I guess a consistent path is better and we can transform it if needed.

Rob

[1] https://git.kernel.org/pub/scm/linux/kernel/git/devicetree/devicetree-rebasing.git/

Rob Herring

maintainer Applied

2021-04-09 19:18 UTC #3 lore raw

Re: [PATCH v3 1/8] dt-bindings: don't use ../dir for doc references

In reply to Mauro Carvalho Chehab

Quoted 4 lines · Mauro Carvalho Chehab

As documents have been renamed and moved around, their references will break, but this will be unnoticed, as the script which checks for it won't handle "../" references.

Quoted 8 lines

So, replace them by the full patch.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
---
 .../input/touchscreen/resistive-adc-touch.txt    |  2 +-
 .../devicetree/bindings/mfd/motorola-cpcap.txt   | 16 ++++++++--------
 2 files changed, 9 insertions(+), 9 deletions(-)

Applied, thanks!

Mauro Carvalho Chehab

author

2021-04-09 12:48 UTC #4 lore raw

PATCH v3 2/8 dt-bindings: fix references for iio-bindings.txt

In reply to Mauro Carvalho Chehab

The iio-bindings.txt was converted into two files and merged at the dt-schema git tree at:

https://github.com/devicetree-org/dt-schema

Yet, some documents still refer to the old file. Fix their references, in order to point to the right URL.

Fixes dba91f82d580 ("dt-bindings:iio:iio-binding.txt Drop file as content now in dt-schema")

Acked-by Jonathan Cameron <[email protected]>

Acked-by Guenter Roeck <[email protected]>

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---
 Documentation/devicetree/bindings/hwmon/ntc_thermistor.txt   | 2 +-
 Documentation/devicetree/bindings/iio/adc/ingenic,adc.yaml   | 5 +++--
 Documentation/devicetree/bindings/input/adc-joystick.yaml    | 4 +++-
 .../bindings/input/touchscreen/resistive-adc-touch.txt       | 5 ++++-
 Documentation/devicetree/bindings/mfd/ab8500.txt             | 4 +++-
 5 files changed, 14 insertions(+), 6 deletions(-)

Documentation/devicetree/bindings/hwmon/ntc_thermistor.txt +1 -1

index 37f18d684f6a..4c5c3712970e 100644
@@ -32,7 +32,7 @@ Optional node properties:
 - "#thermal-sensor-cells" Used to expose itself to thermal fw.
 
 Read more about iio bindings at
-	Documentation/devicetree/bindings/iio/iio-bindings.txt
+	https://github.com/devicetree-org/dt-schema/blob/master/schemas/iio/
 
 Example:
 	ncp15wb473@0 {

Documentation/devicetree/bindings/iio/adc/ingenic,adc.yaml +3 -2

index 9f414dbdae86..433a3fb55a2e 100644
@@ -14,8 +14,9 @@ description: >
   Industrial I/O subsystem bindings for ADC controller found in
   Ingenic JZ47xx SoCs.
 
-  ADC clients must use the format described in iio-bindings.txt, giving
-  a phandle and IIO specifier pair ("io-channels") to the ADC controller.
+  ADC clients must use the format described in
+  https://github.com/devicetree-org/dt-schema/blob/master/schemas/iio/iio-consumer.yaml,
+  giving a phandle and IIO specifier pair ("io-channels") to the ADC controller.
 
 properties:
   compatible:

Documentation/devicetree/bindings/input/adc-joystick.yaml +3 -1

index 054406bbd22b..721878d5b7af 100644
@@ -24,7 +24,9 @@ properties:
     description: >
       List of phandle and IIO specifier pairs.
       Each pair defines one ADC channel to which a joystick axis is connected.
-      See Documentation/devicetree/bindings/iio/iio-bindings.txt for details.
+      See
+      https://github.com/devicetree-org/dt-schema/blob/master/schemas/iio/iio-consumer.yaml
+      for details.
 
   '#address-cells':
     const: 1

Documentation/devicetree/bindings/input/touchscreen/resistive-adc-touch.txt +4 -1

index fee0da12474e..af5223bb5bdd 100644
@@ -5,7 +5,10 @@ Required properties:
  - compatible: must be "resistive-adc-touch"
 The device must be connected to an ADC device that provides channels for
 position measurement and optional pressure.
-Refer to Documentation/devicetree/bindings/iio/iio-bindings.txt for details
+Refer to
+https://github.com/devicetree-org/dt-schema/blob/master/schemas/iio/iio-consumer.yaml
+for details
+
  - iio-channels: must have at least two channels connected to an ADC device.
 These should correspond to the channels exposed by the ADC device and should
 have the right index as the ADC device registers them. These channels

Documentation/devicetree/bindings/mfd/ab8500.txt +3 -1

index d2a6e835c257..937b3e5505e0 100644
@@ -72,7 +72,9 @@ Required child device properties:
                                                pwm|regulator|rtc|sysctrl|usb]";
 
   A few child devices require ADC channels from the GPADC node. Those follow the
-  standard bindings from iio/iio-bindings.txt and iio/adc/adc.txt
+  standard bindings from
+  https://github.com/devicetree-org/dt-schema/blob/master/schemas/iio/iio-consumer.yaml
+  and Documentation/devicetree/bindings/iio/adc/adc.yaml
 
   abx500-temp		 : io-channels "aux1" and "aux2" for measuring external
 			   temperatures.

Signature · 1 line

2.30.2

Rob Herring

2021-04-09 16:29 UTC #5 lore raw

Re: [PATCH v3 2/8] dt-bindings: fix references for iio-bindings.txt

Quoted 55 lines · Mauro Carvalho Chehab

The iio-bindings.txt was converted into two files and merged at the dt-schema git tree at:
https://github.com/devicetree-org/dt-schema
Yet, some documents still refer to the old file. Fix their references, in order to point to the right URL.
Fixes dba91f82d580 ("dt-bindings:iio:iio-binding.txt Drop file as content now in dt-schema")
Acked-by Jonathan Cameron <[email protected]>
Acked-by Guenter Roeck <[email protected]>
Signed-off-by Mauro Carvalho Chehab <[email protected]>
---
 Documentation/devicetree/bindings/hwmon/ntc_thermistor.txt   | 2 +-
 Documentation/devicetree/bindings/iio/adc/ingenic,adc.yaml   | 5 +++--
 Documentation/devicetree/bindings/input/adc-joystick.yaml    | 4 +++-
 .../bindings/input/touchscreen/resistive-adc-touch.txt       | 5 ++++-
 Documentation/devicetree/bindings/mfd/ab8500.txt             | 4 +++-
 5 files changed, 14 insertions(+), 6 deletions(-)
Documentation/devicetree/bindings/hwmon/ntc_thermistor.txt +1 -1
index 37f18d684f6a..4c5c3712970e 100644
@@ -32,7 +32,7 @@ Optional node properties:
 - "#thermal-sensor-cells" Used to expose itself to thermal fw.
 
 Read more about iio bindings at
-       Documentation/devicetree/bindings/iio/iio-bindings.txt
+       https://github.com/devicetree-org/dt-schema/blob/master/schemas/iio/
 
 Example:
        ncp15wb473@0 {
Documentation/devicetree/bindings/iio/adc/ingenic,adc.yaml +3 -2
index 9f414dbdae86..433a3fb55a2e 100644
@@ -14,8 +14,9 @@ description: >
   Industrial I/O subsystem bindings for ADC controller found in
   Ingenic JZ47xx SoCs.
 
-  ADC clients must use the format described in iio-bindings.txt, giving
-  a phandle and IIO specifier pair ("io-channels") to the ADC controller.
+  ADC clients must use the format described in
+  https://github.com/devicetree-org/dt-schema/blob/master/schemas/iio/iio-consumer.yaml,
+  giving a phandle and IIO specifier pair ("io-channels") to the ADC controller.
 
 properties:
   compatible:
Documentation/devicetree/bindings/input/adc-joystick.yaml +0 -0
index 054406bbd22b..721878d5b7af 100644

Documentation/devicetree/bindings/input/adc-joystick.yaml properties: · line 29

Quoted 7 lines

Documentation/devicetree/bindings/input/adc-joystick.yaml +3 -1

@@ -24,7 +24,9 @@ properties:
     description: >
       List of phandle and IIO specifier pairs.
       Each pair defines one ADC channel to which a joystick axis is connected.
-      See Documentation/devicetree/bindings/iio/iio-bindings.txt for details.
+      See
+      https://github.com/devicetree-org/dt-schema/blob/master/schemas/iio/iio-consumer.yaml
+      for details.

Please just drop this one. We don't need every user of a common property to link to the common schema. If we do, then we should figure out how to generate that (there are some json-schema to docs projects I'd like to investigate some day).

Quoted 37 lines

Documentation/devicetree/bindings/input/adc-joystick.yaml +0 -0

   '#address-cells':
     const: 1

Documentation/devicetree/bindings/input/touchscreen/resistive-adc-touch.txt +4 -1

index fee0da12474e..af5223bb5bdd 100644
@@ -5,7 +5,10 @@ Required properties:
  - compatible: must be "resistive-adc-touch"
 The device must be connected to an ADC device that provides channels for
 position measurement and optional pressure.
-Refer to Documentation/devicetree/bindings/iio/iio-bindings.txt for details
+Refer to
+https://github.com/devicetree-org/dt-schema/blob/master/schemas/iio/iio-consumer.yaml
+for details
+
  - iio-channels: must have at least two channels connected to an ADC device.
 These should correspond to the channels exposed by the ADC device and should
 have the right index as the ADC device registers them. These channels

Documentation/devicetree/bindings/mfd/ab8500.txt +3 -2

index d2a6e835c257..937b3e5505e0 100644
@@ -72,7 +72,9 @@ Required child device properties:
                                                pwm|regulator|rtc|sysctrl|usb]";
 
   A few child devices require ADC channels from the GPADC node. Those follow the
-  standard bindings from iio/iio-bindings.txt and iio/adc/adc.txt
+  standard bindings from
+  https://github.com/devicetree-org/dt-schema/blob/master/schemas/iio/iio-consumer.yaml
+  and Documentation/devicetree/bindings/iio/adc/adc.yaml
 
   abx500-temp           : io-channels "aux1" and "aux2" for measuring external
                           temperatures.
--

2.30.2

Rob Herring

maintainer Applied

2021-04-09 19:18 UTC #6 lore raw

Re: [PATCH v3 2/8] dt-bindings: fix references for iio-bindings.txt

In reply to Mauro Carvalho Chehab

Quoted 12 lines · Mauro Carvalho Chehab

The iio-bindings.txt was converted into two files and merged at the dt-schema git tree at:
https://github.com/devicetree-org/dt-schema
Yet, some documents still refer to the old file. Fix their references, in order to point to the right URL.
Fixes dba91f82d580 ("dt-bindings:iio:iio-binding.txt Drop file as content now in dt-schema")
Acked-by Jonathan Cameron <[email protected]>
Acked-by Guenter Roeck <[email protected]>
Signed-off-by Mauro Carvalho Chehab <[email protected]>

Quoted 8 lines

---
 Documentation/devicetree/bindings/hwmon/ntc_thermistor.txt   | 2 +-
 Documentation/devicetree/bindings/iio/adc/ingenic,adc.yaml   | 5 +++--
 Documentation/devicetree/bindings/input/adc-joystick.yaml    | 4 +++-
 .../bindings/input/touchscreen/resistive-adc-touch.txt       | 5 ++++-
 Documentation/devicetree/bindings/mfd/ab8500.txt             | 4 +++-
 5 files changed, 14 insertions(+), 6 deletions(-)

Applied, thanks!

Mauro Carvalho Chehab

author

2021-04-09 12:48 UTC #7 lore raw

PATCH v3 3/8 dt-bindings:iio:adc: update motorola,cpcap-adc.yaml reference

In reply to Mauro Carvalho Chehab

Changeset 1ca9d1b1342d ("dt-bindings:iio:adc:motorola,cpcap-adc yaml conversion")
renamed: Documentation/devicetree/bindings/iio/adc/cpcap-adc.txt
to: Documentation/devicetree/bindings/iio/adc/motorola,cpcap-adc.yaml.

Update its cross-reference accordingly.

Fixes 1ca9d1b1342d ("dt-bindings:iio:adc:motorola,cpcap-adc yaml conversion")

Acked-by Jonathan Cameron <[email protected]>

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---
 Documentation/devicetree/bindings/mfd/motorola-cpcap.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Documentation/devicetree/bindings/mfd/motorola-cpcap.txt +1 -1

index ebdccfb600b9..b52e7a33f0f9 100644
@@ -23,7 +23,7 @@ which are described in the following files:
 - Documentation/devicetree/bindings/input/cpcap-pwrbutton.txt
 - Documentation/devicetree/bindings/rtc/cpcap-rtc.txt
 - Documentation/devicetree/bindings/leds/leds-cpcap.txt
-- Documentation/devicetree/bindings/iio/adc/cpcap-adc.txt
+- Documentation/devicetree/bindings/iio/adc/motorola,cpcap-adc.yaml
 
 The only exception is the audio codec. Instead of a compatible value its
 node must be named "audio-codec".

Signature · 1 line

2.30.2

Rob Herring

maintainer Applied

2021-04-09 19:23 UTC #8 lore raw

Re: [PATCH v3 3/8] dt-bindings:iio:adc: update motorola,cpcap-adc.yaml reference

Quoted 4 lines · Mauro Carvalho Chehab

Changeset 1ca9d1b1342d ("dt-bindings:iio:adc:motorola,cpcap-adc yaml conversion")
renamed: Documentation/devicetree/bindings/iio/adc/cpcap-adc.txt
to: Documentation/devicetree/bindings/iio/adc/motorola,cpcap-adc.yaml.

Quoted 9 lines

Update its cross-reference accordingly.
Fixes 1ca9d1b1342d ("dt-bindings:iio:adc:motorola,cpcap-adc yaml conversion")
Acked-by Jonathan Cameron <[email protected]>
Signed-off-by Mauro Carvalho Chehab <[email protected]>
---
 Documentation/devicetree/bindings/mfd/motorola-cpcap.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Applied, thanks!

Mauro Carvalho Chehab

author

2021-04-09 12:48 UTC #9 lore raw

PATCH v3 4/8 docs: update sysfs-platform_profile.rst reference

In reply to Mauro Carvalho Chehab

The file name: Documentation/ABI/testing/sysfs-platform_profile.rst should be, instead: Documentation/userspace-api/sysfs-platform_profile.rst.

Update its cross-reference accordingly.

Fixes a2ff95e018f1 ("ACPI: platform: Add platform profile support")

Fixes 8e0cbf356377 ("Documentation: Add documentation for new platform_profile sysfs attribute")

Reviewed-by Hans de Goede <[email protected]>

Reviewed-by Mark Pearson <[email protected]>

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---
 include/linux/platform_profile.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

include/linux/platform_profile.h +1 -1

index a6329003aee7..e5cbb6841f3a 100644
@@ -2,7 +2,7 @@
 /*
  * Platform profile sysfs interface
  *
- * See Documentation/ABI/testing/sysfs-platform_profile.rst for more
+ * See Documentation/userspace-api/sysfs-platform_profile.rst for more
  * information.
  */

Signature · 1 line

2.30.2

Mauro Carvalho Chehab

author

2021-04-09 12:48 UTC #10 lore raw

PATCH v3 5/8 docs: vcpu-requests.rst: fix reference for atomic ops

In reply to Mauro Carvalho Chehab

Changeset f0400a77ebdc ("atomic: Delete obsolete documentation") got rid of atomic_ops.rst, pointing that this was superseded by Documentation/atomic_*.txt.

Update its reference accordingly.

Fixes f0400a77ebdc ("atomic: Delete obsolete documentation")

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---
 Documentation/virt/kvm/vcpu-requests.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Documentation/virt/kvm/vcpu-requests.rst +1 -1

index 5feb3706a7ae..5f8798e7fdf8 100644
@@ -302,6 +302,6 @@ VCPU returns from the call.
 References
 ==========
 
-.. [atomic-ops] Documentation/core-api/atomic_ops.rst
+.. [atomic-ops] Documentation/atomic_bitops.txt and Documentation/atomic_t.txt
 .. [memory-barriers] Documentation/memory-barriers.txt
 .. [lwn-mb] https://lwn.net/Articles/573436/

Signature · 1 line

2.30.2

Paolo Bonzini

maintainer Acked-by on v3 5/8

2021-04-15 16:08 UTC #11 lore raw

Re: [PATCH v3 5/8] docs: vcpu-requests.rst: fix reference for atomic ops

Quoted 18 lines · Mauro Carvalho Chehab

Changeset f0400a77ebdc ("atomic: Delete obsolete documentation") got rid of atomic_ops.rst, pointing that this was superseded by Documentation/atomic_*.txt.
Update its reference accordingly.
Fixes f0400a77ebdc ("atomic: Delete obsolete documentation")
Signed-off-by Mauro Carvalho Chehab <[email protected]>
---
  Documentation/virt/kvm/vcpu-requests.rst | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/virt/kvm/vcpu-requests.rst +0 -0
index 5feb3706a7ae..5f8798e7fdf8 100644

Documentation/virt/kvm/vcpu-requests.rst VCPU returns from the call. · line 307

Quoted 7 lines

Documentation/virt/kvm/vcpu-requests.rst +1 -1

@@ -302,6 +302,6 @@ VCPU returns from the call.
  References
  ==========
 
-.. [atomic-ops] Documentation/core-api/atomic_ops.rst
+.. [atomic-ops] Documentation/atomic_bitops.txt and Documentation/atomic_t.txt
  .. [memory-barriers] Documentation/memory-barriers.txt
  .. [lwn-mb] https://lwn.net/Articles/573436/

Acked-by Paolo Bonzini <[email protected]>

Mauro Carvalho Chehab

author

2021-04-09 12:48 UTC #12 lore raw

PATCH v3 6/8 docs: replace transation references for reporting-bugs.rst

In reply to Mauro Carvalho Chehab

Changeset d2ce285378b0 ("docs: make reporting-issues.rst official and delete reporting-bugs.rst") dropped reporting-bugs.rst, in favor of reporting-issues.rst, but
translations still need to be updated, in order to point to the
new file.

Fixes d2ce285378b0 ("docs: make reporting-issues.rst official and delete reporting-bugs.rst")

Acked-by Wu XiangCheng <[email protected]>

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---
 Documentation/translations/it_IT/process/howto.rst            | 2 +-
 Documentation/translations/ja_JP/howto.rst                    | 2 +-
 Documentation/translations/zh_CN/SecurityBugs                 | 2 +-
 .../translations/zh_CN/admin-guide/reporting-issues.rst       | 4 ++--
 Documentation/translations/zh_CN/process/howto.rst            | 2 +-
 5 files changed, 6 insertions(+), 6 deletions(-)

Documentation/translations/it_IT/process/howto.rst +1 -1

index 1db5a1082389..4962057f50fa 100644
@@ -364,7 +364,7 @@ Per maggiori dettagli su come usare il bugzilla del kernel, guardare:
 
 	https://bugzilla.kernel.org/page.cgi?id=faq.html
 
-Il file admin-guide/reporting-bugs.rst nella cartella principale del kernel
+Il file admin-guide/reporting-issues.rst nella cartella principale del kernel
 fornisce un buon modello sul come segnalare un baco nel kernel, e spiega quali
 informazioni sono necessarie agli sviluppatori per poter aiutare il
 rintracciamento del problema.

Documentation/translations/ja_JP/howto.rst +1 -1

index 73ebdab4ced7..3051ff787e69 100644
@@ -367,7 +367,7 @@ kernel bugzilla を使うかの詳細は、以下を参照してください -
 	https://bugzilla.kernel.org/page.cgi?id=faq.html
 
 メインカーネルソースディレクトリにあるファイル
-admin-guide/reporting-bugs.rstはカーネルバグらしいものについてどうレポー
+admin-guide/reporting-issues.rstはカーネルバグらしいものについてどうレポー
 トするかの良いテンプレートであり、問題の追跡を助けるためにカーネル開発
 者にとってどんな情報が必要なのかの詳細が書かれています。

Documentation/translations/zh_CN/SecurityBugs +1 -1

index 2d0fffd122ce..980199d88eca 100644
@@ -31,7 +31,7 @@ linux内核安全团队可以通过email<[email protected]>来联系。这是
 一组独立的安全工作人员，可以帮助改善漏洞报告并且公布和取消一个修复。安
 全团队有可能会从部分的维护者那里引进额外的帮助来了解并且修复安全漏洞。
 当遇到任何漏洞，所能提供的信息越多就越能诊断和修复。如果你不清楚什么
-是有帮助的信息，那就请重温一下admin-guide/reporting-bugs.rst文件中的概述过程。任
+是有帮助的信息，那就请重温一下admin-guide/reporting-issues.rst文件中的概述过程。任
 何攻击性的代码都是非常有用的，未经报告者的同意不会被取消，除非它已经
 被公布于众。

Documentation/translations/zh_CN/admin-guide/reporting-issues.rst +2 -2

index 2805c1a03cd5..72c8e2db88c0 100644
@@ -19,7 +19,7 @@
 
 .. important::
 
-   本文档将取代“Documentation/admin-guide/reporting-bugs.rst”。主要的工作
+   本文档将取代“Documentation/admin-guide/reporting-issues.rst”。主要的工作
    已经完成，你可以自由地按照其指示来向Linux内核开发者报告问题。但请留意，
    下面的文字还需要一些润色和校审。现阶段它被合并到Linux内核源代码中，以使
    这个过程更容易，并增加文本的可见性。

@@ -726,7 +726,7 @@ tar 存档包。
 .. note::
 
    FIXME: 本节文字暂时是占位符，与目前
-   “Documentation/admin-guide/reporting-bugs.rst”中的旧文字非常相似。它和它
+   “Documentation/admin-guide/reporting-issues.rst”中的旧文字非常相似。它和它
    所引用的文档已经过时，因此需要重新审视。因此，请将此说明视为一个求助：如
    果你熟悉这个主题，请写几行适合这里的文字。或者只需向本文件的主要作者（见
    导言）大致概述一下当前的情况，因为他们也许能写出一些东西来。

Documentation/translations/zh_CN/process/howto.rst +1 -1

index ee3dee476d57..c87cd529d769 100644
@@ -280,7 +280,7 @@ bugzilla.kernel.org是Linux内核开发者们用来跟踪内核Bug的网站。
 
 	http://test.kernel.org/bugzilla/faq.html
 
-内核源码主目录中的:ref:`admin-guide/reporting-bugs.rst <reportingbugs>`
+内核源码主目录中的:ref:`admin-guide/reporting-issues.rst <reportingbugs>`
 文件里有一个很好的模板。它指导用户如何报告可能的内核bug以及需要提供哪些信息
 来帮助内核开发者们找到问题的根源。

Signature · 1 line

2.30.2

Federico Vaga

maintainer Acked-by on v3 6/8

2021-04-09 22:04 UTC #13 lore raw

Re: [PATCH v3 6/8] docs: replace transation references for reporting-bugs.rst

Quoted 6 lines · Mauro Carvalho Chehab

Changeset d2ce285378b0 ("docs: make reporting-issues.rst official and delete reporting-bugs.rst")
dropped reporting-bugs.rst, in favor of reporting-issues.rst, but translations still need to be updated, in order to point to the new file.

Quoted 6 lines

Fixes d2ce285378b0 ("docs: make reporting-issues.rst official and
delete reporting-bugs.rst")
Acked-by Wu XiangCheng <[email protected]>
Signed-off-by Mauro Carvalho Chehab <[email protected]>
---
 Documentation/translations/it_IT/process/howto.rst            | 2 +-

Acked-by Federico Vaga <[email protected]>

Quoted 5 lines

 Documentation/translations/ja_JP/howto.rst                    | 2 +-
 Documentation/translations/zh_CN/SecurityBugs                 | 2 +-
 .../translations/zh_CN/admin-guide/reporting-issues.rst       | 4 ++--
 Documentation/translations/zh_CN/process/howto.rst            | 2 +-
 5 files changed, 6 insertions(+), 6 deletions(-)

Signature · 1 line

Federico Vaga

Mauro Carvalho Chehab

author

2021-04-09 12:48 UTC #14 lore raw

PATCH v3 7/8 docs: translations/zh_CN: fix a typo at 8.Conclusion.rst

In reply to Mauro Carvalho Chehab

transaltions -> translations

Acked-by Wu XiangCheng <[email protected]>

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---
 Documentation/translations/zh_CN/process/8.Conclusion.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Documentation/translations/zh_CN/process/8.Conclusion.rst +1 -1

index 71c3e30efc6f..4707f0101964 100644
@@ -19,7 +19,7 @@
 :ref:`Documentation/translations/zh_CN/process/howto.rst <cn_process_howto>`
 文件是一个重要的起点；
 :ref:`Documentation/translations/zh_CN/process/submitting-patches.rst <cn_submittingpatches>`
-和 :ref:`Documentation/transaltions/zh_CN/process/submitting-drivers.rst <cn_submittingdrivers>`
+和 :ref:`Documentation/translations/zh_CN/process/submitting-drivers.rst <cn_submittingdrivers>`
 也是所有内核开发人员都应该阅读的内容。许多内部内核API都是使用kerneldoc机制
 记录的；“make htmldocs”或“make pdfdocs”可用于以HTML或PDF格式生成这些文档
 （尽管某些发行版提供的tex版本会遇到内部限制，无法正确处理文档）。

Signature · 1 line

2.30.2

Mauro Carvalho Chehab

author

2021-04-09 12:48 UTC #15 lore raw

PATCH v3 8/8 docs: sched-bwc.rst: fix a typo on a doc name

In reply to Mauro Carvalho Chehab

cgroupv2.rst -> cgroup-v2.rst

Signed-off-by Mauro Carvalho Chehab <[email protected]>

---
 Documentation/scheduler/sched-bwc.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Documentation/scheduler/sched-bwc.rst +1 -1

index 845eee659199..1fc73555f5c4 100644
@@ -29,7 +29,7 @@ Quota and period are managed within the cpu subsystem via cgroupfs.
 .. note::
    The cgroupfs files described in this section are only applicable
    to cgroup v1. For cgroup v2, see
-   :ref:`Documentation/admin-guide/cgroupv2.rst <cgroup-v2-cpu>`.
+   :ref:`Documentation/admin-guide/cgroup-v2.rst <cgroup-v2-cpu>`.
 
 - cpu.cfs_quota_us: the total available run-time within a period (in
   microseconds)

Signature · 1 line

2.30.2