docs: octeontx2: tune rst markup
PATCH v2 1/1 docs: octeontx2: tune rst markup
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.
---
v1 -> v2: minor stylistic tuning as suggested by Randy
applies cleanly on current master (v5.11-rc2) and next-20210106
George, please ack.
Jonathan, please pick this minor formatting clean-up patch.
.../ethernet/marvell/octeontx2.rst | 62 +++++++++++-------- 1 file changed, 36 insertions(+), 26 deletions(-)
Documentation/networking/device_drivers/ethernet/marvell/octeontx2.rst +36 -26
@@ -164,46 +164,56 @@ Devlink health reporters NPA Reporters ------------- -The NPA reporters are responsible for reporting and recovering the following group of errors +The NPA reporters are responsible for reporting and recovering the following group of errors: + 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 example:: + + ~# 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
Signature · 1 line
2.17.1
Documentation/networking/device_drivers/ethernet/marvell/octeontx2.rst
Quoted 22 lines · Lukas Bulwahn
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 <[email protected]>---
v1 -> v2: minor stylistic tuning as suggested by Randyapplies cleanly on current master (v5.11-rc2) and next-20210106
George, please ack.
Jonathan, please pick this minor formatting clean-up patch..../ethernet/marvell/octeontx2.rst | 62 +++++++++++-------- 1 file changed, 36 insertions(+), 26 deletions(-)Documentation/networking/device_drivers/ethernet/marvell/octeontx2.rst +0
-0
Thanks.
Signature · 1 line
~Randy
Quoted 7 lines · Lukas Bulwahn
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.
Quoted 9 lines
Signed-off-by Lukas Bulwahn <[email protected]>---
v1 -> v2: minor stylistic tuning as suggested by Randyapplies cleanly on current master (v5.11-rc2) and next-20210106
George, please ack.
Jonathan, please pick this minor formatting clean-up patch.
Regards
-George
Quoted 7 lines · On Wed, 6 Jan 2021 17:17:35 +0100 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 <[email protected]>
Applied to net, thanks everyone!