diff mbox series

[29/32] docs: dt: update writing-schema.rst references

Message ID 7cfddf303f1508d26f90d87546d3812faebfc5ba.1617279356.git.mchehab+huawei@kernel.org
State Accepted
Commit 56ddc4cd4c8f9d65c0ac5544df4645376b327cbc
Headers show
Series None | expand

Commit Message

Mauro Carvalho Chehab April 1, 2021, 12:17 p.m. UTC
Changeset b83db5b84900 ("docs: dt: Group DT docs into relevant sub-sections")
renamed: Documentation/devicetree/writing-schema.rst
to: Documentation/devicetree/bindings/writing-schema.rst.

Update the cross-references accordingly.

Fixes: b83db5b84900 ("docs: dt: Group DT docs into relevant sub-sections")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/devicetree/bindings/submitting-patches.rst | 2 +-
 scripts/checkpatch.pl                                    | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

Comments

Rob Herring April 6, 2021, 3:04 p.m. UTC | #1
On Thu, Apr 1, 2021 at 7:17 AM Mauro Carvalho Chehab
<mchehab+huawei@kernel.org> wrote:
>

> Changeset b83db5b84900 ("docs: dt: Group DT docs into relevant sub-sections")

> renamed: Documentation/devicetree/writing-schema.rst

> to: Documentation/devicetree/bindings/writing-schema.rst.

>

> Update the cross-references accordingly.

>

> Fixes: b83db5b84900 ("docs: dt: Group DT docs into relevant sub-sections")

> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

> ---

>  Documentation/devicetree/bindings/submitting-patches.rst | 2 +-

>  scripts/checkpatch.pl                                    | 2 +-

>  2 files changed, 2 insertions(+), 2 deletions(-)

>

> diff --git a/Documentation/devicetree/bindings/submitting-patches.rst b/Documentation/devicetree/bindings/submitting-patches.rst

> index ee4feb53f8d0..104fa8fb2c17 100644

> --- a/Documentation/devicetree/bindings/submitting-patches.rst

> +++ b/Documentation/devicetree/bindings/submitting-patches.rst

> @@ -25,7 +25,7 @@ I. For patch submitters

>

>         make dt_binding_check

>

> -     See Documentation/devicetree/writing-schema.rst for more details about

> +     See Documentation/devicetree/bindings/writing-schema.rst for more details about


We should make this a rSt link instead.

>       schema and tools setup.

>

>    3) DT binding files should be dual licensed. The preferred license tag is

> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl

> index 4dbda85fd7e5..3870c8a01987 100755

> --- a/scripts/checkpatch.pl

> +++ b/scripts/checkpatch.pl

> @@ -3245,7 +3245,7 @@ sub process {

>                     ($line =~ /^new file mode\s*\d+\s*$/) &&

>                     ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) {

>                         WARN("DT_SCHEMA_BINDING_PATCH",

> -                            "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n");

> +                            "DT bindings should be in DT schema format. See: Documentation/devicetree/bindings/writing-schema.rst\n");

>                 }

>

>  # Check for wrappage within a valid hunk of the file

> --

> 2.30.2

>
Mauro Carvalho Chehab April 7, 2021, 8:06 a.m. UTC | #2
Em Tue, 6 Apr 2021 10:04:57 -0500
Rob Herring <robh+dt@kernel.org> escreveu:

> On Thu, Apr 1, 2021 at 7:17 AM Mauro Carvalho Chehab

> <mchehab+huawei@kernel.org> wrote:

> >

> > Changeset b83db5b84900 ("docs: dt: Group DT docs into relevant sub-sections")

> > renamed: Documentation/devicetree/writing-schema.rst

> > to: Documentation/devicetree/bindings/writing-schema.rst.

> >

> > Update the cross-references accordingly.

> >

> > Fixes: b83db5b84900 ("docs: dt: Group DT docs into relevant sub-sections")

> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

> > ---

> >  Documentation/devicetree/bindings/submitting-patches.rst | 2 +-

> >  scripts/checkpatch.pl                                    | 2 +-

> >  2 files changed, 2 insertions(+), 2 deletions(-)

> >

> > diff --git a/Documentation/devicetree/bindings/submitting-patches.rst b/Documentation/devicetree/bindings/submitting-patches.rst

> > index ee4feb53f8d0..104fa8fb2c17 100644

> > --- a/Documentation/devicetree/bindings/submitting-patches.rst

> > +++ b/Documentation/devicetree/bindings/submitting-patches.rst

> > @@ -25,7 +25,7 @@ I. For patch submitters

> >

> >         make dt_binding_check

> >

> > -     See Documentation/devicetree/writing-schema.rst for more details about

> > +     See Documentation/devicetree/bindings/writing-schema.rst for more details about  

> 

> We should make this a rSt link instead.


It shouldn't be needed, as Documentation/sphinx/automarkup.py has a rule
which converts Documentation/* into a cross reference using this
regex:

	RE_doc = re.compile(r'(\bDocumentation/)?((\.\./)*[\w\-/]+)\.(rst|txt)')


Thanks,
Mauro
Rob Herring (Arm) April 7, 2021, 2:45 p.m. UTC | #3
On Thu, 01 Apr 2021 14:17:49 +0200, Mauro Carvalho Chehab wrote:
> Changeset b83db5b84900 ("docs: dt: Group DT docs into relevant sub-sections")

> renamed: Documentation/devicetree/writing-schema.rst

> to: Documentation/devicetree/bindings/writing-schema.rst.

> 

> Update the cross-references accordingly.

> 

> Fixes: b83db5b84900 ("docs: dt: Group DT docs into relevant sub-sections")

> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

> ---

>  Documentation/devicetree/bindings/submitting-patches.rst | 2 +-

>  scripts/checkpatch.pl                                    | 2 +-

>  2 files changed, 2 insertions(+), 2 deletions(-)

> 


Applied, thanks!
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/submitting-patches.rst b/Documentation/devicetree/bindings/submitting-patches.rst
index ee4feb53f8d0..104fa8fb2c17 100644
--- a/Documentation/devicetree/bindings/submitting-patches.rst
+++ b/Documentation/devicetree/bindings/submitting-patches.rst
@@ -25,7 +25,7 @@  I. For patch submitters
 
        make dt_binding_check
 
-     See Documentation/devicetree/writing-schema.rst for more details about
+     See Documentation/devicetree/bindings/writing-schema.rst for more details about
      schema and tools setup.
 
   3) DT binding files should be dual licensed. The preferred license tag is
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 4dbda85fd7e5..3870c8a01987 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -3245,7 +3245,7 @@  sub process {
 		    ($line =~ /^new file mode\s*\d+\s*$/) &&
 		    ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) {
 			WARN("DT_SCHEMA_BINDING_PATCH",
-			     "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n");
+			     "DT bindings should be in DT schema format. See: Documentation/devicetree/bindings/writing-schema.rst\n");
 		}
 
 # Check for wrappage within a valid hunk of the file