aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/docgen
Commit message (Collapse)AuthorAge
...
* RELNOTES: The string list returned by the skylark 'glob' function is now ↵Gravatar Nathan Harmata2016-08-18
| | | | | | | | | | | | | | sorted. Previously, it would return a list formed by concatenating the sorted results of each pattern in the 'includes' list. A bunch of cleanups and one bug fix: -Remove the unused-except-for tests GlobCache#globsUpToDate. This code has been dead for a very very long time, ever since we switched to using Skyframe. -Change the semantics of the 'glob' function as described above. -Change UnixGlob to return unsorted results. Document this in UnixGlob and GlobCache. -Change LegacyGlobber to conditionally return sorted results. Have users other than PackageFunction get sorted results (as described above). Have PackageFunction's use case get completely unsorted results, and have PackageFunction do the sorting itself. -Have PackageFunction's HybridGlobber unconditionally sort the glob result list. This ensure deterministic glob results, fixing a bug where the order of the elements of the result depended on the contents of the Skyframe graph, which of course depends on the sequence of incremental Blaze commands. -- MOS_MIGRATED_REVID=130540152
* Deprecate the ${link page.heading} syntax for referencing BE static pages.Gravatar David Chen2016-08-16
| | | | | -- MOS_MIGRATED_REVID=130374987
* Use Options for BE docgen command line arguments.Gravatar David Chen2016-08-16
| | | | | -- MOS_MIGRATED_REVID=130371455
* Replace calls to <class>.newInstance with <class>.getConstructor().newInstance.Gravatar Ulf Adams2016-08-12
| | | | | | | This is safer; newInstance on class objects bypasses exception checking. -- MOS_MIGRATED_REVID=129976805
* --Gravatar Jon Brandvein2016-08-08
| | | | MOS_MIGRATED_REVID=129615955
* Fixed SkylarkDoc.getDocumentation to append a period to the doc string if it ↵Gravatar John Cater2016-07-29
| | | | | | | | | | | is missing. Fixes #1522. -- Change-Id: Ib94c1544cb0862f40beeeadb60780da1a47dfc66 Reviewed-on: https://bazel-review.googlesource.com/#/c/4042 MOS_MIGRATED_REVID=128807763
* Rollback of commit 3e8bcae69a0718cf6972be086706b1841e0ed6b7.Gravatar Damien Martin-Guillerez2016-07-29
| | | | | | | | | | | | | | | | | | | | | | | | | | *** Reason for rollback *** Breaks design docs links *** Original change description *** Move Bazel docs into versioned directory. * Move all Bazel docs (excluding main page, search page, and blog) into versions/master directory. * Replace all original pages with redirects. * Add Jekyll config with default_version setting to specify the default version to redirect docs to. * Add Jekyll config with version_prefix setting specific to pages under each version directory. * Update layouts to generate links to pages for the same version with the version_prefix. * Update Blaze rel... *** -- MOS_MIGRATED_REVID=128690580
* --Gravatar Carmi Grushko2016-07-28
| | | | MOS_MIGRATED_REVID=128663072
* Move Bazel docs into versioned directory.Gravatar David Chen2016-07-27
| | | | | | | | | | | | | | | | | | | | | | | | | | * Move all Bazel docs (excluding main page, search page, and blog) into versions/master directory. * Replace all original pages with redirects. * Add Jekyll config with default_version setting to specify the default version to redirect docs to. * Add Jekyll config with version_prefix setting specific to pages under each version directory. * Update layouts to generate links to pages for the same version with the version_prefix. * Update Blaze release script to copy docs from third_party/bazel/site/versions/master Changes to follow this CL: * Separate navigation from layouts so that navigation can be versioned as well. * Add tool for cutting a release of Bazel docs and copies them into a new version directory. Bug: #579 -- MOS_MIGRATED_REVID=128510319
* Build encyclopedia: mark attributes that don't work withGravatar Greg Estren2016-07-14
| | | | | | | | select() as "nonconfigurable", polish up general configurable attributes docs. -- MOS_MIGRATED_REVID=127440164
* Fix internal documentationGravatar Dmitry Lomov2016-07-12
| | | | | -- MOS_MIGRATED_REVID=127126897
* Display all allowed types for SkylarkSignature Params that allow multipleGravatar David Chen2016-07-05
| | | | | | | | | | | | | | | | | | | types. Fixes #921 Certain parameters, such as the `executable` and `command` parameters of ctx.action, allow multiple types. However, the allowed types are not enumerated in the SkylarkSignature annotation, causing the generated Skylark Library document to not display any type information for those params. This change adds a new field, `allowedTypes`, to `SkylarkSignature` that is a list of `ParamType` objects. If the param can accept multiple types, then `type` is set to `Object.class`, and `allowedTypes` is set to the list of types that can be accepted. -- MOS_MIGRATED_REVID=126617047
* Reorganize Skylark Reference documentation.Gravatar Dmitry Lomov2016-06-29
| | | | | -- MOS_MIGRATED_REVID=126081020
* Put rules inside a dropdown menu (bazel.io)Gravatar Laurent Le Brun2016-06-23
| | | | | -- MOS_MIGRATED_REVID=125571807
* Remove word "Skylark" from documentation.Gravatar Laurent Le Brun2016-06-23
| | | | | | | Text becomes somewhat clearer without using this codename. -- MOS_MIGRATED_REVID=125561237
* Add license types to the documentationGravatar Kristina Chodorow2016-06-21
| | | | | | | Fixes #642. -- MOS_MIGRATED_REVID=125351602
* Don't generate links for non-documented modules since this results in dead ↵Gravatar Florian Weikert2016-06-21
| | | | | | | links. -- MOS_MIGRATED_REVID=125336775
* Global cleanup change.Gravatar Googler2016-06-20
| | | | | -- MOS_MIGRATED_REVID=125188645
* Use only one list of parameters for SkylarkSignatureGravatar Damien Martin-Guillerez2016-06-14
| | | | | | | | | | | | | Optional and named parameters are now specified using `defaultValue` and `named` (and `positional`). The new structure allow for parameters that are both named and positional (which was forbidden before). This new structure will be used to give the @SkylarkCallable annotation the possibility to provide named and default arguments. It should be a functional no-op for Bazel users. -- MOS_MIGRATED_REVID=124821455
* Extract the @Param annotation from @SkylarkSignatureGravatar Damien Martin-Guillerez2016-06-10
| | | | | | | | The @SkylarkCallable annotation is very limited and to extend it it is best to share a similar API than the @SkylarkSignature annotation. -- MOS_MIGRATED_REVID=124473056
* Replaced arrays by single value for extra{Positionnals,Named} in ↵Gravatar Damien Martin-Guillerez2016-06-08
| | | | | | | | | | SkylarkSignature Those arrays were checked to never have more than one value so use an empty name instead of the empty array. This simplify comprehension of the API. -- MOS_MIGRATED_REVID=124330918
* Clarify documentation of why glob() does not apply to generated files.Gravatar Googler2016-06-03
| | | | | | | | | Correct example code. See also -- MOS_MIGRATED_REVID=123925214
* Replace Constants.PRODUCT_NAME with a startup option --product_name=bazel and Gravatar Luis Fernando Pino Duque2016-05-31
| | | | | | | | | | | (finally) delete Constants.java. For bazel the file Constants.java is the only source of src/main/java/com/google/devtools/build/lib:common and since it was exporting guava then many dependencies needed to be fixed. -- MOS_MIGRATED_REVID=123648270
* Add rule_or_page#heading syntax to RuleLinkExpander and support for expandingGravatar David Chen2016-05-17
| | | | | | | | | | rule_name_implicit_outputs. This change adds support for new syntax for referencing a heading for a rule or static BE page. -- MOS_MIGRATED_REVID=122509323
* Remove LABEL_LIST_DICT type. This was only used for abi_deps,Gravatar Greg Estren2016-05-11
| | | | | | | which was removed in c231574. -- MOS_MIGRATED_REVID=121974686
* List Closure Rules in docs as JavaScriptGravatar Justine Tunney2016-05-03
| | | | | -- MOS_MIGRATED_REVID=121397798
* Remove documentation for "abi" and "abi_deps".Gravatar Greg Estren2016-05-03
| | | | | | | | | These attributes are going away imminently. select() is the new abi_deps. -- MOS_MIGRATED_REVID=121294764
* Fix the documentation generator to use rule definition instances instead of ↵Gravatar Luis Fernando Pino Duque2016-04-26
| | | | | | | classes. -- MOS_MIGRATED_REVID=120794657
* Fix link to rust documentation.Gravatar Tom Prince2016-04-07
| | | | | | -- Reviewed-on: https://github.com/bazelbuild/bazel/pull/1119 MOS_MIGRATED_REVID=119104941
* Point links for Skylark rule sets to the appropriate repositories.Gravatar David Chen2016-04-04
| | | | | | | Fixes #1087 -- MOS_MIGRATED_REVID=118919990
* Adds Skylark Remote Repository documentationGravatar Damien Martin-Guillerez2016-03-24
| | | | | | | Fixes #1043 -- MOS_MIGRATED_REVID=118039426
* Expose more documentation to Skylark.Gravatar Dmitry Lomov2016-03-14
| | | | | -- MOS_MIGRATED_REVID=117123912
* Add placeholder documentation for Bazel's constraint system -Gravatar Greg Estren2016-03-08
| | | | | | | fully implemented but still being guinea pigged. -- MOS_MIGRATED_REVID=116694206
* Simplify configurable attributes documentation.Gravatar Greg Estren2016-03-08
| | | | | -- MOS_MIGRATED_REVID=116693888
* Add documentation for fragments type, and add the four fragments (apple, ↵Gravatar Dave MacLachlan2016-03-02
| | | | | | | cpp, java, jvm) to the documentation. -- MOS_MIGRATED_REVID=116092594
* Add support for additional edge cases to RuleLinkExpander.Gravatar David Chen2016-03-01
| | | | | | | | | | * Add support for rules with capital letters, such as Fileset * Add support for static page headings with periods. * Run the expander on the HTML doc for the name attribute. * Add functions to initial rule index. -- MOS_MIGRATED_REVID=115925884
* Update the glob documentation to reflect a semantic change made a very long ↵Gravatar Nathan Harmata2016-02-25
| | | | | | | | | | | time ago where glob(['**'], exclude_directories = 0) doesn't match the package's directory. Also add tests for this behavior. Also update Skyframe globbing to have these semantics. Any discrepancy has always been problematic, but now that we have Skyframe-hybrid globbing it's a lot more dangerous and consequential. Alternatives considered: do this the other way around (keep the stale documentation as-is and instead update legacy globbing). This would potentially require changing existing usages from stuff like 'data = glob(["**"], exclude_directories = 0)' to 'data = [x for x in glob(["**"], exclude_directories = 0) where x != '']'. I think this is too messy, so long as there is a valid use-case for globs matching directories in the first place. -- MOS_MIGRATED_REVID=115511504
* Add syntax for referencing docs in other rule families.Gravatar David Chen2016-02-25
| | | | | | | | | | | | This CL implements a new `${link rule.attribute}` syntax which can be used to reference the documentation of rules and attributes of other rule families. For example, `${link cc_library.deps}` will generate a link to the documentation for the `deps` attribute of the `cc_library` rule. Similarly, this syntax can also be used to reference sections of static documentation, for example `${link common-definitions.label-expansion}`. -- MOS_MIGRATED_REVID=115492361
* Remove unused code for SYNOPSIS, ATTRIBUTE_DEFINITION, and ATTRIBUTE_SIGNATUREGravatar David Chen2016-02-22
| | | | | | | docgen variables. -- MOS_MIGRATED_REVID=115204049
* Do not generate documentation for rule family if it does not contain anyGravatar David Chen2016-02-17
| | | | | | | | | | | | | | documented rules. Currently, we are generating an empty page for the Protocol Buffer rules on bazel.io because the rule definition exists but all the rules are set as undocumented. In cases like these, the docgen should neither generate a page nor any links for the rule family. Fixes #882 -- MOS_MIGRATED_REVID=114834947
* Remove doc reference to deleted "obsolete" attribute.Gravatar Greg Estren2016-02-11
| | | | | -- MOS_MIGRATED_REVID=114441410
* Minor correction to HTML for workspace() docs.Gravatar David Chen2016-02-04
| | | | | -- MOS_MIGRATED_REVID=113822158
* Remove the MAIN_RULE_CLASS_PROVIDER constant and turn it into a command line ↵Gravatar Luis Fernando Pino Duque2016-02-03
| | | | | | | parameter. -- MOS_MIGRATED_REVID=113730588
* Add back documentation and better error message for workspace namesGravatar Kristina Chodorow2016-02-03
| | | | | -- MOS_MIGRATED_REVID=113658912
* RELNOTES[INC]: Remove JAVAC "Make" variableGravatar Liam Miller-Cushon2016-02-01
| | | | | | | | | | | | | | The JAVAC "Make" variable is the javac packaged with the host JDK, which is not necessarily the same version used to compile java_library rules. Users should typically use java_library directly. If a manual javac invocation is required, BazelJavac uses the same javac version and flags as java_library. In the rare cases where the host JDK's compiler is actually desired, prefer `$(JAVABASE)/bin/javac` to `$(JAVAC)` for clarity. -- MOS_MIGRATED_REVID=113386241
* workspace() is now documented in its annotationGravatar Kristina Chodorow2016-01-28
| | | | | | | ...and this documentation is incorrect. -- MOS_MIGRATED_REVID=113198846
* Rollback of commit bd9f25c593a140acb15d3fd3fc7f66d091e1a898.Gravatar Ulf Adams2016-01-25
| | | | | | | | | | | | | | | | *** Reason for rollback *** Violates layering - genrule should not depend on platform- or language-specific parts. *** Original change description *** Add a DEVELOPER_DIR make variable to genrules to propagate the apple xcode environment variable DEVELOPER_DIR to commands. If $(DEVELOPER_DIR) is included in the genrule command, we bootstrap the XCODE_VERSION_OVERRIDE environment variable to the command. The contract with the actual action executor is, if XCODE_VERSION_OVERRIDE is present in the environment, to additionally bootstrap the DEVELOPER_DIR absolute path to the command. -- MOS_MIGRATED_REVID=112951074
* Add a DEVELOPER_DIR make variable to genrules to propagate the apple xcode ↵Gravatar Chris Parsons2016-01-21
| | | | | | | | | | environment variable DEVELOPER_DIR to commands. If $(DEVELOPER_DIR) is included in the genrule command, we bootstrap the XCODE_VERSION_OVERRIDE environment variable to the command. The contract with the actual action executor is, if XCODE_VERSION_OVERRIDE is present in the environment, to additionally bootstrap the DEVELOPER_DIR absolute path to the command. -- MOS_MIGRATED_REVID=112605616
* Add titles to Bazel documentation pages.Gravatar David Chen2016-01-20
| | | | | | | Fixes #790 -- MOS_MIGRATED_REVID=112563137
* Make the second example load() statement a label, too.Gravatar Lukacs Berki2016-01-18
| | | | | -- MOS_MIGRATED_REVID=112394770
generated by cgit v1.2.3 (git 2.39.1) at 2024-07-07 09:04:09 +0000