2020-04-08 15:47:46

by Mauro Carvalho Chehab

Subject: [PATCH 31/35] powerpc: docs: cxl.rst: mark two section titles as such

The User API chapter contains two sub-chapters. Mark them as
such.

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/powerpc/cxl.rst | 2 ++
1 file changed, 2 insertions(+)

diff --git a/Documentation/powerpc/cxl.rst b/Documentation/powerpc/cxl.rst
index 920546d81326..d2d77057610e 100644
--- a/Documentation/powerpc/cxl.rst
+++ b/Documentation/powerpc/cxl.rst
@@ -133,6 +133,7 @@ User API
========

1. AFU character devices
+^^^^^^^^^^^^^^^^^^^^^^^^

For AFUs operating in AFU directed mode, two character device
files will be created. /dev/cxl/afu0.0m will correspond to a
@@ -395,6 +396,7 @@ read


2. Card character device (powerVM guest only)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

In a powerVM guest, an extra character device is created for the
card. The device is only used to write (flash) a new image on the
--
2.25.2

2020-04-09 00:39:13

by Andrew Donnellan

Subject: Re: [PATCH 31/35] powerpc: docs: cxl.rst: mark two section titles as such

On 9/4/20 1:46 am, Mauro Carvalho Chehab wrote:
> The User API chapter contains two sub-chapters. Mark them as
> such.
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>

Thanks.

Though the other subsections in this file use ----- rather than ^^^^^,
what's the difference?

Acked-by: Andrew Donnellan <[email protected]>

> ---
> Documentation/powerpc/cxl.rst | 2 ++
> 1 file changed, 2 insertions(+)
>
> diff --git a/Documentation/powerpc/cxl.rst b/Documentation/powerpc/cxl.rst
> index 920546d81326..d2d77057610e 100644
> --- a/Documentation/powerpc/cxl.rst
> +++ b/Documentation/powerpc/cxl.rst
> @@ -133,6 +133,7 @@ User API
> ========
>
> 1. AFU character devices
> +^^^^^^^^^^^^^^^^^^^^^^^^
>
> For AFUs operating in AFU directed mode, two character device
> files will be created. /dev/cxl/afu0.0m will correspond to a
> @@ -395,6 +396,7 @@ read
>
>
> 2. Card character device (powerVM guest only)
> +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> In a powerVM guest, an extra character device is created for the
> card. The device is only used to write (flash) a new image on the
>

--
Andrew Donnellan OzLabs, ADL Canberra
[email protected] IBM Australia Limited

2020-04-09 05:55:16

by Mauro Carvalho Chehab

Subject: Re: [PATCH 31/35] powerpc: docs: cxl.rst: mark two section titles as such

Em Thu, 9 Apr 2020 10:37:52 +1000
Andrew Donnellan <[email protected]> escreveu:

> On 9/4/20 1:46 am, Mauro Carvalho Chehab wrote:
> > The User API chapter contains two sub-chapters. Mark them as
> > such.
> >
> > Signed-off-by: Mauro Carvalho Chehab <[email protected]>
>
> Thanks.
>
> Though the other subsections in this file use ----- rather than ^^^^^,
> what's the difference?

ReST syntax allows the usage of several different markup symbols for
titles. It dynamically attributes the first one it finds as level 1,
the second one as level 2 and so on.

As we added the "^^^^" markup before "-----", after this patch, it now has:

=======
level 1
=======

level 2
=======

level 3
^^^^^^^

level 4
-------


>
> Acked-by: Andrew Donnellan <[email protected]>
>
> > ---
> > Documentation/powerpc/cxl.rst | 2 ++
> > 1 file changed, 2 insertions(+)
> >
> > diff --git a/Documentation/powerpc/cxl.rst b/Documentation/powerpc/cxl.rst
> > index 920546d81326..d2d77057610e 100644
> > --- a/Documentation/powerpc/cxl.rst
> > +++ b/Documentation/powerpc/cxl.rst
> > @@ -133,6 +133,7 @@ User API
> > ========
> >
> > 1. AFU character devices
> > +^^^^^^^^^^^^^^^^^^^^^^^^
> >
> > For AFUs operating in AFU directed mode, two character device
> > files will be created. /dev/cxl/afu0.0m will correspond to a
> > @@ -395,6 +396,7 @@ read
> >
> >
> > 2. Card character device (powerVM guest only)
> > +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> >
> > In a powerVM guest, an extra character device is created for the
> > card. The device is only used to write (flash) a new image on the
> >
>



Thanks,
Mauro