| commit | 6dbac49ef52c1cb142779c2ef0e26a04170f6330 | [log] [tgz] |
|---|---|---|
| author | Googler <wyv@google.com> | Wed Apr 12 10:49:55 2023 -0700 |
| committer | Copybara-Service <copybara-worker@google.com> | Wed Apr 12 10:51:21 2023 -0700 |
| tree | b2c0042b3148d02dd6661f801d78c7d4620ad063 | |
| parent | 8ec4c5091a143d0aa2548d1d9cf02b0f03c49044 [diff] |
Docgen: Split the "global functions" page into multiple ones ====== - Primary motivation: https://github.com/bazelbuild/bazel/issues/16383 - Currently, the pages generated by docgen is a `PageTitle -> Page` map. It's then separated into multiple categories based on the `docCategory` value of the `@StarlarkBuiltin` annotation, with the exception of the "global functions" page, which is special-cased. - This has several issues: for one, the configuration fragment named "proto" has a conflict with the top-level module named "proto", since everything is in the same map (we work around this by naming the latter "ProtoModule", which is wrong and confusing). - For another, we can't easily split the "global functions" page into multiple ones, unless we special-case every one of them. - So we structure the returned pages into a `Category -> [Page]` map. The new category `GLOBAL_FUNCTION` contains a few pages, each of which contains global functions available in a certain environment (see https://github.com/bazelbuild/bazel/commit/d1c72d70f45c2362a87d22ebac9e5bb7f2b4ae0a). The other categories are largely unchanged. - We also change the URL format of these pages from `..../lib/$TITLE.html` to `..../lib/$CATEGORY/$TITLE.html`. - The bulk of this CL involves fixing up all links. - This also means that "proto" the configuration fragment and "proto" the top-level module can now both be named "proto". - This does break old links, but I can't find the energy to set up redirects for everything... - Miscellaneous changes: - The `starlark-nav.vm` page is removed; nobody uses it. - Renamed the category overview pages from `..../lib/starlark-$CATEGORY.html` to just `..../lib/$CATEGORY.html`, now that there's no pages directly under `..../lib`. - A bunch of small documentation fixes across the codebase as I went through them. Fixes https://github.com/bazelbuild/bazel/issues/16383 PiperOrigin-RevId: 523745069 Change-Id: Idfbb29f1f589bde58ac5a8b199a788245286256a
{Fast, Correct} - Choose two
Build and test software of any size, quickly and reliably.
Speed up your builds and tests: Bazel rebuilds only what is necessary. With advanced local and distributed caching, optimized dependency analysis and parallel execution, you get fast and incremental builds.
One tool, multiple languages: Build and test Java, C++, Android, iOS, Go, and a wide variety of other language platforms. Bazel runs on Windows, macOS, and Linux.
Scalable: Bazel helps you scale your organization, codebase, and continuous integration solution. It handles codebases of any size, in multiple repositories or a huge monorepo.
Extensible to your needs: Easily add support for new languages and platforms with Bazel's familiar extension language. Share and re-use language rules written by the growing Bazel community.
Follow our tutorials:
To report a security issue, please email security@bazel.build with a description of the issue, the steps you took to create the issue, affected versions, and, if known, mitigations for the issue. Our vulnerability management team will respond within 3 working days of your email. If the issue is confirmed as a vulnerability, we will open a Security Advisory. This project follows a 90 day disclosure timeline.
See CONTRIBUTING.md
