docs: exempt tool-generated SysConfig files from column-length limits#148
Merged
pratheesh-ti merged 1 commit intoJun 26, 2026
Conversation
The column-length best practices (79 soft / 129 hard) were written for hand-authored source. SysConfig example.syscfg files are machine- generated: their @cliArgs/@v2CliArgs header lines are single-line command strings that exceed column 129 by construction and cannot be wrapped without breaking the tool's round-trip. Treating those lines as violations produces false-positive review flags on any PR that touches a .syscfg file (for example the OPEN_PRU version bump in TexasInstruments#108/TexasInstruments#140, which only edited a token inside pre-existing long lines). Make the exemption explicit, consistent with the existing markdown/.txt carve-out, so automated and human reviewers stop flagging generated content.
nsaulnier-ti
approved these changes
Jun 25, 2026
manojKoppolu
approved these changes
Jun 26, 2026
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
4 participants
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.
Problem
best_practices.mddefines a 79-soft / 129-hard column limit. The automated reviewer (Qodo) applies this rule to SysConfigexample.syscfgfiles, which are machine-generated. Their@cliArgs/@v2CliArgsheader lines are single-line command strings (typically 140–165 cols) that exceed column 129 by construction and cannot be wrapped without breaking SysConfig's round-trip parsing.This produces false-positive "rule violation" flags on any PR that so much as touches a
.syscfgfile. Concrete example: PR #140 (issue #108) only swapped theOPEN_PRU@<ver>token inside pre-existing long generated lines, yet was flagged for a 129-column violation it neither introduced nor can fix.Note the repo's own CI does not enforce this limit on generated files (the column check in
makefile.ymlis commented out), so this is purely a documentation/review-guidance gap.Change
Make the existing carve-out explicit. The rule already exempts markdown and
.txtdocs; this adds tool-generated files (notably SysConfig*.syscfg) to that same exemption, in both places the limit is stated:No source or build behavior changes — documentation only.
Why this is the right scope
The limit exists to keep hand-written code readable. Generated files are owned by their tool; flagging them as violations creates noise that trains reviewers (human and automated) to ignore the rule. Exempting them keeps the limit meaningful where it matters.