Skip to content

Commit

Permalink
docs: Replace 'bazel' with 'bazelisk'
Browse files Browse the repository at this point in the history
Change-Id: Ia2866a650fe86c5fed6d8c3a6dc108061e07e9b2
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/226377
Lint: Lint 🤖 <[email protected]>
Commit-Queue: Rob Mohr <[email protected]>
Presubmit-Verified: CQ Bot Account <[email protected]>
Reviewed-by: Kayce Basques <[email protected]>
  • Loading branch information
mohrr authored and CQ Bot Account committed Aug 15, 2024
1 parent 3dcd600 commit 0975df5
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 17 deletions.
2 changes: 1 addition & 1 deletion docs/automated_analysis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ AddressSanitizer by building with the appropriate flag:

.. code-block:: sh
bazel build --@pigweed//pw_toolchain/host_clang:asan //...
bazelisk build --@pigweed//pw_toolchain/host_clang:asan //...
If you're building your own toolchain, you can add
``@pigweed//pw_toolchain_bazel/flag_sets:asan`` to it.
Expand Down
6 changes: 3 additions & 3 deletions docs/bazel_compatibility.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ upstream Pigweed for non-host platforms:

.. code-block:: sh
bazel build --config=rp2040 //...
bazelisk build --config=rp2040 //...
The bulk of this document describes :ref:`recommended patterns
<docs-bazel-compatibility-recommended>` for expressing compatibility in various
Expand Down Expand Up @@ -120,7 +120,7 @@ intended platform by explicitly listing it in CI invocations:
# //pw_system:system_example is a binary that should build for this
# platform.
bazel build --config=rp2040 //... //pw_system:system_example
bazelisk build --config=rp2040 //... //pw_system:system_example
.. _docs-bazel-compatibility-well-known:

Expand Down Expand Up @@ -843,7 +843,7 @@ is known to fall into one of those three buckets. If you run:
.. code-block:: sh
bazel build --config=rp2040 //...
bazelisk build --config=rp2040 //...
Bazel will attempt to build all Pigweed build targets for the specified
platform, with the exception of targets that are explicitly annotated as not
Expand Down
26 changes: 13 additions & 13 deletions docs/build_system.rst
Original file line number Diff line number Diff line change
Expand Up @@ -586,9 +586,9 @@ commonly used commands used in bazel are;

.. code-block:: sh
bazel build //your:target
bazel test //your:target
bazel coverage //your:target
bazelisk build //your:target
bazelisk test //your:target
bazelisk coverage //your:target
.. note:: Code coverage support is only available on the host for now.

Expand All @@ -599,7 +599,7 @@ platform (e.g. stm32f429i-discovery) a slight variation is required.

.. code-block:: sh
bazel build //your:target \
bazelisk build //your:target \
--platforms=@pigweed//pw_build/platforms:lm3s6965evb
For more information on how to create your own platforms refer to the official
Expand Down Expand Up @@ -628,7 +628,7 @@ Then, run:

.. code-block:: sh
bazel test //your:test --platforms=//your/platform --run_under=//your_handler
bazelisk test //your:test --platforms=//your/platform --run_under=//your_handler
Tag conventions
~~~~~~~~~~~~~~~
Expand All @@ -643,7 +643,7 @@ use the following additional tags:

.. code-block:: sh
bazel test --test_tag_filters=-integration //...
bazelisk test --test_tag_filters=-integration //...
will run all tests *except* for these integration tests.

Expand All @@ -668,7 +668,7 @@ Making use of the code coverage functionality in Bazel is straightforward.

.. code-block:: sh
bazel coverage //pw_log/...
bazelisk coverage //pw_log/...
3. View the results using the command line utility 'lcov'.

Expand Down Expand Up @@ -774,7 +774,7 @@ and the build will continue. e.g.

.. code-block:: sh
bazel build //... --platforms=@pigweed//pw_build/platforms:lm3s6965evb
bazelisk build //... --platforms=@pigweed//pw_build/platforms:lm3s6965evb
This allows for you to easily create compatibility matricies without adversely
affecting your ability build your entire repo for a given Pigweed target.
Expand Down Expand Up @@ -825,7 +825,7 @@ however it is possible to override this from the command line. e.g.

.. code-block:: sh
bazel build //:some_target_that_needs_io --//:io=//:some_other_io
bazelisk build //:some_target_that_needs_io --//:io=//:some_other_io
Expand Down Expand Up @@ -864,7 +864,7 @@ This should work out of the box for any host operating system. E.g., running,

.. code-block:: console
bazel build //:time_is_relative
bazelisk build //:time_is_relative
will produce a working library for your host OS.

Expand All @@ -878,7 +878,7 @@ could build your library with:

.. code-block:: console
bazel build \
bazelisk build \
--@pigweed/pw_chrono:system_clock_backend=@pigweed//pw_chrono_freertos:system_clock \
//:time_is_relative
Expand Down Expand Up @@ -961,7 +961,7 @@ To build your ``//:time_is_relative`` target using this backend, you'd run,

.. code-block:: console
bazel build //:time_is_relative \
bazelisk build //:time_is_relative \
--@pigweed//pw_chrono:system_clock_backend=//pw_chrono_my_hardware_rtc:system_clock
This modifies the build graph to look something like this:
Expand Down Expand Up @@ -1007,4 +1007,4 @@ you just specify the ``--config`` on the command line:

.. code-block:: console
bazel build --config=m4 //:time_is_relative
bazelisk build --config=m4 //:time_is_relative

0 comments on commit 0975df5

Please sign in to comment.