[PATCH v3 00/23] Fix some issues at documentation

[PATCH v3 00/23] Fix some issues at documentation

[Mauro Carvalho Chehab]

Hi Jon,

This series is against today's next (next-20211019) and addresses missing
links to Documentation/*.

The best would be to have the patches applied directly to the trees that
contain the patches that moved/renamed files, and then apply the
remaining ones either later during the merge window or just afterwards,
whatever works best for you.

Regards,
Mauro

Mauro Carvalho Chehab (23):
  visorbus: fix a copyright symbol that was bad encoded
  libbpf: update index.rst reference
  docs: accounting: update delay-accounting.rst reference
  MAINTAINERS: update arm,vic.yaml reference
  MAINTAINERS: update aspeed,i2c.yaml reference
  MAINTAINERS: update faraday,ftrtc010.yaml reference
  MAINTAINERS: update ti,sci.yaml reference
  MAINTAINERS: update intel,ixp46x-rng.yaml reference
  MAINTAINERS: update nxp,imx8-jpeg.yaml reference
  MAINTAINERS: update gemini.yaml reference
  MAINTAINERS: update brcm,unimac-mdio.yaml reference
  MAINTAINERS: update mtd-physmap.yaml reference
  Documentation: update vcpu-requests.rst reference
  bpftool: update bpftool-cgroup.rst reference
  docs: translations: zn_CN: irq-affinity.rst: add a missing extension
  docs: translations: zh_CN: memory-hotplug.rst: fix a typo
  docs: fs: locks.rst: update comment about mandatory file locking
  fs: remove a comment pointing to the removed mandatory-locking file
  Documentation/process: fix a cross reference
  dt-bindings: mfd: update x-powers,axp152.yaml reference
  regulator: dt-bindings: update samsung,s2mpa01.yaml reference
  regulator: dt-bindings: update samsung,s5m8767.yaml reference
  dt-bindings: reserved-memory: ramoops: update ramoops.yaml references

 Documentation/admin-guide/ramoops.rst         |  2 +-
 Documentation/admin-guide/sysctl/kernel.rst   |  2 +-
 Documentation/bpf/index.rst                   |  2 +-
 .../devicetree/bindings/gpio/gpio-axp209.txt  |  2 +-
 .../bindings/regulator/samsung,s2mpa01.yaml   |  2 +-
 .../bindings/regulator/samsung,s5m8767.yaml   |  2 +-
 Documentation/filesystems/locks.rst           | 17 +++++-----------
 Documentation/process/submitting-patches.rst  |  4 ++--
 .../zh_CN/core-api/irq/irq-affinity.rst       |  2 +-
 .../zh_CN/core-api/memory-hotplug.rst         |  2 +-
 MAINTAINERS                                   | 20 +++++++++----------
 arch/riscv/kvm/vcpu.c                         |  2 +-
 drivers/visorbus/visorbus_main.c              |  2 +-
 fs/locks.c                                    |  1 -
 .../selftests/bpf/test_bpftool_synctypes.py   |  2 +-
 15 files changed, 28 insertions(+), 36 deletions(-)

-- 
2.31.1

[PATCH v3 21/23] regulator: dt-bindings: update samsung,s2mpa01.yaml reference

[Mauro Carvalho Chehab]

The file name: Documentation/devicetree/bindings/mfd/samsung,s2mpa01.yaml
should be, instead: Documentation/devicetree/bindings/regulator/samsung,s2mpa01.yaml.

Update its cross-reference accordingly.

Fixes: a52afb0f54fa ("regulator: dt-bindings: samsung,s2mpa01: convert to dtschema")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---

To mailbombing on a large number of people, only mailing lists were C/C on the cover.
See [PATCH v3 00/23] at: https://lore.kernel.org/all/cover.1634630485.git.mchehab+huawei@kernel.org/

 .../devicetree/bindings/regulator/samsung,s2mpa01.yaml          | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/devicetree/bindings/regulator/samsung,s2mpa01.yaml b/Documentation/devicetree/bindings/regulator/samsung,s2mpa01.yaml
index 0627dec513da..0a564319f4b2 100644
--- a/Documentation/devicetree/bindings/regulator/samsung,s2mpa01.yaml
+++ b/Documentation/devicetree/bindings/regulator/samsung,s2mpa01.yaml
@@ -15,7 +15,7 @@ description: |
 
   The S2MPA01 provides buck and LDO regulators.
 
-  See also Documentation/devicetree/bindings/mfd/samsung,s2mpa01.yaml for
+  See also Documentation/devicetree/bindings/regulator/samsung,s2mpa01.yaml for
   additional information and example.
 
 patternProperties:
-- 
2.31.1

[PATCH v3 22/23] regulator: dt-bindings: update samsung,s5m8767.yaml reference

[Mauro Carvalho Chehab]

The file name: Documentation/devicetree/bindings/mfd/samsung,s5m8767.yaml
should be, instead: Documentation/devicetree/bindings/regulator/samsung,s5m8767.yaml.

Update its cross-reference accordingly.

Fixes: fab58debc137 ("regulator: dt-bindings: samsung,s5m8767: convert to dtschema")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---

To mailbombing on a large number of people, only mailing lists were C/C on the cover.
See [PATCH v3 00/23] at: https://lore.kernel.org/all/cover.1634630485.git.mchehab+huawei@kernel.org/

 .../devicetree/bindings/regulator/samsung,s5m8767.yaml          | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/devicetree/bindings/regulator/samsung,s5m8767.yaml b/Documentation/devicetree/bindings/regulator/samsung,s5m8767.yaml
index 80a63d47790a..4281f670c775 100644
--- a/Documentation/devicetree/bindings/regulator/samsung,s5m8767.yaml
+++ b/Documentation/devicetree/bindings/regulator/samsung,s5m8767.yaml
@@ -15,7 +15,7 @@ description: |
 
   The S5M8767 provides buck and LDO regulators.
 
-  See also Documentation/devicetree/bindings/mfd/samsung,s5m8767.yaml for
+  See also Documentation/devicetree/bindings/regulator/samsung,s5m8767.yaml for
   additional information and example.
 
 patternProperties:
-- 
2.31.1

Re: [PATCH v3 21/23] regulator: dt-bindings: update samsung,s2mpa01.yaml reference

[Krzysztof Kozlowski]

On 19/10/2021 10:04, Mauro Carvalho Chehab wrote:
> The file name: Documentation/devicetree/bindings/mfd/samsung,s2mpa01.yaml
> should be, instead: Documentation/devicetree/bindings/regulator/samsung,s2mpa01.yaml.
> 
> Update its cross-reference accordingly.
> 
> Fixes: a52afb0f54fa ("regulator: dt-bindings: samsung,s2mpa01: convert to dtschema")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> 
> To mailbombing on a large number of people, only mailing lists were C/C on the cover.
> See [PATCH v3 00/23] at: https://lore.kernel.org/all/cover.1634630485.git.mchehab+huawei@kernel.org/
> 
>  .../devicetree/bindings/regulator/samsung,s2mpa01.yaml          | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/devicetree/bindings/regulator/samsung,s2mpa01.yaml b/Documentation/devicetree/bindings/regulator/samsung,s2mpa01.yaml
> index 0627dec513da..0a564319f4b2 100644
> --- a/Documentation/devicetree/bindings/regulator/samsung,s2mpa01.yaml
> +++ b/Documentation/devicetree/bindings/regulator/samsung,s2mpa01.yaml
> @@ -15,7 +15,7 @@ description: |
>  
>    The S2MPA01 provides buck and LDO regulators.
>  
> -  See also Documentation/devicetree/bindings/mfd/samsung,s2mpa01.yaml for
> +  See also Documentation/devicetree/bindings/regulator/samsung,s2mpa01.yaml for
>    additional information and example.
>  

Hi Mauro,

Thanks for the patch but it is incorrect. Old path is proper, just the
patch waits on merging.

For this one: NAK.

Best regards,
Krzysztof

Re: [PATCH v3 22/23] regulator: dt-bindings: update samsung,s5m8767.yaml reference

[Krzysztof Kozlowski]

On 19/10/2021 10:04, Mauro Carvalho Chehab wrote:
> The file name: Documentation/devicetree/bindings/mfd/samsung,s5m8767.yaml
> should be, instead: Documentation/devicetree/bindings/regulator/samsung,s5m8767.yaml.
> 
> Update its cross-reference accordingly.
> 
> Fixes: fab58debc137 ("regulator: dt-bindings: samsung,s5m8767: convert to dtschema")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> 
> To mailbombing on a large number of people, only mailing lists were C/C on the cover.
> See [PATCH v3 00/23] at: https://lore.kernel.org/all/cover.1634630485.git.mchehab+huawei@kernel.org/
> 
>  .../devicetree/bindings/regulator/samsung,s5m8767.yaml          | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/devicetree/bindings/regulator/samsung,s5m8767.yaml b/Documentation/devicetree/bindings/regulator/samsung,s5m8767.yaml
> index 80a63d47790a..4281f670c775 100644
> --- a/Documentation/devicetree/bindings/regulator/samsung,s5m8767.yaml
> +++ b/Documentation/devicetree/bindings/regulator/samsung,s5m8767.yaml
> @@ -15,7 +15,7 @@ description: |
>  
>    The S5M8767 provides buck and LDO regulators.
>  
> -  See also Documentation/devicetree/bindings/mfd/samsung,s5m8767.yaml for
> +  See also Documentation/devicetree/bindings/regulator/samsung,s5m8767.yaml for
>    additional information and example.
>  
>  patternProperties:
> 


Hi Mauro,

Thanks for the patch but it is incorrect. Old path is proper, just the
patch waits on merging.

For this one: NAK.

Best regards,
Krzysztof

Re: [PATCH v3 21/23] regulator: dt-bindings: update samsung,s2mpa01.yaml reference

[Mark Brown]

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

On Tue, Oct 19, 2021 at 09:04:20AM +0100, Mauro Carvalho Chehab wrote:

> To mailbombing on a large number of people, only mailing lists were C/C on the cover.
> See [PATCH v3 00/23] at: https://lore.kernel.org/all/cover.1634630485.git.mchehab+huawei@kernel.org/

It'd be a bit easier to put a note in here about what the dependencies
are rather than forcing people to go out to a link to figure out what's
going on unless it's complicated.  For a case like this where there's no
dependencies or real relationship between the patches it's probably
better to just not thread everything and send the patches separately to
everyone, the threading is just adding noise and confusion.

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

Re: [PATCH v3 00/23] Fix some issues at documentation

[Rob Herring]

On Tue, 19 Oct 2021 09:03:59 +0100, Mauro Carvalho Chehab wrote:
> Hi Jon,
> 
> This series is against today's next (next-20211019) and addresses missing
> links to Documentation/*.
> 
> The best would be to have the patches applied directly to the trees that
> contain the patches that moved/renamed files, and then apply the
> remaining ones either later during the merge window or just afterwards,
> whatever works best for you.
> 
> Regards,
> Mauro
> 
> Mauro Carvalho Chehab (23):
>   visorbus: fix a copyright symbol that was bad encoded
>   libbpf: update index.rst reference
>   docs: accounting: update delay-accounting.rst reference
>   MAINTAINERS: update arm,vic.yaml reference
>   MAINTAINERS: update aspeed,i2c.yaml reference
>   MAINTAINERS: update faraday,ftrtc010.yaml reference
>   MAINTAINERS: update ti,sci.yaml reference
>   MAINTAINERS: update intel,ixp46x-rng.yaml reference
>   MAINTAINERS: update nxp,imx8-jpeg.yaml reference
>   MAINTAINERS: update gemini.yaml reference
>   MAINTAINERS: update brcm,unimac-mdio.yaml reference
>   MAINTAINERS: update mtd-physmap.yaml reference

Applied patches 3-12.

>   Documentation: update vcpu-requests.rst reference
>   bpftool: update bpftool-cgroup.rst reference
>   docs: translations: zn_CN: irq-affinity.rst: add a missing extension
>   docs: translations: zh_CN: memory-hotplug.rst: fix a typo
>   docs: fs: locks.rst: update comment about mandatory file locking
>   fs: remove a comment pointing to the removed mandatory-locking file
>   Documentation/process: fix a cross reference
>   dt-bindings: mfd: update x-powers,axp152.yaml reference
>   regulator: dt-bindings: update samsung,s2mpa01.yaml reference
>   regulator: dt-bindings: update samsung,s5m8767.yaml reference
>   dt-bindings: reserved-memory: ramoops: update ramoops.yaml references

Re: [PATCH v3 21/23] regulator: dt-bindings: update samsung,s2mpa01.yaml reference

[Mauro Carvalho Chehab]

Em Tue, 19 Oct 2021 13:04:59 +0100
Mark Brown <broonie@kernel.org> escreveu:

> On Tue, Oct 19, 2021 at 09:04:20AM +0100, Mauro Carvalho Chehab wrote:
> 
> > To mailbombing on a large number of people, only mailing lists were C/C on the cover.
> > See [PATCH v3 00/23] at: https://lore.kernel.org/all/cover.1634630485.git.mchehab+huawei@kernel.org/  
> 
> It'd be a bit easier to put a note in here about what the dependencies
> are rather than forcing people to go out to a link to figure out what's
> going on unless it's complicated. 
>
> For a case like this where there's no
> dependencies or real relationship between the patches it's probably
> better to just not thread everything and send the patches separately to
> everyone, the threading is just adding noise and confusion.

It is not that easy, unfortunately. On some cases (specially due to
DT binding renames) some patches change the context of a hunk, affecting
a subsequent patch.

I tried a couple of times in the past to send the patches individually,
but that was messier, as there was harder for people to apply them,
as, instead of running b4 just once to get everything, maintainers
would need to apply each patch individually. Also, there were cases
where the patch order would be relevant, due to context changes.

-

Btw, talking about what it would be easier, the best procedure to
adopt is to run:

	./scripts/documentation-file-ref-check 

Before sending/applying patches touching documents.

That would avoid the need of such fixup patches ;-)

Unfortunately, in the specific case of dt-bindings, things are not
that easy, as doc changes usually go via one tree, while references 
to them come from other places.

Regards,
Mauro

Re: [PATCH v3 21/23] regulator: dt-bindings: update samsung,s2mpa01.yaml reference

[Mark Brown]

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

On Wed, Oct 20, 2021 at 07:30:13AM +0100, Mauro Carvalho Chehab wrote:
> Mark Brown <broonie@kernel.org> escreveu:

> > For a case like this where there's no
> > dependencies or real relationship between the patches it's probably
> > better to just not thread everything and send the patches separately to
> > everyone, the threading is just adding noise and confusion.

> It is not that easy, unfortunately. On some cases (specially due to
> DT binding renames) some patches change the context of a hunk, affecting
> a subsequent patch.

If that's the case then the cover letter really needs work to make this
clear, I couldn't tell that there was any risk of dependencies nor would
I expect any for such trivial changes.

> I tried a couple of times in the past to send the patches individually,
> but that was messier, as there was harder for people to apply them,
> as, instead of running b4 just once to get everything, maintainers
> would need to apply each patch individually. Also, there were cases
> where the patch order would be relevant, due to context changes.

You could also send a per subsystem series if there's a concern about it
being hard to pick up individual patches.

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

Re: [PATCH v3 21/23] regulator: dt-bindings: update samsung,s2mpa01.yaml reference

[Rob Herring]

On Wed, Oct 20, 2021 at 07:30:13AM +0100, Mauro Carvalho Chehab wrote:
> Em Tue, 19 Oct 2021 13:04:59 +0100
> Mark Brown <broonie@kernel.org> escreveu:
> 
> > On Tue, Oct 19, 2021 at 09:04:20AM +0100, Mauro Carvalho Chehab wrote:
> > 
> > > To mailbombing on a large number of people, only mailing lists were C/C on the cover.
> > > See [PATCH v3 00/23] at: https://lore.kernel.org/all/cover.1634630485.git.mchehab+huawei@kernel.org/  
> > 
> > It'd be a bit easier to put a note in here about what the dependencies
> > are rather than forcing people to go out to a link to figure out what's
> > going on unless it's complicated. 
> >
> > For a case like this where there's no
> > dependencies or real relationship between the patches it's probably
> > better to just not thread everything and send the patches separately to
> > everyone, the threading is just adding noise and confusion.
> 
> It is not that easy, unfortunately. On some cases (specially due to
> DT binding renames) some patches change the context of a hunk, affecting
> a subsequent patch.

Those should be reduced now. I've been checking the renames since early 
August. July really, but MAINTAINERS was not getting checked initially.


> I tried a couple of times in the past to send the patches individually,
> but that was messier, as there was harder for people to apply them,
> as, instead of running b4 just once to get everything, maintainers
> would need to apply each patch individually. Also, there were cases
> where the patch order would be relevant, due to context changes.

Just spliting between in Linus' tree and only in next would help me. The 
former I know I can just apply.

> Btw, talking about what it would be easier, the best procedure to
> adopt is to run:
> 
> 	./scripts/documentation-file-ref-check 
> 
> Before sending/applying patches touching documents.

Good luck with that. :(

> That would avoid the need of such fixup patches ;-)
> 
> Unfortunately, in the specific case of dt-bindings, things are not
> that easy, as doc changes usually go via one tree, while references 
> to them come from other places.
> 
> Regards,
> Mauro
>