diff mbox series

coresight: docs: Fix a broken reference

Message ID c7f864854e9e03916017712017ff59132c51c338.1659251193.git.christophe.jaillet@wanadoo.fr (mailing list archive)
State New, archived
Headers show
Series coresight: docs: Fix a broken reference | expand

Commit Message

Christophe JAILLET July 31, 2022, 7:06 a.m. UTC
Since the commit in Fixes: tag, "coresight-cpu-debug.txt" has been turned
into "arm,coresight-cpu-debug.yaml".

Update the doc accordingly to avoid a 'make htmldocs' warning

Fixes: 66d052047ca8 ("dt-bindings: arm: Convert CoreSight CPU debug to DT schema")
Signed-off-by: Christophe JAILLET <christophe.jaillet@wanadoo.fr>
---
 Documentation/trace/coresight/coresight-cpu-debug.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

James Clark Aug. 3, 2022, 3:31 p.m. UTC | #1
On 31/07/2022 08:06, Christophe JAILLET wrote:
> Since the commit in Fixes: tag, "coresight-cpu-debug.txt" has been turned
> into "arm,coresight-cpu-debug.yaml".
> 
> Update the doc accordingly to avoid a 'make htmldocs' warning
> 
> Fixes: 66d052047ca8 ("dt-bindings: arm: Convert CoreSight CPU debug to DT schema")
> Signed-off-by: Christophe JAILLET <christophe.jaillet@wanadoo.fr>
> ---
>  Documentation/trace/coresight/coresight-cpu-debug.rst | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/trace/coresight/coresight-cpu-debug.rst b/Documentation/trace/coresight/coresight-cpu-debug.rst
> index 993dd294b81b..836b35532667 100644
> --- a/Documentation/trace/coresight/coresight-cpu-debug.rst
> +++ b/Documentation/trace/coresight/coresight-cpu-debug.rst
> @@ -117,7 +117,8 @@ divide into below cases:
>  Device Tree Bindings
>  --------------------
>  
> -See Documentation/devicetree/bindings/arm/coresight-cpu-debug.txt for details.
> +See Documentation/devicetree/bindings/arm/arm,coresight-cpu-debug.yaml for
> +details.

LGTM, thanks

Reviewed-by: James Clark <james.clark@arm.com>
>  
>  
>  How to use the module
Mathieu Poirier Aug. 22, 2022, 4:02 p.m. UTC | #2
On Sun, Jul 31, 2022 at 09:06:48AM +0200, Christophe JAILLET wrote:
> Since the commit in Fixes: tag, "coresight-cpu-debug.txt" has been turned
> into "arm,coresight-cpu-debug.yaml".
> 
> Update the doc accordingly to avoid a 'make htmldocs' warning
> 
> Fixes: 66d052047ca8 ("dt-bindings: arm: Convert CoreSight CPU debug to DT schema")
> Signed-off-by: Christophe JAILLET <christophe.jaillet@wanadoo.fr>
> ---
>  Documentation/trace/coresight/coresight-cpu-debug.rst | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 

Applied.

Thanks,
Mathieu

> diff --git a/Documentation/trace/coresight/coresight-cpu-debug.rst b/Documentation/trace/coresight/coresight-cpu-debug.rst
> index 993dd294b81b..836b35532667 100644
> --- a/Documentation/trace/coresight/coresight-cpu-debug.rst
> +++ b/Documentation/trace/coresight/coresight-cpu-debug.rst
> @@ -117,7 +117,8 @@ divide into below cases:
>  Device Tree Bindings
>  --------------------
>  
> -See Documentation/devicetree/bindings/arm/coresight-cpu-debug.txt for details.
> +See Documentation/devicetree/bindings/arm/arm,coresight-cpu-debug.yaml for
> +details.
>  
>  
>  How to use the module
> -- 
> 2.34.1
>
Suzuki K Poulose Sept. 12, 2022, 9:52 a.m. UTC | #3
Cc: acme

On 22/08/2022 17:02, Mathieu Poirier wrote:
> On Sun, Jul 31, 2022 at 09:06:48AM +0200, Christophe JAILLET wrote:
>> Since the commit in Fixes: tag, "coresight-cpu-debug.txt" has been turned
>> into "arm,coresight-cpu-debug.yaml".
>>
>> Update the doc accordingly to avoid a 'make htmldocs' warning
>>
>> Fixes: 66d052047ca8 ("dt-bindings: arm: Convert CoreSight CPU debug to DT schema")
>> Signed-off-by: Christophe JAILLET <christophe.jaillet@wanadoo.fr>
>> ---
>>   Documentation/trace/coresight/coresight-cpu-debug.rst | 3 ++-
>>   1 file changed, 2 insertions(+), 1 deletion(-)
>>
> 
> Applied.

fyi, there is another patch fixing the same here.

https://lkml.kernel.org/r/20815dbff3d27f5d3e6876363f052d2a08ad2e72.1660829433.git.mchehab@kernel.org

We may have to decide which one goes in.

Cheers
Suzuki

> 
> Thanks,
> Mathieu
> 
>> diff --git a/Documentation/trace/coresight/coresight-cpu-debug.rst b/Documentation/trace/coresight/coresight-cpu-debug.rst
>> index 993dd294b81b..836b35532667 100644
>> --- a/Documentation/trace/coresight/coresight-cpu-debug.rst
>> +++ b/Documentation/trace/coresight/coresight-cpu-debug.rst
>> @@ -117,7 +117,8 @@ divide into below cases:
>>   Device Tree Bindings
>>   --------------------
>>   
>> -See Documentation/devicetree/bindings/arm/coresight-cpu-debug.txt for details.
>> +See Documentation/devicetree/bindings/arm/arm,coresight-cpu-debug.yaml for
>> +details.
>>   
>>   
>>   How to use the module
>> -- 
>> 2.34.1
>>
Mathieu Poirier Sept. 19, 2022, 7:54 p.m. UTC | #4
On Mon, Sep 12, 2022 at 10:52:30AM +0100, Suzuki K Poulose wrote:
> Cc: acme
> 
> On 22/08/2022 17:02, Mathieu Poirier wrote:
> > On Sun, Jul 31, 2022 at 09:06:48AM +0200, Christophe JAILLET wrote:
> > > Since the commit in Fixes: tag, "coresight-cpu-debug.txt" has been turned
> > > into "arm,coresight-cpu-debug.yaml".
> > > 
> > > Update the doc accordingly to avoid a 'make htmldocs' warning
> > > 
> > > Fixes: 66d052047ca8 ("dt-bindings: arm: Convert CoreSight CPU debug to DT schema")
> > > Signed-off-by: Christophe JAILLET <christophe.jaillet@wanadoo.fr>
> > > ---
> > >   Documentation/trace/coresight/coresight-cpu-debug.rst | 3 ++-
> > >   1 file changed, 2 insertions(+), 1 deletion(-)
> > > 
> > 
> > Applied.
> 
> fyi, there is another patch fixing the same here.
> 
> https://lkml.kernel.org/r/20815dbff3d27f5d3e6876363f052d2a08ad2e72.1660829433.git.mchehab@kernel.org
> 
> We may have to decide which one goes in.
>

Thanks for pointing that out.  I looked in the documentation's next tree[1] and the
patch hasn't been added there.  As such I suggest to keep Christophe's patch.

Regards,
Mathieu

[1]. git://git.lwn.net/linux.git docs-next

> Cheers
> Suzuki
> 
> > 
> > Thanks,
> > Mathieu
> > 
> > > diff --git a/Documentation/trace/coresight/coresight-cpu-debug.rst b/Documentation/trace/coresight/coresight-cpu-debug.rst
> > > index 993dd294b81b..836b35532667 100644
> > > --- a/Documentation/trace/coresight/coresight-cpu-debug.rst
> > > +++ b/Documentation/trace/coresight/coresight-cpu-debug.rst
> > > @@ -117,7 +117,8 @@ divide into below cases:
> > >   Device Tree Bindings
> > >   --------------------
> > > -See Documentation/devicetree/bindings/arm/coresight-cpu-debug.txt for details.
> > > +See Documentation/devicetree/bindings/arm/arm,coresight-cpu-debug.yaml for
> > > +details.
> > >   How to use the module
> > > -- 
> > > 2.34.1
> > > 
>
diff mbox series

Patch

diff --git a/Documentation/trace/coresight/coresight-cpu-debug.rst b/Documentation/trace/coresight/coresight-cpu-debug.rst
index 993dd294b81b..836b35532667 100644
--- a/Documentation/trace/coresight/coresight-cpu-debug.rst
+++ b/Documentation/trace/coresight/coresight-cpu-debug.rst
@@ -117,7 +117,8 @@  divide into below cases:
 Device Tree Bindings
 --------------------
 
-See Documentation/devicetree/bindings/arm/coresight-cpu-debug.txt for details.
+See Documentation/devicetree/bindings/arm/arm,coresight-cpu-debug.yaml for
+details.
 
 
 How to use the module