| Commit message (Collapse) | Author | Age |
|---|
| |
|
|
|
|
|
|
|
|
|
|
|
| |
If setting flag --use_new_category_enum, group the options by the new categories in both the command line output and the "everything-as-html" output used for the generated docs at https://bazel.build/versions/master/docs/command-line-reference.html. In the html output, the effect and metadata tags are listed for each option, with links to their descriptions at the bottom of the page. The tags only appear in the terminal output in -l/--long/--help_verbosity=long, and only the names appear.
This is still experimental as the majority of options do not yet use the new categorization system. The new output can be seen in command-line-reference.html format by adding the new flag to the "help everything-as-html" line in //src/main/java/com/google/devtools/build/lib:gen_command-line-reference.
The html output is in the same order as before (by blaze rule, with inherited options not repeated), which means it still has duplicate options, that should ideally be fixed separately. I propose either dropping the high-level grouping and just grouping the options by documentation category, or potentially grouping them by optionsbase in some non-class-naming way, and listing the commands that they apply to, as more and more optionsbases are used by multiple commands without being inherited (for example, all BuildEventServiceOptions are listed 20 times). People probably use ctrl-f to navigate this page anyway. Once we know that we only list each option once, we can actually have links to the options, which will make it possible to have links in the expansion lists.
Issue #3758
RELNOTES: added experimental --use_new_category_enum to the help command to output options grouped by the new type of category.
PiperOrigin-RevId: 170116553
|
| |
|
|
|
|
|
|
|
|
|
|
|
| |
The RuleClassProvider includes a copy of the product name, parameterized
for both Blaze and Bazel. Apparently, this is exclusively there so that
the standalone docgen binary can "magically" guess the product name.
This is strange and adds additional complexity to the Bazel core codebase
for no strong reason. Instead, just add a new flag to docgen that takes
the product name and pass it in explicitly.
RELNOTES: None.
PiperOrigin-RevId: 167724033
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
| |
* Adds a --single_page flag to the BE docgen for generating a single-page
version of the Build Encyclopedia.
* Refactor BuildEncyclopediaProcessor common logic into a base class and add
subclasses for generating single- and multi-page BE respectively.
* Enable RuleLinkExpander to expand rule references to single-page hrefs
(headings on the current page).
* Update docgen velocity templates to use RuleLinkExpander to ensure links are
correct on both single- and multi-page versions of the BE.
--
MOS_MIGRATED_REVID=131574793
|
| |
|
|
|
| |
--
MOS_MIGRATED_REVID=130371455
|
| |
|
|
|
|
|
| |
parameter.
--
MOS_MIGRATED_REVID=113730588
|
| |
|
|
|
|
|
|
|
|
|
| |
Any rule in that black list will be skipped during build encyclopedia
generation.
This is for supporting outside documentation of rules that have a
different documentation internally.
--
MOS_MIGRATED_REVID=103958542
|
| |
|
|
|
|
|
|
|
|
|
| |
The headers were modified with
`find . -type f -exec 'sed' '-Ei' 's|Copyright 201([45]) Google|Copyright 201\1 The Bazel Authors|' '{}' ';'`
And manual edit for not Google owned copyright. Because of the nature of ijar, I did not modified the header of file owned by Alan Donovan.
The list of authors were extracted from the git log. It is missing older Google contributors that can be added on-demand.
--
MOS_MIGRATED_REVID=103938715
|
|
|
--
MOE_MIGRATED_REVID=85702957
|
ccalvarin
jmmv
David Chen
Luis Fernando Pino Duque
Damien Martin-Guillerez
Han-Wen Nienhuys