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@xxxxxxxxx>
> ---
> 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
