Skip to content

docs: state the boundary row rule by stack position - #21

Merged
marcinpsk merged 1 commit into
developfrom
docs/boundary-rows
Sep 15, 2026
Merged

marcinpsk merged 1 commit into
developfrom
docs/boundary-rows

Conversation

@marcinpsk

@marcinpsk marcinpsk commented Sep 15, 2026 •

Copy link
Copy Markdown
Owner

The walk sections claimed that every interface yields two zero-index
boundary rows. The MIB emits a zero higher sub-layer row only when no
interface runs over that interface, and a zero lower sub-layer row only
when it runs over no other interface. A reader who compared a real walk
against the documented claim found rows missing, and could not tell
whether the daemon or the document was wrong.

An adversarial review caught a second error in the first correction,
which keyed the rule to interface type. A bond with a VLAN above it and
members below gets no boundary row at all, and a bond with no members
gets both. The rule follows the position in the stack, not the kind of
interface, so the type based examples are gone.

The emit rules section said a plain interface has both rows. It now says
standalone, the glossary term, so it cannot be read as covering a bond
member.

CONTEXT.md keeps the definition of a boundary row. No source file and no
test changed.

Closes #16

Summary by CodeRabbit

  • Documentation
    • Clarified how zero-index boundary rows are generated for standalone interfaces.
    • Documented that higher- and lower-index boundary rows appear only when their respective interface-overlap conditions are met.
    • Updated terminology from “plain interface” to “standalone interface.”

The walk sections claimed that every interface yields two zero-index
boundary rows. The MIB emits a zero higher sub-layer row only when no
interface runs over that interface, and a zero lower sub-layer row only
when it runs over no other interface. A reader who compared a real walk
against the documented claim found rows missing, and could not tell
whether the daemon or the document was wrong.

An adversarial review caught a second error in the first correction,
which keyed the rule to interface type. A bond with a VLAN above it and
members below gets no boundary row at all, and a bond with no members
gets both. The rule follows the position in the stack, not the kind of
interface, so the type based examples are gone.

The emit rules section said a plain interface has both rows. It now says
standalone, the glossary term, so it cannot be read as covering a bond
member.

CONTEXT.md keeps the definition of a boundary row. No source file and no
test changed.

Closes #16
@coderabbitai

coderabbitai Bot commented Sep 15, 2026 •

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 9b045bff-f124-429c-9471-cab4d33f9201

📥 Commits

Reviewing files that changed from the base of the PR and between af0244f and 0779849.

📒 Files selected for processing (2)
  • CLAUDE.md
  • README.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


Walkthrough

The documentation now states that zero-index boundary rows depend on an interface’s stack relationships. It also uses “standalone interface” for interfaces that receive both boundary rows.

Changes

Boundary row documentation

Layer / File(s) Summary
Conditional boundary row rule
CLAUDE.md, README.md
The documentation replaces the unconditional two-row rule with separate conditions for higher and lower zero-index boundary rows. It renames “plain interface” to “standalone interface”.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other · Severity of issue fixed: Low

Merge Risk: ⚪ Minimal · up to 07798

This documentation-only change matches the conditional boundary-row behavior, with no current merge-blocking risk identified.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the documentation change: it states that boundary-row rules depend on stack position.
Linked Issues check ✅ Passed The pull request satisfies issue #16. README.md and CLAUDE.md now state that the zero higher sub-layer row appears only when no interface runs over the interface, and the zero lower sub-layer row appe…
Out of Scope Changes check ✅ Passed The changes are limited to README.md and CLAUDE.md. They clarify the boundary-row rules in the user documentation and repository instructions. These changes directly implement issue #16. No unrelated …
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/boundary-rows
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch docs/boundary-rows

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

A rabbit reads the rows with care
Higher and lower rules now pair
Standalone paths show both sides bright
Stack positions keep the logic right
Clear docs guide the hop tonight

Comment @coderabbitai help to get the list of available commands.

@marcinpsk

Copy link
Copy Markdown
Owner Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Sep 15, 2026 •

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@marcinpsk
marcinpsk merged commit 6535f6f into develop Sep 15, 2026
11 checks passed
@marcinpsk
marcinpsk deleted the docs/boundary-rows branch September 15, 2026 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant