2021-04-01 18:36:49

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 29/32] docs: dt: update writing-schema.rst references

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 <[email protected]>
---
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
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


2021-04-07 06:45:22

by Rob Herring

[permalink] [raw]
Subject: Re: [PATCH 29/32] docs: dt: update writing-schema.rst references

On Thu, Apr 1, 2021 at 7:17 AM Mauro Carvalho Chehab
<[email protected]> 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 <[email protected]>
> ---
> 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
>

2021-04-07 20:30:40

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: Re: [PATCH 29/32] docs: dt: update writing-schema.rst references

Em Tue, 6 Apr 2021 10:04:57 -0500
Rob Herring <[email protected]> escreveu:

> On Thu, Apr 1, 2021 at 7:17 AM Mauro Carvalho Chehab
> <[email protected]> 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 <[email protected]>
> > ---
> > 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

2021-04-07 21:08:07

by Rob Herring

[permalink] [raw]
Subject: Re: [PATCH 29/32] docs: dt: update writing-schema.rst references

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 <[email protected]>
> ---
> Documentation/devicetree/bindings/submitting-patches.rst | 2 +-
> scripts/checkpatch.pl | 2 +-
> 2 files changed, 2 insertions(+), 2 deletions(-)
>

Applied, thanks!