diff mbox series

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

Message ID 9acc235dc4af794d18e1267371944a3955e1fb21.1634630486.git.mchehab+huawei@kernel.org (mailing list archive)
State New
Headers show
Series Fix some issues at documentation | expand

Commit Message

Mauro Carvalho Chehab Oct. 19, 2021, 8:04 a.m. UTC
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(-)

Comments

Krzysztof Kozlowski Oct. 19, 2021, 8:24 a.m. UTC | #1
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
Mark Brown Oct. 19, 2021, 12:04 p.m. UTC | #2
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.
Mauro Carvalho Chehab Oct. 20, 2021, 6:30 a.m. UTC | #3
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
Mark Brown Oct. 20, 2021, 11:04 a.m. UTC | #4
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.
Rob Herring Oct. 27, 2021, 2:59 a.m. UTC | #5
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
>
diff mbox series

Patch

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: