Skip to content

Commit

Permalink
docs: Fix broken links
Browse files Browse the repository at this point in the history
Bug: 373476346
Change-Id: I92df7ef8be95b0ff99b663c619b9e0295c54157a
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242640
Lint: Lint 🤖 <[email protected]>
Presubmit-Verified: CQ Bot Account <[email protected]>
Commit-Queue: Kayce Basques <[email protected]>
Reviewed-by: Rob Mohr <[email protected]>
  • Loading branch information
Kayce Basques authored and CQ Bot Account committed Oct 28, 2024
1 parent 93656ec commit 7ddb65a
Show file tree
Hide file tree
Showing 13 changed files with 19 additions and 22 deletions.
2 changes: 1 addition & 1 deletion pw_base64/docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ C++ API reference
Rust API reference
------------------
``pw_base64``'s Rust API is documented in the
`pw_base64 crate's docs </rustdoc/pw_base64>`_.
`pw_base64 crate's docs </rustdoc/pw_base64/>`_.
4 changes: 2 additions & 2 deletions pw_build/python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -296,8 +296,8 @@ Arguments
:ref:`docs-python-build-python-gn-requirements-files`

- ``pip_generate_hashes``: (Default: false) Use ``--generate-hashes`` When
running `pip-compile <A list of requirements files to install into this
virtualenv>`_ to compute the final ``requirements.txt``
running ``pip-compile <A list of requirements files to install into this
virtualenv>`` to compute the final ``requirements.txt``

- ``source_packages``: A list of in-tree
:ref:`module-pw_build-pw_python_package` or targets that will be checked for
Expand Down
2 changes: 1 addition & 1 deletion pw_bytes/docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -145,4 +145,4 @@ project's configuration.
Rust API
--------
``pw_bytes``'s Rust API is documented in our
`rustdoc API docs </rustdoc/pw_bytes>`_.
`rustdoc API docs </rustdoc/pw_bytes/>`_.
9 changes: 4 additions & 5 deletions pw_console/py/pw_console/docs/user_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1091,12 +1091,11 @@ Log Window
Upcoming Features
-----------------

For upcoming features see the Pigweed Console Bug Hotlist at:
https://bugs.chromium.org/u/542633886/hotlists/Console

Open feature requests:
https://issues.pigweed.dev/issues?q=status:open%20pw_console%20type:feature_request

Feature Requests
~~~~~~~~~~~~~~~~

Create a feature request bugs using this template:
https://bugs.chromium.org/p/pigweed/issues/[email protected]&labels=Type-Enhancement,Priority-Medium&summary=pw_console
Set the **Type** field to **Feature Request** when creating an issue:
https://issues.pigweed.dev/issues/new?component=1194524&template=1691892
2 changes: 1 addition & 1 deletion pw_format/docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ Disambiguation: If you're looking for code formatting support, see
Rust
----
``pw_format``'s Rust API is documented in the
`pw_format crate's docs </rustdoc/pw_format>`_.
`pw_format crate's docs </rustdoc/pw_format/>`_.
2 changes: 1 addition & 1 deletion pw_status/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -408,4 +408,4 @@ in C++; instead use the :cpp:class:`pw::Status` class.
Rust API
--------
``pw_status``'s Rust API is documented in our
`rustdoc API docs </rustdoc/pw_status>`_.
`rustdoc API docs </rustdoc/pw_status/>`_.
2 changes: 1 addition & 1 deletion pw_stream/docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -433,7 +433,7 @@ Rust
----
Pigweed centric analogs to Rust ``std``'s ``Read``, ``Write``, ``Seek`` traits
as well as a basic ``Cursor`` implementation are provided by the
`pw_stream crate </rustdoc/pw_stream>`_.
`pw_stream crate </rustdoc/pw_stream/>`_.


.. toctree::
Expand Down
2 changes: 1 addition & 1 deletion pw_tokenizer/tokenization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ This is encoded as 4 bytes: ``44 a2 c9 da``.
Arguments are encoded as follows:

* **Integers** (1--10 bytes) --
`ZagZag and varint encoded <https://developers.google.com/protocol-buffers/docs/encoding#signed-integers>`_,
`ZagZag and varint encoded <https://developers.google.com/protocol-buffers/docs/encoding#signed-ints>`_,
similarly to Protocol Buffers. Smaller values take fewer bytes.
* **Floating point numbers** (4 bytes) -- Single precision floating point.
* **Strings** (1--128 bytes) -- Length byte followed by the string contents.
Expand Down
2 changes: 1 addition & 1 deletion pw_transfer/docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -890,7 +890,7 @@ The CIPD package contents can be created with this command:
pw_transfer_test_binaries
To update the CIPD package itself, follow the `internal documentation for
updating a CIPD package <go/pigweed-cipd#installing-packages-into-cipd>`_.
updating a CIPD package <http://go/pigweed-cipd#installing-packages-into-cipd>`_.

CI/CQ integration
=================
Expand Down
2 changes: 1 addition & 1 deletion pw_varint/public/pw_varint/varint.h
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ inline constexpr size_t kMaxVarint64SizeBytes = PW_VARINT_MAX_INT64_SIZE_BYTES;
/// @endcode
///
/// See the following for a description of ZigZag encoding:
/// https://developers.google.com/protocol-buffers/docs/encoding#types
/// https://protobuf.dev/programming-guides/encoding/#signed-ints
template <typename T>
constexpr std::make_unsigned_t<T> ZigZagEncode(T n) {
static_assert(std::is_signed<T>(), "Zig-zag encoding is for signed integers");
Expand Down
2 changes: 1 addition & 1 deletion pw_varint/rust/pw_varint.rs
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ fn encode_u64(data: &mut [u8], value: u64) -> Result<usize> {
// (n << 1) ^ (n >> (k - 1))
//
// See the following for a description of ZigZag encoding:
// https://developers.google.com/protocol-buffers/docs/encoding#types
// https://protobuf.dev/programming-guides/encoding/#signed-ints
fn zig_zag_encode(value: i64) -> u64 {
((value as u64) << 1) ^ ((value >> (i64::BITS - 1)) as u64)
}
Expand Down
2 changes: 1 addition & 1 deletion seed/0113-bazel-cc-toolchain-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ following problems:
there's a lot of flexibility with how you construct a toolchain config, but
very little by way of existing patterns for creating something that is
testable, sharable, or in other ways modular. The existing
`tutorial for creating a C/C++ toolchain <https://bazel.build/tutorials/ccp-toolchain-config#configuring_the_c_toolchain>`_
`tutorial for creating a C/C++ toolchain <https://bazel.build/tutorials/ccp-toolchain-config#configure-cc-toolchain>`_
illustrates expanding out the toolchain definition as a no-argument Starlark
rule.

Expand Down
8 changes: 3 additions & 5 deletions third_party/fuzztest/docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,9 @@ Add FuzzTest to your workspace with the following command.

.. tab-item:: Bazel

Set the following `label flags`_, either in your `target config`_ or on
the command line:
Set the following :ref:`label flags <docs-build_system-bazel_flags>`,
either in your :ref:`target config
<docs-build_system-bazel_configuration>` or on the command line:

* ``pw_fuzzer_fuzztest_backend`` to ``@com_google_fuzztest//fuzztest``.

Expand All @@ -77,9 +78,6 @@ Add FuzzTest to your workspace with the following command.
bazel test //... \
--@pigweed//targets:pw_fuzzer_fuzztest_backend=@com_google_fuzztest//fuzztest
.. _target config: :ref:`_docs-build_system-bazel_configuration`
.. _label flags: :ref:`_docs-build_system-bazel_flags`

Updating
========
The GN build files are generated from the third-party Bazel build files using
Expand Down

0 comments on commit 7ddb65a

Please sign in to comment.