aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/docgen/templates
Commit message (Collapse)AuthorAge
...
* 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
* Enforce that non test-only targets cannot depends on test-only targetsGravatar Damien Martin-Guillerez2016-10-19
| | | | | | | | | | | | | | | 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=136459421
* sandbox: Allow network access by default, unless a target has a ↵Gravatar Philipp Wollermann2016-10-07
| | | | | | | | | | | | | | | | | | | "block-network" tag. To block network access, you can set the "block-network" tag on a target like this: genrule( name = "no_access_to_network", cmd = "curl http://www.bazel.io/this_will_fail", tags = [ "block-network" ], ) This is needed to fix a performance issue due to a bug in the Linux kernel: https://lkml.org/lkml/2014/8/28/656 RELNOTES[INC]: Sandboxed actions can access the network by default, unless their target has a "block-network" tag. -- MOS_MIGRATED_REVID=135470811
* Introduce language to clearly warn against usage of $(CC) and $(JAVA).Gravatar Ulf Adams2016-09-23
| | | | | -- MOS_MIGRATED_REVID=134062471
* Adds no_match_error documentation to select, example usage.Gravatar Greg Estren2016-09-19
| | | | | -- MOS_MIGRATED_REVID=133401134
* Remove BINMODE make variable. Use COMPILATION_MODE instead.Gravatar Ulf Adams2016-08-29
| | | | | -- MOS_MIGRATED_REVID=131591324
* Implement generating single-page Build Encyclopedia.Gravatar David Chen2016-08-29
| | | | | | | | | | | | | | * 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
* Replace doc pages with redirects to versioned doc pages.Gravatar David Chen2016-08-29
| | | | | | | | | | | | | | * Add a new `redirect` Jekyll layout. * Replace all pages under docs/ with redirects to corresponding page under versions/master/. * Prepend links on Documentation sidebar, including generated navs for the Skylark Library and Build Encyclopedia, with prefix for versioned directory. * Add code to both the internal jekyll-config.sh and external jekyll-tree.sh to add redirect pages for the Skylark Library and Build Encyclopedia. * Bring the branched User Manual doc up to date with latest changes. -- MOS_MIGRATED_REVID=131568800
* Automated [] rollback of commit 846a5ab98fc26d72024890fdb79a5d3bc6a5a1ba + ↵Gravatar Nathan Harmata2016-08-23
| | | | | | | | | | | | | | | manual rollback of [] *** Reason for rollback *** Depot has been fixed / is in the process of being fixed. See the work tracked on [] *** Original change description *** Automated [] rollback of commit bb5d5efb4b50710241b5b374eb67084f4bf08278. -- MOS_MIGRATED_REVID=131095905
* Rollback of commit bb5d5efb4b50710241b5b374eb67084f4bf08278.Gravatar Tobias Werth2016-08-23
| | | | | -- MOS_MIGRATED_REVID=130941264
* Use ${link} references in common attribute documentation.Gravatar David Chen2016-08-22
| | | | | -- MOS_MIGRATED_REVID=130916210
* 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
* --Gravatar Jon Brandvein2016-08-08
| | | | MOS_MIGRATED_REVID=129615955
* 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
* 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
* Global cleanup change.Gravatar Googler2016-06-20
| | | | | -- MOS_MIGRATED_REVID=125188645
* Clarify documentation of why glob() does not apply to generated files.Gravatar Googler2016-06-03
| | | | | | | | | Correct example code. See also -- MOS_MIGRATED_REVID=123925214
* 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 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
* 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
* 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
* 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
* 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
* Update the documentation of the load() statement because now bare paths are ↵Gravatar Lukacs Berki2016-01-18
| | | | | | | deprecated. -- MOS_MIGRATED_REVID=112392227
* Refactor BuildEncyclopediaProcessor to use a common RuleFamily class for ruleGravatar David Chen2015-12-16
| | | | | | | | | | | | | documentation passed to templates. * This simplifies the logic in BuildEncyclopediaProcessor, reducing the number of various different data structures we use for generating different pages. * This also makes RuleFamily more similar to the BuildLanguage proto, which we we may consider using in the future for the native rule docgen since the Skylark docgen will be using BuildLanguage. -- MOS_MIGRATED_REVID=110265727
* Tweak BE page footer.Gravatar David Chen2015-12-07
| | | | | -- MOS_MIGRATED_REVID=109571074
* Explicitly mention that 'manual' test targets are not matched by wildcard ↵Gravatar Nathan Harmata2015-12-03
| | | | | | | target patterns and are thus neither built nor tested by invocations like "blaze test //my/project/..." -- MOS_MIGRATED_REVID=109251573
* Fix broken links on BE Functions page.Gravatar David Chen2015-12-02
| | | | | -- MOS_MIGRATED_REVID=109185795
* Fix links in Common Definitions, Make Variables, and Predefined PythonGravatar David Chen2015-12-02
| | | | | | | Variables pages. -- MOS_MIGRATED_REVID=109178629
* Adapt blaze 'features' documentation to link to the crosstool's featureGravatar Manuel Klimek2015-11-17
| | | | | | | documentation. -- MOS_MIGRATED_REVID=108019887
* Add C# rule docs to Bazel's Build Encyclopedia.Gravatar David Chen2015-11-17
| | | | | -- MOS_MIGRATED_REVID=107987328