linux-kernel - Re: [PATCH] dt-bindings: mips: Convert plain text file to ReST

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Sat, 21 May 2022 13:24:12 -0700
From:   Soumya Negi <soumya.negi97@...il.com>
To:     Krzysztof Kozlowski <krzysztof.kozlowski@...aro.org>
Cc:     Shuah Khan <skhan@...uxfoundation.org>,
        Thomas Bogendoerfer <tsbogend@...ha.franken.de>,
        Rob Herring <robh+dt@...nel.org>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@...aro.org>,
        linux-kernel-mentees@...ts.linuxfoundation.org,
        linux-mips@...r.kernel.org, devicetree@...r.kernel.org,
        linux-kernel@...r.kernel.org, Greg KH <gregkh@...uxfoundation.org>
Subject: Re: [PATCH] dt-bindings: mips: Convert plain text file to ReST

On Sat, May 21, 2022 at 04:25:07PM +0200, Krzysztof Kozlowski wrote:
> On 21/05/2022 03:56, Soumya Negi wrote:
> > Converts .txt documentation file to ReST format(.rst).
> > 
> > Signed-off-by: Soumya Negi <soumya.negi97@...il.com>
> > ---
> >  .../devicetree/bindings/mips/cpu_irq.rst      | 56 +++++++++++++++++++
> >  1 file changed, 56 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/mips/cpu_irq.rst
> > 
> > diff --git a/Documentation/devicetree/bindings/mips/cpu_irq.rst b/Documentation/devicetree/bindings/mips/cpu_irq.rst
> > new file mode 100644
> > index 000000000000..601cc12caa2a
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/mips/cpu_irq.rst
> > @@ -0,0 +1,56 @@
> > +=============================
> > +MIPS CPU interrupt controller
> > +=============================
> > +
> > +On MIPS the ``mips_cpu_irq_of_init()`` helper can be used to initialize the 8 CPU
> > +IRQs from a devicetree file and create a ``irq_domain`` for IRQ controller.
> 
> Bindings is not a place for code. No.
> 
> > +
> > +With the ``irq_domain`` in place we can describe how the 8 IRQs are wired to the
> > +platforms internal interrupt controller cascade.
> > +
> > +Below is an example of a platform describing the cascade inside the devicetree
> > +and the code used to load it inside ``arch_init_irq()``.
> > +
> > +Required properties
> > +-------------------
> > +* compatible: Should be **"mti,cpu-interrupt-controller"**
> 
> If you wanted to add bindings, please use DT schema format (see
> writing-schema, writing-bindings and example-schema files).

Hi, 
I don't want to add bindings. I want to the convert the doc file
Documentation/devicetree/bindings/mips/cpu_irq.txt to ReST file format.

I referred to this page(https://wiki.linuxfoundation.org/lkmp/lkmp_task_list) while
creating the patch. It also mentions exceptions that should be kept as plain text 
files. Does this file count as an exception?

Thanks
Soumya