doc: Fix VRF-related and PIM docs - #20717
Merged
Merged
Conversation
Describe what FRR does (use interface VRF setup provided by OS) and what it doesn't (change interface VRF setup) regarding VRFs to set expectations and avoid misunderstandings. Describe special handling of interface vrf option. Refer to new '-w' option for switching the VRF backend instead of the deprecated '-n'. partially closes FRRouting#20636 Signed-off-by: Martin Buck <mb-tmp-tvguho.pbz@gromit.dyndns.org>
Greptile OverviewGreptile SummaryThis PR improves VRF-related and PIM documentation across three files with the following enhancements: Key Changes:
Impact: Confidence Score: 5/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant User
participant FRR_Docs as FRR Documentation
participant Admin as System Admin
participant OS as Operating System
Note over User,OS: Documentation Update Flow
User->>FRR_Docs: Read PIM/VRF documentation
FRR_Docs-->>User: Shows improved, accurate info
Note over FRR_Docs: Updates include:<br/>- VRF-awareness clarification<br/>- Acronym capitalization<br/>- Deprecated option updates
Admin->>FRR_Docs: Check VRF configuration
FRR_Docs-->>Admin: Clarifies FRR uses OS VRF setup<br/>(doesn't create VRFs)
Admin->>OS: Creates VRF interfaces
OS-->>Admin: VRF configured
Admin->>FRR_Docs: Configure PIM parameters
FRR_Docs-->>Admin: Shows which params are<br/>VRF-aware vs global
Note over Admin,OS: Key clarification:<br/>Some PIM commands (join-prune-interval,<br/>packets, register-suppress-time)<br/>are NOT VRF-aware
|
|
|
||
| *pim6d* supports pim-sm as well as MLD v1 and v2. PIMv6 is | ||
| vrf aware and can work within the context of vrf's in order to | ||
| VRF-aware and can work within the context of VRF's in order to |
There was a problem hiding this comment.
Incorrect apostrophe usage - should be VRFs (plural) not VRF's (possessive).
Suggested change
| VRF-aware and can work within the context of VRF's in order to | |
| VRF-aware and can work within the context of VRFs in order to |
Prompt To Fix With AI
This is a comment left during a code review.
Path: doc/user/pimv6.rst
Line: 10:10
Comment:
Incorrect apostrophe usage - should be `VRFs` (plural) not `VRF's` (possessive).
```suggestion
VRF-aware and can work within the context of VRFs in order to
```
How can I resolve this? If you propose a fix, please make it concise.Document what 'router pim' acutally does and how it differs from other 'router ...' commands. Static RP is no longer the only option, so don't suggest this. Instead of repeating for every parameter how to configure VRF-aware parameters, describe it properly once and only document whether parameters *are* VRF-aware. Lots of spelling/wording/acronym capitalisation fixes to improve readability. closes FRRouting#18537 Signed-off-by: Martin Buck <mb-tmp-tvguho.pbz@gromit.dyndns.org>
Some PIM parameters are global and not VRF-aware. Document them accordingly instead misleading users by saying that they're VRF-aware. partially closes FRRouting#20636 Signed-off-by: Martin Buck <mb-tmp-tvguho.pbz@gromit.dyndns.org>
gromit1811
force-pushed
the
bugfix/vrf_pim_docs
branch
from
February 6, 2026 10:24
9310485 to
d75883e
Compare
Contributor
Author
|
greptile found another spelling issue, fixed/commit updated/force pushed |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update VRF-related and specifically PIM docs to improve readability, comprehensibility and correctness. For details, see the individual commit messages.
Some notes:
For reviewing, using
git diff --word-diffis recommended. This will significantly reduce the diff size for cases where I just changed the capitalization of acronyms or reformatted due to overly long lines.I tried to improve the readability by capitalizing acronyms. I've done this where I stumbled across it, can't promise full coverage.
The last commit 9310485 updates the documentation regarding VRF-awareness of PIM parameters in the current FRR Git master. There are discussions ongoing in the pimd channel in Slack to make all 3 parameters VRF-aware. If that results in an implementation before this PR gets merged, I'll drop that commit. Otherwise, I'd suggest to merge it now and revert it when the implementation is finished.