aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/docgen
Commit message (Collapse)AuthorAge
* Fix a bad path and remove the reference to the legacy path-based load() syntax.Gravatar lberki2018-06-13
| | | | | RELNOTES: None. PiperOrigin-RevId: 200379060
* Add documentation for the toolchains= attribute.Gravatar lberki2018-06-05
| | | | | RELNOTES: None. PiperOrigin-RevId: 199333903
* Remove references to gcc from the documentation of Make variables.Gravatar lberki2018-05-25
| | | | | RELNOTES: None. PiperOrigin-RevId: 198036365
* Migrate JavaInfo's provider to use the new provider pattern.Gravatar cparsons2018-05-22
| | | | | | | This dramatically improves documentation generation for JavaInfo and it makes it far more maintainable and extensible going forward. RELNOTES: None. PiperOrigin-RevId: 197619040
* Ensure Docgen iterates through module categories detemrinistically.Gravatar cparsons2018-05-03
| | | | | | | This prevents subsequent generations of documentation reordering categories RELNOTES: None. PiperOrigin-RevId: 195310737
* Clean up code that directly imports nested classes like Builder, Entry, etc.Gravatar jcater2018-05-01
| | | | PiperOrigin-RevId: 194985157
* Use a new pattern for builtin Provider objects with @SkylarkCallable.Gravatar cparsons2018-05-01
| | | | | | | | This deprecates the old NativeProvider pattern. The new pattern is demonstrated using AppleStaticLibraryInfo. RELNOTES: None. PiperOrigin-RevId: 194956883
* Add a helpful note for the args argument of binary rules.Gravatar Googler2018-04-26
| | | | | RELNOTES: None. PiperOrigin-RevId: 194369005
* Remove use of bare Immutable{List,Map,Set} Builder classes.Gravatar jcater2018-04-20
| | | | | | Always use the more-qualified class name for clarity at the site of use. There are too many classes named Builder. PiperOrigin-RevId: 193649193
* Create @SkylarkConstructor annotation, to annotate certain global-namespace ↵Gravatar cparsons2018-04-16
| | | | | | | | | | @SkylarkCallable methods as representing constructors of other skylark types. This change also demonstrates the new pattern on the global Label() constructor. As an added bonus, it fixes documentation of that constructor. The old documentation used to read "Label.Label(...)" and the new documentation reads "Label(...)". RELNOTES: None. PiperOrigin-RevId: 193109338
* Re-add an accidentally removed line in skylark docgenGravatar cparsons2018-04-16
| | | | | RELNOTES: None. PiperOrigin-RevId: 193093782
* Create @SkylarkGlobalLibrary annotation, allowing classes/interfaces with ↵Gravatar cparsons2018-04-16
| | | | | | | | | global skylark functions to use @SkylarkCallable instead of @SkylarkSignature. Also migrate skylark's global "rule" function to @SkylarkCallable, thus demonstrating the new feature. RELNOTES: None. PiperOrigin-RevId: 193085313
* Remove dead code from SkylarkDocumentationCollectorGravatar cparsons2018-04-12
| | | | | RELNOTES: None. PiperOrigin-RevId: 192669617
* Remove docgen corner case on undocumented data structures, as these are no ↵Gravatar cparsons2018-04-12
| | | | | | | | | longer relevant. Verified by building documentation for Bazel at HEAD. RELNOTES: None. PiperOrigin-RevId: 192659718
* Migrate StringModule methods to SkylarkCallable from SkylarkSignature.Gravatar cparsons2018-04-11
| | | | | | | StringModule is a special case in a number of places because it represents effectively methods which should be annotated on String.class. However, String may not be subclassed in Java. StringModule thus serves as a proxy module for String. RELNOTES: None. PiperOrigin-RevId: 192508607
* Introduce extraPositonals and extraArguments to SkylarkCallable, to have ↵Gravatar cparsons2018-04-09
| | | | | | | | | parity with @SkylarkSignature. This is necessary for several builtin functions that still use @SkylarkSignature, such as string format. These will be migrated in a future CL. RELNOTES: None. PiperOrigin-RevId: 192200282
* Remove some dead code in SkyDocGravatar cparsons2018-04-09
| | | | | RELNOTES: None. PiperOrigin-RevId: 192178973
* Update docs for the --test_timeout value.Gravatar Googler2018-04-03
| | | | | RELNOTES: None. PiperOrigin-RevId: 191480343
* Adds 'timeout' to the table describing test size and a table for the timeoutGravatar ahumesky2018-03-15
| | | | | | | names to time. RELNOTES: None. PiperOrigin-RevId: 189198230
* Fix docstring variable expansion for @SkylarkModuleGravatar brandjon2018-03-12
| | | | | RELNOTES: PiperOrigin-RevId: 188712452
* Genericize closed-source .bzl file references in examplesGravatar Serge2018-02-23
| | | | | | | | Replace references to closed-source .bzl files in examples with generic ones. Addresses issue [4321](https://github.com/bazelbuild/bazel/issues/4321). Closes #4694. PiperOrigin-RevId: 186800107
* Replaced 'legal' by 'valid' in some documentation.Gravatar Googler2018-01-19
| | | | | RELNOTES: None. PiperOrigin-RevId: 182528996
* Fix typo in example codeGravatar Googler2018-01-15
| | | | | RELNOTES: None. PiperOrigin-RevId: 181990193
* Fix documentation about template variables.Gravatar lberki2017-12-21
| | | | | RELNOTES: None. PiperOrigin-RevId: 179810894
* Automated rollback of commit bd4c8dd0bca8452b18cb8d0eed6e1d91b9ee4434.Gravatar lberki2017-12-21
| | | | | | | | | | | | | | | | | | | | | *** Reason for rollback *** Fixed the single-character typo. *** Original change description *** Automated rollback of commit 48ff6e00e2cf72fa920d01ec78755882ab1ee313. *** Reason for rollback *** Breaks Copybara due to leak check failure. *** Original change description *** Mention that the $(JAVA) and $(JAVABASE) variables are only available if the Java runtime is listed as a toolchain. RELNOTES: None. PiperOrigin-RevId: 179799039
* Automated rollback of commit 48ff6e00e2cf72fa920d01ec78755882ab1ee313.Gravatar philwo2017-12-21
| | | | | | | | | | | | | *** Reason for rollback *** Breaks Copybara due to leak check failure. *** Original change description *** Mention that the $(JAVA) and $(JAVABASE) variables are only available if the Java runtime is listed as a toolchain. RELNOTES: None. PiperOrigin-RevId: 179791521
* Mention that the $(JAVA) and $(JAVABASE) variables are only available if the ↵Gravatar lberki2017-12-21
| | | | | | | Java runtime is listed as a toolchain. RELNOTES: None. PiperOrigin-RevId: 179787891
* Improve doc for .files and add more links/examples.Gravatar laurentlb2017-12-18
| | | | | RELNOTES: None. PiperOrigin-RevId: 179448100
* Fix a documentation linkGravatar vladmos2017-12-18
| | | | PiperOrigin-RevId: 179416493
* Fix the generic class information in the documentationGravatar vladmos2017-12-14
| | | | | | | | | | | | | | | If a parameter is defined like the following, the information about the items type defined for the param itself (not for each container type) should be included in the documentation: @Param( // ... allowedTypes = { @ParamType(type = Container1.class), @ParamType(type = Container2.class), }, generic1 = Item.class, ) PiperOrigin-RevId: 179053750
* Fix the documentation to allow making links to BE documetation articlesGravatar vladmos2017-12-13
| | | | PiperOrigin-RevId: 178910168
* Register builtins with RuntimeGravatar brandjon2017-12-07
| | | | | | | | | | | This covers all builtins in classes that use SkylarkSignatureProcessor#configureSkylarkFunctions. Generally this means things you define with @SkylarkSignature. It is now an error to call configureSkylarkFunctions multiple times for the same class. It should only be called in static initializers. Runtime's static knowledge of builtins has been factored into Runtime.BuiltinRegistry. RELNOTES: None PiperOrigin-RevId: 178295926
* Clean up ExecutionRequirementsGravatar ulfjack2017-11-29
| | | | | | | | | | | | | | | | | | | - remove BaseSpawn.Local; instead, all callers pass in the full set of execution requirements they want to set - disable caching and sandboxing for the symlink tree action - it does not declare outputs, so it can't be cached or sandboxed (fixes #4041) - centralize the existing execution requirements in the ExecutionRequirements class - centralize checking for execution requirements in the Spawn class (it's possible that we may need a more decentralized, extensible design in the future, but for now having them in a single place is simple and effective) - update the documentation - forward the relevant tags to execution requirements in TargetUtils (progress on #3960) - this also contributes to #4153 PiperOrigin-RevId: 177288598
* Add support for negative package specificationsGravatar cushon2017-11-21
| | | | | | | | | | Package specifications can now be prefixed with `-` to indicate negation: the specification `-//foo/bar/...` excludes all packages under `//foo/bar` that would otherwise have been matched. RELNOTES: Package specifications can now be prefixed with `-` to indicate negation PiperOrigin-RevId: 176551382
* Update be-nav.vmGravatar dmaclach2017-11-10
| | | | | | | | Add Apple Rules to index. Closes #3992. PiperOrigin-RevId: 175175081
* removed "This is useful for Skylark..." Duplicate text from load() docGravatar Googler2017-11-02
| | | | | RELNOTES: None. PiperOrigin-RevId: 174199997
* Update Appengine Rules LabelGravatar Tyler Rockwood2017-10-12
| | | | | | | | Minor change, but the Rules AppEngine now supports Python with Google App Engine, so it's more than just Java. Closes #3837. PiperOrigin-RevId: 171843168
* Automated rollback of commit 236b1e96351b45056124ce97b0bcf047b9428606.Gravatar lpino2017-10-06
| | | | | | *** Reason for rollback *** PiperOrigin-RevId: 171177811
* Documentation cleanupGravatar dmarting2017-10-06
| | | | PiperOrigin-RevId: 171140260
* 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