linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Andrew Donnellan <ajd@linux.ibm.com>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	Frederic Barrat <fbarrat@linux.ibm.com>,
	Michael Ellerman <mpe@ellerman.id.au>,
	Benjamin Herrenschmidt <benh@kernel.crashing.org>,
	Paul Mackerras <paulus@samba.org>,
	linuxppc-dev@lists.ozlabs.org
Subject: Re: [PATCH 31/35] powerpc: docs: cxl.rst: mark two section titles as such
Date: Thu, 9 Apr 2020 07:53:16 +0200	[thread overview]
Message-ID: <20200409075316.01edd295@coco.lan> (raw)
In-Reply-To: <fc649189-91cc-bb73-8d07-34054629a2b3@linux.ibm.com>

Em Thu, 9 Apr 2020 10:37:52 +1000
Andrew Donnellan <ajd@linux.ibm.com> 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 <mchehab+huawei@kernel.org>  
> 
> 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 <ajd@linux.ibm.com>
> 
> > ---
> >   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

  reply	other threads:[~2020-04-09  5:53 UTC|newest]

Thread overview: 50+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-04-08 15:45 [PATCH 00/35] Documentation fixes for Kernel 5.8 Mauro Carvalho Chehab
2020-04-08 15:45 ` [PATCH 01/35] MAINTAINERS: dt: update display/allwinner file entry Mauro Carvalho Chehab
2020-04-08 15:45 ` [PATCH 02/35] docs: dt: fix broken reference to phy-cadence-torrent.yaml Mauro Carvalho Chehab
2020-04-08 15:45 ` [PATCH 04/35] docs: fix broken references for ReST files that moved around Mauro Carvalho Chehab
2020-04-08 15:45 ` [PATCH 05/35] docs: filesystems: fix renamed references Mauro Carvalho Chehab
2020-04-08 15:51   ` David Sterba
2020-04-08 15:45 ` [PATCH 06/35] docs: amu: supress some Sphinx warnings Mauro Carvalho Chehab
2020-04-08 15:45 ` [PATCH 07/35] docs: arm64: booting.rst: get rid of some warnings Mauro Carvalho Chehab
2020-04-08 15:46 ` [PATCH 08/35] docs: pci: boot-interrupts.rst: improve html output Mauro Carvalho Chehab
2020-04-08 15:46 ` [PATCH 09/35] futex: get rid of a kernel-docs build warning Mauro Carvalho Chehab
2020-04-08 15:46 ` [PATCH 10/35] firewire: firewire-cdev.hL get rid of a docs warning Mauro Carvalho Chehab
2020-04-08 15:46 ` [PATCH 11/35] scripts: kernel-doc: proper handle @foo->bar() Mauro Carvalho Chehab
2020-04-08 15:46 ` [PATCH 12/35] lib: bitmap.c: get rid of some doc warnings Mauro Carvalho Chehab
2020-04-08 15:46 ` [PATCH 13/35] ata: libata-core: fix a doc warning Mauro Carvalho Chehab
2020-04-08 15:46 ` [PATCH 14/35] fs: inode.c: get rid of docs warnings Mauro Carvalho Chehab
2020-04-08 15:46 ` [PATCH 15/35] docs: ras: get rid of some warnings Mauro Carvalho Chehab
2020-04-08 15:46 ` [PATCH 16/35] docs: ras: don't need to repeat twice the same thing Mauro Carvalho Chehab
2020-04-08 15:46 ` [PATCH 17/35] docs: watch_queue.rst: supress some Sphinx warnings Mauro Carvalho Chehab
2020-04-08 15:46 ` [PATCH 18/35] scripts: kernel-doc: accept negation like !@var Mauro Carvalho Chehab
2020-04-08 15:46 ` [PATCH 19/35] docs: infiniband: verbs.c: fix some documentation warnings Mauro Carvalho Chehab
2020-04-08 15:46 ` [PATCH 20/35] docs: scripts/kernel-doc: accept blank lines on parameter description Mauro Carvalho Chehab
2020-04-08 15:46 ` [PATCH 21/35] docs: spi: spi.h: fix a doc building warning Mauro Carvalho Chehab
2020-04-08 15:49   ` Mark Brown
2020-04-08 16:11     ` Mauro Carvalho Chehab
2020-04-08 16:16       ` Mark Brown
2020-04-08 16:42         ` Mauro Carvalho Chehab
2020-04-08 15:46 ` [PATCH 22/35] docs: drivers: fix some warnings at base/platform.c when building docs Mauro Carvalho Chehab
2020-04-08 15:46 ` [PATCH 23/35] docs: fusion: mptbase.c: get rid of a doc build warning Mauro Carvalho Chehab
2020-04-13 18:20   ` Martin K. Petersen
2020-04-08 15:46 ` [PATCH 24/35] docs: mm: slab.h: fix a broken cross-reference Mauro Carvalho Chehab
2020-04-08 15:46 ` [PATCH 25/35] docs mm: userfaultfd.rst: use ``foo`` for literals Mauro Carvalho Chehab
2020-04-08 15:46 ` [PATCH 26/35] docs: mm: userfaultfd.rst: use a cross-reference for a section Mauro Carvalho Chehab
2020-04-08 15:46 ` [PATCH 27/35] docs: vm: index.rst: add an orphan doc to the building system Mauro Carvalho Chehab
2020-04-08 15:46 ` [PATCH 28/35] docs: dt: qcom,dwc3.txt: fix cross-reference for a converted file Mauro Carvalho Chehab
2020-04-09  7:27   ` Stephen Boyd
2020-04-17  9:27   ` Felipe Balbi
2020-04-17 14:31     ` Rob Herring
2020-04-08 15:46 ` [PATCH 29/35] MAINTAINERS: dt: fix pointers for ARM Integrator, Versatile and RealView Mauro Carvalho Chehab
2020-04-16 10:52   ` Linus Walleij
2020-04-16 20:15   ` Rob Herring
2020-04-08 15:46 ` [PATCH 30/35] docs: dt: fix a broken reference for a file converted to json Mauro Carvalho Chehab
2020-04-09  7:56   ` Geert Uytterhoeven
2020-04-08 15:46 ` [PATCH 31/35] powerpc: docs: cxl.rst: mark two section titles as such Mauro Carvalho Chehab
2020-04-09  0:37   ` Andrew Donnellan
2020-04-09  5:53     ` Mauro Carvalho Chehab [this message]
2020-04-08 15:46 ` [PATCH 32/35] docs: LaTeX/PDF: drop list of documents Mauro Carvalho Chehab
2020-04-08 15:46 ` [PATCH 33/35] docs: i2c: rename i2c.svg to i2c_bus.svg Mauro Carvalho Chehab
2020-04-08 15:56   ` Wolfram Sang
2020-04-08 15:46 ` [PATCH 34/35] docs: Makefile: place final pdf docs on a separate dir Mauro Carvalho Chehab
2020-04-08 15:46 ` [PATCH 35/35] docs: update recommended Sphinx version to 2.4.4 Mauro Carvalho Chehab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200409075316.01edd295@coco.lan \
    --to=mchehab+huawei@kernel.org \
    --cc=ajd@linux.ibm.com \
    --cc=benh@kernel.crashing.org \
    --cc=corbet@lwn.net \
    --cc=fbarrat@linux.ibm.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linuxppc-dev@lists.ozlabs.org \
    --cc=mpe@ellerman.id.au \
    --cc=paulus@samba.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).