docs, pw_log_tokenized: Use inclusive language Bug: 386 Change-Id: I41d32a3ab1f24224576fc36ff46c572613ba5ab8 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/46721 Commit-Queue: Rob Mohr <mohrr@google.com> Pigweed-Auto-Submit: Rob Mohr <mohrr@google.com> Reviewed-by: Armando Montanez <amontanez@google.com>
diff --git a/docs/build_system.rst b/docs/build_system.rst index 54b7e65..3bb4492 100644 --- a/docs/build_system.rst +++ b/docs/build_system.rst
@@ -185,7 +185,7 @@ intended to be a guide on how to use GN. To learn more about the tool itself, refer to the official `GN reference`_. -.. _GN reference: https://gn.googlesource.com/gn/+/master/docs/reference.md +.. _GN reference: https://gn.googlesource.com/gn/+/HEAD/docs/reference.md Entrypoint: .gn --------------- @@ -289,7 +289,7 @@ } .. warning:: - Pigweed's default toolchain is never used, so it is set to a dummy toolchain + Pigweed's default toolchain is never used, so it is set to an empty toolchain which doesn't define any tools. ``//BUILD.gn`` contains conditions which check that the current toolchain is not the default before declaring any GN target dependencies to prevent the default toolchain from evaluating any other BUILD @@ -411,15 +411,15 @@ build. For information on Pigweed's target system, refer to :ref:`docs-targets`. -The dummy toolchain +The empty toolchain ------------------- -Pigweed's ``BUILDCONFIG.gn`` sets the project's default toolchain to a "dummy" +Pigweed's ``BUILDCONFIG.gn`` sets the project's default toolchain to a "empty" toolchain which does not specify any compilers or override any build arguments. Downstream projects are recommended to do the same, following the steps described in :ref:`top-level-build` to configure builds for each of their Pigweed targets. -.. admonition:: Why use a dummy? +.. admonition:: Why use an empty toolchain? To support some of its advanced (and useful!) build features, Pigweed requires the ability to generate new toolchains on the fly. This requires having @@ -567,6 +567,7 @@ and platforms in the '//pw_build/platforms' and '//pw_build/constraints' directories. +.. inclusive-language: ignore .. _Bazel platforms reference: https://docs.bazel.build/versions/master/platforms.html Testing @@ -717,12 +718,16 @@ +.. inclusive-language: disable + .. _Bazel selects reference: https://docs.bazel.build/versions/master/configurable-attributes.html#select-and-dependencies .. _Bazel target_compatible_with reference: https://docs.bazel.build/versions/master/platforms.html#skipping-incompatible-targets .. _Bazel config reference: https://docs.bazel.build/versions/master/skylark/config.html +.. inclusive-language: enable + Pigweeds configuration ^^^^^^^^^^^^^^^^^^^^^^ @@ -1031,4 +1036,4 @@ @pigweed//pw_chrono -> @pigweed_config//:pw_chrono_backend ^ (Injectable) | - //:time_is_relative \ No newline at end of file + //:time_is_relative
diff --git a/docs/conf.py b/docs/conf.py index 0791a4e..05da973 100644 --- a/docs/conf.py +++ b/docs/conf.py
@@ -27,7 +27,7 @@ # The suffix of source filenames. source_suffix = ['.rst'] -# The master toctree document. +# The master toctree document. # inclusive-language: ignore master_doc = 'index' # General information about the project.
diff --git a/docs/contributing.rst b/docs/contributing.rst index d9a7fce..92fe3c7 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst
@@ -27,6 +27,8 @@ line to your commit - Install the Pigweed presubmit check hook with ``pw presubmit --install`` +.. TODO(pwbug/209) inclusive-language: disable + #. Ensure all files include the correct copyright and license headers #. Include any necessary changes to the documentation #. Run :ref:`module-pw_presubmit` to detect style or compilation issues before @@ -37,6 +39,8 @@ core team, you can ask the reviewer to add the `+2 CQ` vote, which will trigger a rebase and submit once the builders pass +.. TODO(pwbug/209) inclusive-language: enable + .. note:: If you have any trouble with this flow, reach out in our `chat room @@ -230,7 +234,11 @@ If you ever need to bypass the presubmit hook (due to it being broken, for example) you may push using this command: +.. TODO(pwbug/209) inclusive-language: disable + .. code:: bash $ git push origin HEAD:refs/for/master --no-verify +.. TODO(pwbug/209) inclusive-language: enable +
diff --git a/docs/getting_started.rst b/docs/getting_started.rst index dd00eaa..e49adfc 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst
@@ -9,7 +9,7 @@ We don't yet have thorough documentation for leveraging Pigweed in a separate project (our intended use case!). The `sample project - <https://pigweed.googlesource.com/pigweed/sample_project/+/refs/heads/master/README.md>`_ + <https://pigweed.googlesource.com/pigweed/sample_project/+/main/README.md>`_ shows how to use Pigweed as a library in your broader project, but you may need further guidance. @@ -376,7 +376,7 @@ Check out the sample project ---------------------------- We have a `sample project -<https://pigweed.googlesource.com/pigweed/sample_project/+/refs/heads/master/README.md>`_ +<https://pigweed.googlesource.com/pigweed/sample_project/+/main/README.md>`_ that demonstrates how to use Pigweed in your own project. Note that there are many ways to leverage Pigweed and the sample project is one approach. @@ -392,7 +392,7 @@ ------------------------------------ We don't yet have thorough documentation for leveraging Pigweed in a separate project (our intended use case!). The `sample project -<https://pigweed.googlesource.com/pigweed/sample_project/+/refs/heads/master/README.md>`_ +<https://pigweed.googlesource.com/pigweed/sample_project/+/main/README.md>`_ shows how to use Pigweed as a library in your broader project, but you may need further guidance.
diff --git a/docs/index.rst b/docs/index.rst index 28cf4ab..3fd88d9 100644 --- a/docs/index.rst +++ b/docs/index.rst
@@ -125,7 +125,7 @@ Google Test, `pw_unit_test <module-pw_unit_test>`_ is built on top of embedded friendly primitives; for example, it does not use dynamic memory allocation. Additionally, it is easy to port to new target platforms by implementing the -`test event handler interface <https://pigweed.googlesource.com/pigweed/pigweed/+/refs/heads/master/pw_unit_test/public/pw_unit_test/event_handler.h>`_. +`test event handler interface <https://cs.opensource.google/pigweed/pigweed/+/main:pw_unit_test/public/pw_unit_test/event_handler.h>`_. Like other modules in Pigweed, ``pw_unit_test`` is designed for use in established codebases with their own build system, without the rest of Pigweed
diff --git a/docs/python_build.rst b/docs/python_build.rst index 7fab838..59496da 100644 --- a/docs/python_build.rst +++ b/docs/python_build.rst
@@ -282,7 +282,7 @@ The ``.wheel`` subtarget of ``pw_python_package`` records the location of the generated wheel with `GN metadata -<https://gn.googlesource.com/gn/+/master/docs/reference.md#var_metadata>`_. +<https://gn.googlesource.com/gn/+/HEAD/docs/reference.md#var_metadata>`_. Wheels for a Python package and its transitive dependencies can be collected from the ``pw_python_package_wheels`` key. See :ref:`module-pw_build-python-dist`.
diff --git a/pw_log_tokenized/docs.rst b/pw_log_tokenized/docs.rst index 206c87e..0871c6b 100644 --- a/pw_log_tokenized/docs.rst +++ b/pw_log_tokenized/docs.rst
@@ -58,7 +58,7 @@ :param message: The log message format string (untokenized) :type message: :c:texpr:`const char*` - .. _Metadata: https://cs.opensource.google/pigweed/pigweed/+/master:pw_log_tokenized/public/pw_log_tokenized/log_tokenized.h;l=113 + .. _Metadata: https://cs.opensource.google/pigweed/pigweed/+/HEAD:pw_log_tokenized/public/pw_log_tokenized/log_tokenized.h;l=113 For instructions on how to implement a custom tokenization macro, see :ref:`module-pw_tokenizer-custom-macro`.