aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/docgen
Commit message (Collapse)AuthorAge
* Add new option categorization and tagging information to HelpCommand's output.Gravatar ccalvarin2017-09-27
| | | | | | | | | | | | | 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
* Replace apparent endorsement for recursive globs with one for smaller BUILD ↵Gravatar Googler2017-09-13
| | | | | | | | targets. This is more in line with what I believe is considered a best practice these days. PiperOrigin-RevId: 168396725
* Documentation cleanup.Gravatar dmarting2017-09-13
| | | | PiperOrigin-RevId: 168389301
* Remove the product name from ConfiguredRuleClassProvider.Gravatar jmmv2017-09-07
| | | | | | | | | | | | | 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
* More BUILD file refactorings.Gravatar philwo2017-09-06
| | | | | | | | | Split collect, concurrent, vfs, windows into package-level BUILD files. Move clock classes out of "util", into their own Java package. Move CompactHashSet into its own Java package to break a dependency cycle. Give nestedset and inmemoryfs their own package-level BUILD files. PiperOrigin-RevId: 167702127
* Rename bazel-user-manual.html into user-manual.htmlGravatar dmarting2017-09-04
| | | | PiperOrigin-RevId: 167477112
* Support executing as root in the linux sandbox.Gravatar Benjamin Peterson2017-08-11
| | | | | | | | | | | | | | | linux-sandbox has a useful option -R, that runs the spawn as fake root. However, it's not exposed to Bazel rules. Here, we do that via the "requires-fakeroot" tag. One possible usecase: In combination with "block-network", "requires-fakeroot" makes it possible to integration test services that insist on listening on privileged ports. Unsurprisingly, this is incompatible with --sandbox_fake_username. Change-Id: I9e8ab4d4abf0e45626e005ff21f73e6c17de0788 PiperOrigin-RevId: 164961019
* Fix licenses() example documentation ↵Gravatar Zaven Muradyan2017-08-02
| | | | | | | | (https://user-images.githubusercontent.com/744228/28495342-609be784-6efe-11e7-8403-0f3c5e892b13.png) Closes #3436. PiperOrigin-RevId: 163968685
* Document name binding in load()Gravatar Dmitry Lomov2017-07-24
| | | | | | | Fixes #2987. Change-Id: I359a74b37a670e3953cc737a416c0e9573e547f0 PiperOrigin-RevId: 162738265
* Skylark documentation: Replace "set" and "List" plain-text return types with ↵Gravatar fwe2017-07-21
| | | | | | links to "deptset" and "list". PiperOrigin-RevId: 162607082
* Ignore case in documentation indexGravatar laurentlb2017-07-19
| | | | | RELNOTES: None. PiperOrigin-RevId: 162373757
* Make the @Option annotation depend on the java version of the tagging enums.Gravatar ccalvarin2017-07-18
| | | | | | | The option filters proto dependency can be removed from the OptionsParser. This is in response to option parser users that want to avoid the bazel-internal proto file in their dependencies. RELNOTES: None. PiperOrigin-RevId: 162249778
* Delete the "Predefined Python variables" page.Gravatar laurentlb2017-07-18
| | | | | | | | The page was incomplete and almost empty, and also redundant with https://docs.bazel.build/versions/master/skylark/lib/globals.html#PACKAGE_NAME RELNOTES: None. PiperOrigin-RevId: 162234689
* Add new type descriptions for rule attribute documentation.Gravatar gregce2017-07-17
| | | | | | | | | Motivation: properly document config_setting.values. The license type description is terse. But that's an obscure feature we don't really want to focus attention on. PiperOrigin-RevId: 161998339
* Try to clarify "unaffected by subinclude," and also stop mentioning ↵Gravatar cpovirk2017-07-06
| | | | | | | subinclude :) RELNOTES: None. PiperOrigin-RevId: 160974476
* List the default timeout values for all 4 possible values, not just 3 out of 4.Gravatar Googler2017-06-29
| | | | PiperOrigin-RevId: 160427360
* Add the default category and tag to all options.Gravatar ccalvarin2017-06-28
| | | | | | | | Move the default from the annotation to every mention. This makes the incompleteness explicit. Will add the defaults to test targets in a separate change. Once all dependencies are cleaned up, the Option annotation will no longer allow options without the documentationCategory or effectTag, to prevent new options being added without categories while we migrate to the new option categorization. PiperOrigin-RevId: 160281252
* Fix couple of code blocks, doc paths in docgen templates.Gravatar dzc2017-06-16
| | | | | | | | | * Replace ```shell with ```sh to fix jekyll build errors * Fix paths in docgen templates for new docs site directory structure. * Add jekyll build output directories to gitignore. RELNOTES: None PiperOrigin-RevId: 159020213
* Internal cleanup.Gravatar gregce2017-06-09
| | | | PiperOrigin-RevId: 158428641
* Fixing documentation for platforms and toolchains.Gravatar John Cater2017-06-05
| | | | | Change-Id: I98fd671af858c402b10bb5ef59735d83d4003593 PiperOrigin-RevId: 157863146
* Link to rules_docker GitHub repo instead of generated documentation.Gravatar steren2017-05-15
| | | | PiperOrigin-RevId: 156046860
* RELNOTES: Fix select condition intersections.Gravatar Googler2017-04-19
| | | | PiperOrigin-RevId: 153531483
* Delete more Python-preprocessing tests and documentationGravatar laurentlb2017-04-06
| | | | | | RELNOTES: None. PiperOrigin-RevId: 152369293
* Skylark documentation identifies overloaded methods by their full signature ↵Gravatar fwe2017-04-06
| | | | | | | | (*) instead of using duplicate method names. (*) Technically it's not a proper method signature since it contains parameter names instead of parameter types. PiperOrigin-RevId: 152251143
* Hyperlink "nonconfigurable"-tagged attributes to Bazel'sGravatar gregce2017-04-05
| | | | | | configurable attributes documentation. PiperOrigin-RevId: 152188409
* No longer crash when running "bazel help <rule>".Gravatar Florian Weikert2017-03-16
| | | | | | | | Fixes #2270. -- PiperOrigin-RevId: 150324978 MOS_MIGRATED_REVID=150324978
* Make sure that the external version of skylark-overview.html is being ↵Gravatar Florian Weikert2017-03-08
| | | | | | | | displayed properly. -- PiperOrigin-RevId: 149528271 MOS_MIGRATED_REVID=149528271
* Skylark Documentation: Add a one-page overview of all Skylark modules and ↵Gravatar Florian Weikert2017-03-06
| | | | | | | | globals. -- PiperOrigin-RevId: 149286951 MOS_MIGRATED_REVID=149286951
* Global cleanup change.Gravatar Googler2017-03-03
| | | | | | -- PiperOrigin-RevId: 149089903 MOS_MIGRATED_REVID=149089903
* Global cleanup change.Gravatar Googler2017-03-03
| | | | | | -- PiperOrigin-RevId: 149004753 MOS_MIGRATED_REVID=149004753
* Skylark documentation pipeline automatically generates documentation for all ↵Gravatar Florian Weikert2017-02-22
| | | | | | | | | | Skylark modules. With this change, we no longer have to manually register modules whose generation should be generated. Manual registration turned out to be prone to errors since engineers didn't know about it or simply forgot to register their modules. As a result, we had ~20 modules that featured nice documentation texts, but that were not being picked up by the documentation pipeline. -- PiperOrigin-RevId: 148136776 MOS_MIGRATED_REVID=148136776
* Clarify that package() comes after load()Gravatar Laurent Le Brun2017-02-16
| | | | | | -- PiperOrigin-RevId: 147714630 MOS_MIGRATED_REVID=147714630
* Generate documentation for bool and int types.Gravatar Laurent Le Brun2017-02-15
| | | | | | | | | This improves consistency in the documentation (string and list already have their own page). -- PiperOrigin-RevId: 147599068 MOS_MIGRATED_REVID=147599068
* Remove special-casing of the 'native' module.Gravatar Laurent Le Brun2017-02-15
| | | | | | | | | It should show up in the documentation in the same way as 'attr', another builtin module. -- PiperOrigin-RevId: 147589912 MOS_MIGRATED_REVID=147589912
* Fix the documentation of set/depsetGravatar Vladimir Moskva2017-02-14
| | | | | | -- PiperOrigin-RevId: 147456653 MOS_MIGRATED_REVID=147456653
* Clarify that load() statements do not respect visibility.Gravatar Laurent Le Brun2017-02-14
| | | | | | -- PiperOrigin-RevId: 147384211 MOS_MIGRATED_REVID=147384211
* Clarify what the .args= argument is used for in binaries.Gravatar Lukacs Berki2017-01-17
| | | | | | -- PiperOrigin-RevId: 144704307 MOS_MIGRATED_REVID=144704307
* Add SwiftConfigurationGravatar Dmitry Shevchenko2017-01-12
| | | | | | | | * This new configuration allows for passthrough of Swift-specific options into Skylark for further consumption by swift_library. It also keeps things nicely isolated until we get a way to create configurations in Skylark directly. -- PiperOrigin-RevId: 144210267 MOS_MIGRATED_REVID=144210267
* Remove the auto-punctuator because it is causing more problems than itGravatar John Cater2017-01-03
| | | | | | | | | | solved. -- Change-Id: Ie9314cabda8b5542979f58cdb2ab7a41e6cd26ad Reviewed-on: https://cr.bazel.build/8091 PiperOrigin-RevId: 143470985 MOS_MIGRATED_REVID=143470985
* Include ObjcProvider in generated Skylark documentation.Gravatar Florian Weikert2016-12-21
| | | | | | | | Fixes #1768 -- PiperOrigin-RevId: 142654511 MOS_MIGRATED_REVID=142654511
* Fix the documentation for the "size" attribute in tests.Gravatar Philipp Wollermann2016-12-09
| | | | | | | | It wrongly stated that this only affects the timeout, however it actually affects the resources required for a test to run. -- PiperOrigin-RevId: 141546278 MOS_MIGRATED_REVID=141546278
* Say C and C++, when C and C++ is what we mean.Gravatar Googler2016-12-09
| | | | | | | | This document states that $(CC) is the "C compiler". This is incomplete and misleading; per comments at line 1799 of CppConfiguration.java, it is expected to be a binary that will compile both C and C++ code. -- PiperOrigin-RevId: 141459615 MOS_MIGRATED_REVID=141459615
* Description redacted.Gravatar David Chen2016-12-07
| | | | | | -- PiperOrigin-RevId: 141233274 MOS_MIGRATED_REVID=141233274
* Move Bazel-specific functions in a separate file.Gravatar Laurent Le Brun2016-11-21
| | | | | | | | "type", "set" and "select" should not be part of the standalone Skylark library. -- MOS_MIGRATED_REVID=139578095
* Fix up documentation for Actions APIGravatar Jon Brandvein2016-11-18
| | | | | -- MOS_MIGRATED_REVID=139569372
* Fix a bunch of typosGravatar Jon Brandvein2016-11-10
| | | | | -- MOS_MIGRATED_REVID=138757881
* Fix typo in bazel docs: Borne -> Bourne.Gravatar Googler2016-10-31
| | | | | -- MOS_MIGRATED_REVID=137688913
* Small docs updates for the extra action rule.Gravatar Ulf Adams2016-10-28
| | | | | | | | Add the product name to the ConfiguredRuleClassProvider so that the doc generator can generate the proper links to the user manual. -- MOS_MIGRATED_REVID=137505460
* Rollback of commit e6191f7209ebf3f67480bc7aa9db5ac58beb2156.Gravatar Damien Martin-Guillerez2016-10-19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | *** Reason for rollback *** Roll-forward with fix. Tested with `bazel build src:srcs //src/test/...` using a bootstrapped bazel. Fixes #1923. RELNOTES[INC]: Non test-only targets can no longer depends on test-only targets. *** Original change description *** Automated [] rollback of commit a9f20b0d6459d395444c45cf5e94a899f3443633. *** Reason for rollback *** Broke Bazel CI: ERROR: /home/ci/workspace/Bazel/JAVA_VERSION/1.8/PLATFORM_NAME/linux-x86_64/src/BUILD:284:1: in filegroup rule //src:srcs: non-test target '//src:srcs' depends on testonly target '//src/java_tools/junitrunner/java/com/google/testing/junit/junit4:srcs' and doesn't have testonly attribute set. ERROR: Analysis of target '//scripts/packages:packages' failed; build aborted. http://ci.bazel.io/view/Bazel%20b... *** -- MOS_MIGRATED_REVID=136589937
* Rollback of commit a9f20b0d6459d395444c45cf5e94a899f3443633.Gravatar Philipp Wollermann2016-10-19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | *** Reason for rollback *** Broke Bazel CI: ERROR: /home/ci/workspace/Bazel/JAVA_VERSION/1.8/PLATFORM_NAME/linux-x86_64/src/BUILD:284:1: in filegroup rule //src:srcs: non-test target '//src:srcs' depends on testonly target '//src/java_tools/junitrunner/java/com/google/testing/junit/junit4:srcs' and doesn't have testonly attribute set. ERROR: Analysis of target '//scripts/packages:packages' failed; build aborted. http://ci.bazel.io/view/Bazel%20bootstrap%20and%20maintenance/job/Bazel/JAVA_VERSION=1.8,PLATFORM_NAME=linux-x86_64/923/console *** Original change description *** Enforce that non test-only targets cannot depends on test-only targets This behavior was not enforced since we open-sourced Bazel even though this was documented and the attributed existed. Also removed the incorrect part from the documentations: we do not enforce restrictions on javatests package. Fixes #1923. RELNOTES[INC]: Non test-only targets can no longer depends on test-only targets. -- MOS_MIGRATED_REVID=136574806
generated by cgit v1.2.3 (git 2.39.1) at 2024-07-08 13:56:12 +0000