Skip to content

doc: fix indentation error in pim doc - #21373

Merged
Jafaral merged 1 commit into
FRRouting:masterfrom
mjstapp:fix_pim_doc_indent
Mar 27, 2026
Merged

doc: fix indentation error in pim doc#21373
Jafaral merged 1 commit into
FRRouting:masterfrom
mjstapp:fix_pim_doc_indent

Conversation

@mjstapp

@mjstapp mjstapp commented Mar 26, 2026

Copy link
Copy Markdown
Contributor

Recent change to the pim user doc triggered a sphinx error; update to clear that error.

make[1]: Entering directory '/home/mjs/work/frrbgpio'
  SPHINX   doc/user/_build/.doctrees/environment.pickle
/home/mjs/work/frrbgpio/doc/user/pim.rst:450: ERROR: Unexpected indentation.

Recent change to the pim user doc triggered a sphinx error;
update to clear that error.

Signed-off-by: Mark Stapp <mjs@cisco.com>
@greptile-apps

greptile-apps Bot commented Mar 26, 2026

Copy link
Copy Markdown

Greptile Summary

This PR fixes a Sphinx build error in doc/user/pim.rst caused by inconsistent and incorrect indentation in the ip pim [sm | dm | sm-dm] command description, restoring clean make sphinx output.\n\n- The three mode entries (sm, dm, sm-dm) had mixed 6- and 7-space indentation, violating RST's strict indentation model and triggering a Sphinx Unexpected indentation error at line 450.\n- The fix reduces all three mode descriptions to 3-space indentation β€” consistent with the rest of the .. clicmd:: directive body β€” and inserts a blank line after The available modes of operation are: to properly introduce the sub-entries.\n- No content changes; purely a formatting/whitespace correction.

Confidence Score: 5/5

Safe to merge β€” single-file, whitespace-only RST fix with no content changes.

The change is minimal and purely cosmetic (indentation/blank-line adjustment in RST). It directly addresses the reported Sphinx error, introduces no new content, and the post-fix file reads correctly in context. No risk of regressions.

No files require special attention.

Important Files Changed

Filename Overview
doc/user/pim.rst Fixes Sphinx Unexpected indentation error by normalizing the indentation of sm, dm, and sm-dm mode descriptions to match the surrounding clicmd directive body, and adds a required blank line before the first sub-entry.

Reviews (1): Last reviewed commit: "doc: fix indentation error in pim doc" | Re-trigger Greptile

@Jafaral
Jafaral merged commit 833164a into FRRouting:master Mar 27, 2026
22 checks passed
@Jafaral

Jafaral commented Mar 27, 2026

Copy link
Copy Markdown
Member

@Mergifyio backport stable/10.6

@mergify

mergify Bot commented Mar 27, 2026

Copy link
Copy Markdown

backport stable/10.6

βœ… Backports have been created

Details

Jafaral added a commit that referenced this pull request Mar 27, 2026
doc: fix indentation error in pim doc (backport #21373)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants