Render --help=config from the help model - #388
Merged
Merged
Conversation
…eference) Port the --help=config topic off the imperative RenderConfig onto the help model: add ConfigSection() - an intro, a Layers subsection (the precedence tiers as a table plus the no-discovery / --no-config note), Choosing-a-style and Arming subsections as wrapping prose, and the config-tagged flags (globals SOT) as model entries. Route --help=config through TopicReference and add it to BuildReference after Description so --man / --markdown / --help=full gain the section. Delete RenderConfig and its RenderHelp branch. Regenerate XFF.md; update help_build_test (section list) and add a config-topic render test.
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
1 participant
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.
Second slice of retiring the imperative prose-topic renderers onto the help model (EPIC #154; follows #387 stats).
What
help_build.cc: addConfigSection()- intro prose, a Layers subsection (precedence tiers as a table + the no-discovery /--no-confignote), Choosing a style and Arming dangerous directives subsections as wrapping prose, and theconfig-tagged flags (globals SOT) as model entries.--help=configthroughTopicReference; addConfigSectiontoBuildReferenceright after Description, so--man/--markdown/--help=fullgain it.RenderConfigand itsRenderHelpbranch.Effect
--help=confignow wraps to--widthand indents consistently (was a fixed-width blob). Verified--width=60: max line length 60.Test
bazel test //xff/...(lean 85) and--config=xff_full(90, incl. the XFF.md drift guard) green; XFF.md regenerated.Remaining prose topics: cookbook / notice / license (verbatim) / help-guide, one PR each.