Re: [PATCH] docs: octeontx2: tune rst markup

From: Lukas Bulwahn <lukas.bulwahn@gmail.com>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: George Cherian <george.cherian@marvell.com>,
	Jonathan Corbet <corbet@lwn.net>,
	"open list:DOCUMENTATION" <linux-doc@vger.kernel.org>,
	Sunil Goutham <sgoutham@marvell.com>,
	Linu Cherian <lcherian@marvell.com>,
	Geetha Sowjanya <gakula@marvell.com>,
	Jerin Jacob <jerinj@marvell.com>,
	"David S . Miller" <davem@davemloft.net>,
	Jakub Kicinski <kuba@kernel.org>,
	Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	Netdev <netdev@vger.kernel.org>,
	Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH] docs: octeontx2: tune rst markup
Date: Wed, 6 Jan 2021 17:20:10 +0100	[thread overview]
Message-ID: <CAKXUXMy25cPtBKtYFTAejfrorVzb=KFu-t=unJetM9oaTfYKvQ@mail.gmail.com> (raw)
In-Reply-To: <0eb77133-947b-39c8-ee58-13b502c5ee71@infradead.org>

On Tue, Jan 5, 2021 at 9:27 PM Randy Dunlap <rdunlap@infradead.org> wrote:
>
> Hi Lukas,
>
> On 1/5/21 1:35 AM, Lukas Bulwahn wrote:
> > Commit 80b9414832a1 ("docs: octeontx2: Add Documentation for NPA health
> > reporters") added new documentation with improper formatting for rst, and
> > caused a few new warnings for make htmldocs in octeontx2.rst:169--202.
> >
> > Tune markup and formatting for better presentation in the HTML view.
> >
> > Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
> > ---
> > applies cleanly on current master (v5.11-rc2) and next-20201205
> >
> > George, please ack.
> > Jonathan, please pick this minor formatting clean-up patch.
> >
> >  .../ethernet/marvell/octeontx2.rst            | 59 +++++++++++--------
> >  1 file changed, 34 insertions(+), 25 deletions(-)
> >
> > diff --git a/Documentation/networking/device_drivers/ethernet/marvell/octeontx2.rst b/Documentation/networking/device_drivers/ethernet/marvell/octeontx2.rst
> > index d3fcf536d14e..00bdc10fe2b8 100644
> > --- a/Documentation/networking/device_drivers/ethernet/marvell/octeontx2.rst
> > +++ b/Documentation/networking/device_drivers/ethernet/marvell/octeontx2.rst
> > @@ -165,45 +165,54 @@ Devlink health reporters
> >  NPA Reporters
> >  -------------
> >  The NPA reporters are responsible for reporting and recovering the following group of errors
>
> Can we get a period or colon at the end of that line above, please.
>
> > +
> >  1. GENERAL events
> > +
> >     - Error due to operation of unmapped PF.
> >     - Error due to disabled alloc/free for other HW blocks (NIX, SSO, TIM, DPI and AURA).
> > +
> >  2. ERROR events
> > +
> >     - Fault due to NPA_AQ_INST_S read or NPA_AQ_RES_S write.
> >     - AQ Doorbell Error.
> > +
> >  3. RAS events
> > +
> >     - RAS Error Reporting for NPA_AQ_INST_S/NPA_AQ_RES_S.
> > +
> >  4. RVU events
> > +
> >     - Error due to unmapped slot.
> >
> > -Sample Output
> > --------------
> > -~# devlink health
> > -pci/0002:01:00.0:
> > -  reporter hw_npa_intr
> > -      state healthy error 2872 recover 2872 last_dump_date 2020-12-10 last_dump_time 09:39:09 grace_period 0 auto_recover true auto_dump true
> > -  reporter hw_npa_gen
> > -      state healthy error 2872 recover 2872 last_dump_date 2020-12-11 last_dump_time 04:43:04 grace_period 0 auto_recover true auto_dump true
> > -  reporter hw_npa_err
> > -      state healthy error 2871 recover 2871 last_dump_date 2020-12-10 last_dump_time 09:39:17 grace_period 0 auto_recover true auto_dump true
> > -   reporter hw_npa_ras
> > -      state healthy error 0 recover 0 last_dump_date 2020-12-10 last_dump_time 09:32:40 grace_period 0 auto_recover true auto_dump true
> > +Sample Output::
> > +
> > +     ~# devlink health
> > +     pci/0002:01:00.0:
> > +       reporter hw_npa_intr
> > +           state healthy error 2872 recover 2872 last_dump_date 2020-12-10 last_dump_time 09:39:09 grace_period 0 auto_recover true auto_dump true
> > +       reporter hw_npa_gen
> > +           state healthy error 2872 recover 2872 last_dump_date 2020-12-11 last_dump_time 04:43:04 grace_period 0 auto_recover true auto_dump true
> > +       reporter hw_npa_err
> > +           state healthy error 2871 recover 2871 last_dump_date 2020-12-10 last_dump_time 09:39:17 grace_period 0 auto_recover true auto_dump true
> > +        reporter hw_npa_ras
> > +           state healthy error 0 recover 0 last_dump_date 2020-12-10 last_dump_time 09:32:40 grace_period 0 auto_recover true auto_dump true
> >
> >  Each reporter dumps the
> >   - Error Type
> >   - Error Register value
> >   - Reason in words
> >
> > -For eg:
> > -~# devlink health dump show  pci/0002:01:00.0 reporter hw_npa_gen
> > - NPA_AF_GENERAL:
> > -         NPA General Interrupt Reg : 1
> > -         NIX0: free disabled RX
> > -~# devlink health dump show  pci/0002:01:00.0 reporter hw_npa_intr
> > - NPA_AF_RVU:
> > -         NPA RVU Interrupt Reg : 1
> > -         Unmap Slot Error
> > -~# devlink health dump show  pci/0002:01:00.0 reporter hw_npa_err
> > - NPA_AF_ERR:
> > -        NPA Error Interrupt Reg : 4096
> > -        AQ Doorbell Error
> > +For eg::
>
>    For example::
> or
>    E.g.::
>
> > +
> > +     ~# devlink health dump show  pci/0002:01:00.0 reporter hw_npa_gen
> > +      NPA_AF_GENERAL:
> > +              NPA General Interrupt Reg : 1
> > +              NIX0: free disabled RX
> > +     ~# devlink health dump show  pci/0002:01:00.0 reporter hw_npa_intr
> > +      NPA_AF_RVU:
> > +              NPA RVU Interrupt Reg : 1
> > +              Unmap Slot Error
> > +     ~# devlink health dump show  pci/0002:01:00.0 reporter hw_npa_err
> > +      NPA_AF_ERR:
> > +             NPA Error Interrupt Reg : 4096
> > +             AQ Doorbell Error
> >
>

thanks, Randy.

Agree and done. I just sent out a v2:

https://lore.kernel.org/linux-doc/20210106161735.21751-1-lukas.bulwahn@gmail.com/

Lukas