diff options
| author | Elliott Hughes <enh@google.com> | 2024-01-09 22:02:03 +0000 |
|---|---|---|
| committer | Elliott Hughes <enh@google.com> | 2024-01-09 22:09:07 +0000 |
| commit | 10363161e76c1d2ed196582e593ee6cef0706dd1 (patch) | |
| tree | ea3663ef48cf0f47c7f8dbdef103489ceffd231f /docs | |
| parent | 539b46b6bd0ebacbc79016a8e0043dce02072263 (diff) | |
"master" was renamed "main".
Test: N/A
Change-Id: I86d5578eaac260e55a9583db7ab49812b4ba1f5d
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/best_practices.md | 4 | ||||
| -rw-r--r-- | docs/clion.md | 2 | ||||
| -rw-r--r-- | docs/map_files.md | 4 | ||||
| -rw-r--r-- | docs/rbe.md | 2 | ||||
| -rw-r--r-- | docs/tidy.md | 12 |
5 files changed, 12 insertions, 12 deletions
diff --git a/docs/best_practices.md b/docs/best_practices.md index bc760b876..48ed996e7 100644 --- a/docs/best_practices.md +++ b/docs/best_practices.md @@ -285,6 +285,6 @@ types. Soong plugins are inherently tightly coupled to the build system and will require ongoing maintenance as the build system is changed; so plugins should be used only when absolutely required. -See [art/build/art.go](https://android.googlesource.com/platform/art/+/master/build/art.go) -or [external/llvm/soong/llvm.go](https://android.googlesource.com/platform/external/llvm/+/master/soong/llvm.go) +See [art/build/art.go](https://android.googlesource.com/platform/art/+/main/build/art.go) +or [external/llvm/soong/llvm.go](https://android.googlesource.com/platform/external/llvm/+/main/soong/llvm.go) for examples of more complex conditionals on product variables or environment variables. diff --git a/docs/clion.md b/docs/clion.md index 110891b31..8e2c59782 100644 --- a/docs/clion.md +++ b/docs/clion.md @@ -4,7 +4,7 @@ Soong can generate CLion projects. This is intended for source code editing only. Build should still be done via make/m/mm(a)/mmm(a). Note: alternatively, you can use -[aidegen to generate a Clion or VSCode project](https://android.googlesource.com/platform/tools/asuite/+/refs/heads/master/aidegen/README.md) +[aidegen to generate a Clion or VSCode project](https://android.googlesource.com/platform/tools/asuite/+/refs/heads/main/aidegen/README.md) with a single command, using the `-i c` flag. CMakeLists.txt project file generation is enabled via environment variable: diff --git a/docs/map_files.md b/docs/map_files.md index 37f91ecb5..e1ddefc27 100644 --- a/docs/map_files.md +++ b/docs/map_files.md @@ -5,8 +5,8 @@ map.txt files. These files are [linker version scripts] with comments that are semantically meaningful to [gen_stub_libs.py]. For an example of a map file, see [libc.map.txt]. -[gen_stub_libs.py]: https://cs.android.com/android/platform/superproject/+/master:build/soong/cc/gen_stub_libs.py -[libc.map.txt]: https://cs.android.com/android/platform/superproject/+/master:bionic/libc/libc.map.txt +[gen_stub_libs.py]: https://cs.android.com/android/platform/superproject/+/main:build/soong/cc/gen_stub_libs.py +[libc.map.txt]: https://cs.android.com/android/platform/superproject/+/main:bionic/libc/libc.map.txt [linker version scripts]: https://www.gnu.org/software/gnulib/manual/html_node/LD-Version-Scripts.html ## Basic format diff --git a/docs/rbe.md b/docs/rbe.md index cfe86d765..be60c83a2 100644 --- a/docs/rbe.md +++ b/docs/rbe.md @@ -11,7 +11,7 @@ build actions through a worker pool sharing a central cache of build results. To enable RBE, you need to set several environment variables before triggering the build. You can set them through a -[environment variables config file](https://android.googlesource.com/platform/build/soong/+/master/README.md#environment-variables-config-file). +[environment variables config file](https://android.googlesource.com/platform/build/soong/+/main/README.md#environment-variables-config-file). As an example, [build/soong/docs/rbe.json](rbe.json) is a config that enables RBE in the build. Once the config file is created, you need to let Soong load the config file by specifying `ANDROID_BUILD_ENVIRONMENT_CONFIG_DIR` environment diff --git a/docs/tidy.md b/docs/tidy.md index 2eb8234c7..ae0ca9360 100644 --- a/docs/tidy.md +++ b/docs/tidy.md @@ -24,7 +24,7 @@ $ WITH_TIDY=1 CLANG_ANALYZER_CHECKS=1 make ``` The default global clang-tidy checks and flags are defined in -[build/soong/cc/config/tidy.go](https://android.googlesource.com/platform/build/soong/+/refs/heads/master/cc/config/tidy.go). +[build/soong/cc/config/tidy.go](https://android.googlesource.com/platform/build/soong/+/refs/heads/main/cc/config/tidy.go). ## Module clang-tidy properties @@ -34,7 +34,7 @@ The global default can be overwritten by module properties in Android.bp. ### `tidy`, `tidy_checks`, and `ALLOW_LOCAL_TIDY_TRUE` For example, in -[system/bpf/Android.bp](https://android.googlesource.com/platform/system/bpf/+/refs/heads/master/Android.bp), +[system/bpf/Android.bp](https://android.googlesource.com/platform/system/bpf/+/refs/heads/main/Android.bp), clang-tidy is enabled explicitly and with a different check list: ``` cc_defaults { @@ -69,7 +69,7 @@ disabled, although `cert-*` is selected. Some modules might want to disable clang-tidy even when environment variable `WITH_TIDY=1` is set. Examples can be found in -[system/netd/tests/Android.bp](https://android.googlesource.com/platform/system/netd/+/refs/heads/master/tests/Android.bp) +[system/netd/tests/Android.bp](https://android.googlesource.com/platform/system/netd/+/refs/heads/main/tests/Android.bp) ``` cc_test { name: "netd_integration_test", @@ -78,7 +78,7 @@ cc_test { tidy: false, // cuts test build time by almost 1 minute ``` and in -[bionic/tests/Android.bp](https://android.googlesource.com/platform/bionic/+/refs/heads/master/tests/Android.bp). +[bionic/tests/Android.bp](https://android.googlesource.com/platform/bionic/+/refs/heads/main/tests/Android.bp). ``` cc_test_library { name: "fortify_disabled_for_tidy", @@ -97,7 +97,7 @@ The global tidy checks are enabled as warnings. If a C/C++ module wants to be free of certain clang-tidy warnings, it can chose those checks to be treated as errors. For example -[system/core/libsysutils/Android.bp](https://android.googlesource.com/platform/system/core/+/refs/heads/master/libsysutils/Android.bp) +[system/core/libsysutils/Android.bp](https://android.googlesource.com/platform/system/core/+/refs/heads/main/libsysutils/Android.bp) has enabled clang-tidy explicitly, selected its own tidy checks, and set three groups of tidy checks as errors: ``` @@ -130,7 +130,7 @@ to clang-tidy. This usage should now be replaced with the Some other tidy flags examples are `-format-style=` and `-header-filter=` For example, in -[art/odrefresh/Android.bp](https://android.googlesource.com/platform/art/+/refs/heads/master/odrefresh/Android.bp), +[art/odrefresh/Android.bp](https://android.googlesource.com/platform/art/+/refs/heads/main/odrefresh/Android.bp), we found ``` cc_defaults { |
