| Message ID | 20210325164713.1296407-6-robh@kernel.org |
|---|---|
| State | New |
| Headers | show |
| Series | dt: doc build improvements and kerneldoc addition | expand |
Em Thu, 25 Mar 2021 10:47:10 -0600 Rob Herring <robh@kernel.org> escreveu: > The DT docs are currently all just lumped together in the doc build. > Let's organize the documents by kernel specifics, overlays and bindings. > > As writing-schema.rst is about bindings, let's move it to the bindings > directory. > > Cc: Frank Rowand <frowand.list@gmail.com> > Cc: Mauro Carvalho Chehab <mchehab@kernel.org> Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> > Signed-off-by: Rob Herring <robh@kernel.org> > --- > Documentation/devicetree/bindings/index.rst | 7 ++----- > .../devicetree/{ => bindings}/writing-schema.rst | 0 > Documentation/devicetree/index.rst | 16 ++++++++++++++-- > 3 files changed, 16 insertions(+), 7 deletions(-) > rename Documentation/devicetree/{ => bindings}/writing-schema.rst (100%) > > diff --git a/Documentation/devicetree/bindings/index.rst b/Documentation/devicetree/bindings/index.rst > index 3837b17c234f..d9002a3a0abb 100644 > --- a/Documentation/devicetree/bindings/index.rst > +++ b/Documentation/devicetree/bindings/index.rst > @@ -1,12 +1,9 @@ > .. SPDX-License-Identifier: GPL-2.0 > > -=========== > -Device Tree > -=========== > - > .. toctree:: > :maxdepth: 1 > > ABI > - submitting-patches > writing-bindings > + writing-schema > + submitting-patches > diff --git a/Documentation/devicetree/writing-schema.rst b/Documentation/devicetree/bindings/writing-schema.rst > similarity index 100% > rename from Documentation/devicetree/writing-schema.rst > rename to Documentation/devicetree/bindings/writing-schema.rst > diff --git a/Documentation/devicetree/index.rst b/Documentation/devicetree/index.rst > index 32509e8de8da..70b5dcdbcf07 100644 > --- a/Documentation/devicetree/index.rst > +++ b/Documentation/devicetree/index.rst > @@ -4,14 +4,26 @@ > Open Firmware and Devicetree > ============================= > > +Kernel Devicetree Usage > +======================= > .. toctree:: > :maxdepth: 1 > > usage-model > - writing-schema > + of_unittest > + > +Devicetree Overlays > +=================== > +.. toctree:: > + :maxdepth: 1 > + > changesets > dynamic-resolution-notes > - of_unittest > overlay-notes > > +Devicetree Bindings > +=================== > +.. toctree:: > + :maxdepth: 1 > + > bindings/index Thanks, Mauro
diff --git a/Documentation/devicetree/bindings/index.rst b/Documentation/devicetree/bindings/index.rst index 3837b17c234f..d9002a3a0abb 100644 --- a/Documentation/devicetree/bindings/index.rst +++ b/Documentation/devicetree/bindings/index.rst @@ -1,12 +1,9 @@ .. SPDX-License-Identifier: GPL-2.0 -=========== -Device Tree -=========== - .. toctree:: :maxdepth: 1 ABI - submitting-patches writing-bindings + writing-schema + submitting-patches diff --git a/Documentation/devicetree/writing-schema.rst b/Documentation/devicetree/bindings/writing-schema.rst similarity index 100% rename from Documentation/devicetree/writing-schema.rst rename to Documentation/devicetree/bindings/writing-schema.rst diff --git a/Documentation/devicetree/index.rst b/Documentation/devicetree/index.rst index 32509e8de8da..70b5dcdbcf07 100644 --- a/Documentation/devicetree/index.rst +++ b/Documentation/devicetree/index.rst @@ -4,14 +4,26 @@ Open Firmware and Devicetree ============================= +Kernel Devicetree Usage +======================= .. toctree:: :maxdepth: 1 usage-model - writing-schema + of_unittest + +Devicetree Overlays +=================== +.. toctree:: + :maxdepth: 1 + changesets dynamic-resolution-notes - of_unittest overlay-notes +Devicetree Bindings +=================== +.. toctree:: + :maxdepth: 1 + bindings/index
The DT docs are currently all just lumped together in the doc build. Let's organize the documents by kernel specifics, overlays and bindings. As writing-schema.rst is about bindings, let's move it to the bindings directory. Cc: Frank Rowand <frowand.list@gmail.com> Cc: Mauro Carvalho Chehab <mchehab@kernel.org> Signed-off-by: Rob Herring <robh@kernel.org> --- Documentation/devicetree/bindings/index.rst | 7 ++----- .../devicetree/{ => bindings}/writing-schema.rst | 0 Documentation/devicetree/index.rst | 16 ++++++++++++++-- 3 files changed, 16 insertions(+), 7 deletions(-) rename Documentation/devicetree/{ => bindings}/writing-schema.rst (100%) -- 2.27.0