[PATCH 0/8] kvx documentation improv (was: Re: [RFC PATCH 01/25] Documentation: kvx: Add basic documentation)

Bagas Sanjaya posted 8 patches 2 years, 8 months ago
Documentation/arch.rst               |   1 +
Documentation/kvx/index.rst          |  12 ++
Documentation/kvx/kvx-exceptions.rst | 258 +++++++++++++++++++++++
Documentation/kvx/kvx-exceptions.txt | 246 ----------------------
Documentation/kvx/kvx-iommu.rst      | 188 +++++++++++++++++
Documentation/kvx/kvx-iommu.txt      | 183 -----------------
Documentation/kvx/kvx-mmu.rst        | 294 +++++++++++++++++++++++++++
Documentation/kvx/kvx-mmu.txt        | 272 -------------------------
Documentation/kvx/kvx-smp.rst        |  36 ++++
Documentation/kvx/kvx-smp.txt        |  36 ----
Documentation/kvx/kvx.rst            | 269 ++++++++++++++++++++++++
Documentation/kvx/kvx.txt            | 268 ------------------------
12 files changed, 1058 insertions(+), 1005 deletions(-)
create mode 100644 Documentation/kvx/index.rst
create mode 100644 Documentation/kvx/kvx-exceptions.rst
delete mode 100644 Documentation/kvx/kvx-exceptions.txt
create mode 100644 Documentation/kvx/kvx-iommu.rst
delete mode 100644 Documentation/kvx/kvx-iommu.txt
create mode 100644 Documentation/kvx/kvx-mmu.rst
delete mode 100644 Documentation/kvx/kvx-mmu.txt
create mode 100644 Documentation/kvx/kvx-smp.rst
delete mode 100644 Documentation/kvx/kvx-smp.txt
create mode 100644 Documentation/kvx/kvx.rst
delete mode 100644 Documentation/kvx/kvx.txt
[PATCH 0/8] kvx documentation improv (was: Re: [RFC PATCH 01/25] Documentation: kvx: Add basic documentation)
Posted by Bagas Sanjaya 2 years, 8 months ago
Jonathan Corbet <corbet@lwn.net> writes:
>> Add some documentation for kvx arch and its Linux port.
>>
>> CC: Jonathan Corbet <corbet@lwn.net>
>> CC: linux-doc@vger.kernel.org
>> CC: linux-kernel@vger.kernel.org
>> Co-developed-by: Clement Leger <clement.leger@bootlin.com>
>> Signed-off-by: Clement Leger <clement.leger@bootlin.com>
>> Co-developed-by: Guillaume Thouvenin <gthouvenin@kalray.eu>
>> Signed-off-by: Guillaume Thouvenin <gthouvenin@kalray.eu>
>> Signed-off-by: Yann Sionneau <ysionneau@kalray.eu>
>> ---
>>  Documentation/kvx/kvx-exceptions.txt | 246 ++++++++++++++++++++++++
>>  Documentation/kvx/kvx-iommu.txt      | 183 ++++++++++++++++++
>>  Documentation/kvx/kvx-mmu.txt        | 272 +++++++++++++++++++++++++++
>>  Documentation/kvx/kvx-smp.txt        |  36 ++++
>>  Documentation/kvx/kvx.txt            | 268 ++++++++++++++++++++++++++
>>  5 files changed, 1005 insertions(+)
>>  create mode 100644 Documentation/kvx/kvx-exceptions.txt
>>  create mode 100644 Documentation/kvx/kvx-iommu.txt
>>  create mode 100644 Documentation/kvx/kvx-mmu.txt
>>  create mode 100644 Documentation/kvx/kvx-smp.txt
>>  create mode 100644 Documentation/kvx/kvx.txt
>
>Please write this documentation in the RST format (you're 95% of the way
>there now) and incorporate into the kernel docs build.

Here is the polished documentation in reST format. Yann, can you please
squash this series into your documentation patch?

Bagas Sanjaya (8):
  Documentation: kvx: Convert to reST
  Documentation: kvx: Wrap diagrams in literal code block
  Documentation: kvx: Fix lists
  Documentation: kvx: kvx-iommu: Use reST syntax for subsections
  Documentation: kvx: kvx-iommu: monospacize kvx iommu device tree path
  Documentation: kvx: Promote title headings
  Documentation: kvx: Use literal code block for command-line inputs
  Documentation: kvx: reword

 Documentation/arch.rst               |   1 +
 Documentation/kvx/index.rst          |  12 ++
 Documentation/kvx/kvx-exceptions.rst | 258 +++++++++++++++++++++++
 Documentation/kvx/kvx-exceptions.txt | 246 ----------------------
 Documentation/kvx/kvx-iommu.rst      | 188 +++++++++++++++++
 Documentation/kvx/kvx-iommu.txt      | 183 -----------------
 Documentation/kvx/kvx-mmu.rst        | 294 +++++++++++++++++++++++++++
 Documentation/kvx/kvx-mmu.txt        | 272 -------------------------
 Documentation/kvx/kvx-smp.rst        |  36 ++++
 Documentation/kvx/kvx-smp.txt        |  36 ----
 Documentation/kvx/kvx.rst            | 269 ++++++++++++++++++++++++
 Documentation/kvx/kvx.txt            | 268 ------------------------
 12 files changed, 1058 insertions(+), 1005 deletions(-)
 create mode 100644 Documentation/kvx/index.rst
 create mode 100644 Documentation/kvx/kvx-exceptions.rst
 delete mode 100644 Documentation/kvx/kvx-exceptions.txt
 create mode 100644 Documentation/kvx/kvx-iommu.rst
 delete mode 100644 Documentation/kvx/kvx-iommu.txt
 create mode 100644 Documentation/kvx/kvx-mmu.rst
 delete mode 100644 Documentation/kvx/kvx-mmu.txt
 create mode 100644 Documentation/kvx/kvx-smp.rst
 delete mode 100644 Documentation/kvx/kvx-smp.txt
 create mode 100644 Documentation/kvx/kvx.rst
 delete mode 100644 Documentation/kvx/kvx.txt

-- 
An old man doll... just what I always wanted! - Clara
Re: [PATCH 0/8] kvx documentation improv (was: Re: [RFC PATCH 01/25] Documentation: kvx: Add basic documentation)
Posted by Jules Maselbas 2 years, 8 months ago
Hi Bagas,

On Mon, Jan 09, 2023 at 04:51:00PM +0700, Bagas Sanjaya wrote:
> Jonathan Corbet <corbet@lwn.net> writes:
> >> Add some documentation for kvx arch and its Linux port.
> >>
> >> CC: Jonathan Corbet <corbet@lwn.net>
> >> CC: linux-doc@vger.kernel.org
> >> CC: linux-kernel@vger.kernel.org
> >> Co-developed-by: Clement Leger <clement.leger@bootlin.com>
> >> Signed-off-by: Clement Leger <clement.leger@bootlin.com>
> >> Co-developed-by: Guillaume Thouvenin <gthouvenin@kalray.eu>
> >> Signed-off-by: Guillaume Thouvenin <gthouvenin@kalray.eu>
> >> Signed-off-by: Yann Sionneau <ysionneau@kalray.eu>
> >> ---
> >>  Documentation/kvx/kvx-exceptions.txt | 246 ++++++++++++++++++++++++
> >>  Documentation/kvx/kvx-iommu.txt      | 183 ++++++++++++++++++
> >>  Documentation/kvx/kvx-mmu.txt        | 272 +++++++++++++++++++++++++++
> >>  Documentation/kvx/kvx-smp.txt        |  36 ++++
> >>  Documentation/kvx/kvx.txt            | 268 ++++++++++++++++++++++++++
> >>  5 files changed, 1005 insertions(+)
> >>  create mode 100644 Documentation/kvx/kvx-exceptions.txt
> >>  create mode 100644 Documentation/kvx/kvx-iommu.txt
> >>  create mode 100644 Documentation/kvx/kvx-mmu.txt
> >>  create mode 100644 Documentation/kvx/kvx-smp.txt
> >>  create mode 100644 Documentation/kvx/kvx.txt
> >
> >Please write this documentation in the RST format (you're 95% of the way
> >there now) and incorporate into the kernel docs build.
> 
> Here is the polished documentation in reST format. Yann, can you please
> squash this series into your documentation patch?
Thanks a lot, I've already converted the documentation to reST, but I will
take a look at this series and see what I can apply.

> Bagas Sanjaya (8):
>   Documentation: kvx: Convert to reST
>   Documentation: kvx: Wrap diagrams in literal code block
>   Documentation: kvx: Fix lists
>   Documentation: kvx: kvx-iommu: Use reST syntax for subsections
>   Documentation: kvx: kvx-iommu: monospacize kvx iommu device tree path
>   Documentation: kvx: Promote title headings
>   Documentation: kvx: Use literal code block for command-line inputs
>   Documentation: kvx: reword
> 
>  Documentation/arch.rst               |   1 +
>  Documentation/kvx/index.rst          |  12 ++
>  Documentation/kvx/kvx-exceptions.rst | 258 +++++++++++++++++++++++
>  Documentation/kvx/kvx-exceptions.txt | 246 ----------------------
>  Documentation/kvx/kvx-iommu.rst      | 188 +++++++++++++++++
>  Documentation/kvx/kvx-iommu.txt      | 183 -----------------
>  Documentation/kvx/kvx-mmu.rst        | 294 +++++++++++++++++++++++++++
>  Documentation/kvx/kvx-mmu.txt        | 272 -------------------------
>  Documentation/kvx/kvx-smp.rst        |  36 ++++
>  Documentation/kvx/kvx-smp.txt        |  36 ----
>  Documentation/kvx/kvx.rst            | 269 ++++++++++++++++++++++++
>  Documentation/kvx/kvx.txt            | 268 ------------------------
>  12 files changed, 1058 insertions(+), 1005 deletions(-)
>  create mode 100644 Documentation/kvx/index.rst
>  create mode 100644 Documentation/kvx/kvx-exceptions.rst
>  delete mode 100644 Documentation/kvx/kvx-exceptions.txt
>  create mode 100644 Documentation/kvx/kvx-iommu.rst
>  delete mode 100644 Documentation/kvx/kvx-iommu.txt
>  create mode 100644 Documentation/kvx/kvx-mmu.rst
>  delete mode 100644 Documentation/kvx/kvx-mmu.txt
>  create mode 100644 Documentation/kvx/kvx-smp.rst
>  delete mode 100644 Documentation/kvx/kvx-smp.txt
>  create mode 100644 Documentation/kvx/kvx.rst
>  delete mode 100644 Documentation/kvx/kvx.txt
> 
> -- 
> An old man doll... just what I always wanted! - Clara
> 
> 
> 
> 
>
Re: [PATCH 0/8] kvx documentation improv (was: Re: [RFC PATCH 01/25] Documentation: kvx: Add basic documentation)
Posted by Randy Dunlap 2 years, 8 months ago
Hi Bagas,

On 1/9/23 01:51, Bagas Sanjaya wrote:
> Jonathan Corbet <corbet@lwn.net> writes:
>>> Add some documentation for kvx arch and its Linux port.
>>>
...
>>
>> Please write this documentation in the RST format (you're 95% of the way
>> there now) and incorporate into the kernel docs build.
> 
> Here is the polished documentation in reST format. Yann, can you please
> squash this series into your documentation patch?

JFYI, to me "improv" applies mostly to jazz (music) or comedy. :)

https://www.merriam-webster.com/dictionary/improv
https://en.wikipedia.org/wiki/Improv

Thanks for the patches.

-- 
~Randy