From 1b2c01eabef514fe3a21a3303ffcc755c0093e55 Mon Sep 17 00:00:00 2001 From: Kayce Basques Date: Fri, 14 Jun 2024 19:26:34 +0000 Subject: [PATCH] docs: Update changelog MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: Iec00b35e9b44e2f2ecc8a62dccfcb581029ca133 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/216153 Reviewed-by: Rob Mohr Commit-Queue: Auto-Submit Lint: Lint 🤖 Pigweed-Auto-Submit: Kayce Basques Presubmit-Verified: CQ Bot Account --- docs/_static/js/changelog.js | 28 +- docs/changelog.rst | 771 +++++++++++++++++- pw_build/bazel.rst | 4 + pw_chrono/docs.rst | 14 +- pw_digital_io_linux/docs.rst | 5 +- targets/host_device_simulator/target_docs.rst | 3 + 6 files changed, 804 insertions(+), 21 deletions(-) diff --git a/docs/_static/js/changelog.js b/docs/_static/js/changelog.js index bd15f2ede..ed141effe 100644 --- a/docs/_static/js/changelog.js +++ b/docs/_static/js/changelog.js @@ -213,9 +213,9 @@ async function render(commits) { rest += `${'-'.repeat(title.length)}\n\n`; rest += '.. changelog_highlights_start\n\n'; rest += `Highlights (${start} to ${end}):\n\n`; - rest += '* Highlight #1\n'; - rest += '* Highlight #2\n'; - rest += '* Highlight #3\n\n'; + rest += '* ****: Description\n'; + rest += '* ****: Description\n'; + rest += '* ****: Description\n\n'; rest += '.. changelog_highlights_end\n\n'; rest += 'Active SEEDs\n'; rest += '============\n'; @@ -228,13 +228,13 @@ async function render(commits) { rest += '.. space.\n\n'; const categories = [ 'Modules', - 'Build', - 'Targets', + 'Build systems', + 'Hardware targets', 'Language support', 'OS support', 'Docs', 'SEEDs', - 'Third party', + 'Third-party software', 'Miscellaneous', ]; for (let i = 0; i < categories.length; i++) { @@ -245,11 +245,19 @@ async function render(commits) { let topics = Object.keys(commits[category]); topics.sort(); topics.forEach((topic) => { - rest += `${topic}\n`; - rest += `${'-'.repeat(topic.length)}\n\n\n`; + // Some topics should not be rendered because they're redundant. + // E.g. we already have a "Docs" H3 heading so we don't need another + // "docs" H4 heading right after it. + const topicsToSkip = ['docs']; + if (!topicsToSkip.includes(topic)) { + rest += `${topic}\n`; + rest += `${'-'.repeat(topic.length)}\n\n\n`; + } commits[category][topic].forEach((commit) => { - const change = commit.change.replaceAll('`', '`'); - // The double underscores are signficant: + // Escape any backticks that are used in the commit message. + const change = commit.change.replaceAll('`', '\\`'); + // Use double underscores to make the links anonymous so that Sphinx + // doesn't error when the same link is used multiple times. // https://github.com/sphinx-doc/sphinx/issues/3921 rest += `* \`${commit.title}\n <${change}>\`__\n`; if (commit.issue) diff --git a/docs/changelog.rst b/docs/changelog.rst index 56b5a4e6f..c3d001df6 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -14,10 +14,775 @@ Talk to the team at Pigweed Live .. _docs-changelog-latest: ------------ -May 30, 2024 +Jun 13, 2024 ------------ .. changelog_highlights_start +.. _bootstrap.fish: https://cs.opensource.google/pigweed/pigweed/+/main:bootstrap.fish + +Highlights (May 30, 2024 to Jun 13, 2024): + +``pw_malloc`` now supports :ref:`pw_allocator `-based +backends. + +* **GitHub Actions guidance**: The new :ref:`docs-github` guide shows you + how to set up GitHub Actions for Pigweed projects. +* **New pw_build Bazel rules**: ``pw_py_test`` rule wraps ``py_test``, + :ref:`pw_elf_to_dump ` takes a + binary executable and produces a text file containing the full binary layout, + and :ref:`pw_elf_to_bin ` rule takes + a binary executable and produces a file with all ELF headers removed. +* **Improved Fish shell support**: The ``pw`` and ``pw build`` + commands now support `Fish `__ shell completion. + The new `bootstrap.fish`_ script demonstrates how to bootstrap a Pigweed + project from a Fish shell and makes it easier for Fish users to contribute + to upstream Pigweed. +* **More informative modules index**: The :ref:`modules index ` + now shoes useful metadata for each module, such as a summary of the + module's purpose and the programming languages that the module supports. + +.. changelog_highlights_end + +Active SEEDs +============ +Help shape the future of Pigweed! Please visit :ref:`seed-0000` +and leave feedback on the RFCs (i.e. SEEDs) marked +``Open for Comments``. + +Modules +======= + +pw_allocator +------------ +The ``pw::allocator::Layout`` constructor is now marked ``explicit`` to +ensure that functions that take ``Layout`` instances as arguments don't +silently accept and convert other types. The ``pw::allocator::FreeList`` and +``pw::allocator::FreeListHeap`` interfaces have been removed. + +* `Make Layout constructor explicit + `__ +* `Remove FreeList and FreeListHeap + `__ + (issue `#328076428 `__) +* `Refactor Bucket chunk list + `__ + (issue `#345526413 `__) + +pw_analog +--------- +* `Add module metadata + `__ + (issue `#339741960 `__) + +pw_android_toolchain +-------------------- +* `Add module metadata + `__ + (issue `#339741960 `__) + +pw_arduino_build +---------------- +* `Add module metadata + `__ + (issue `#339741960 `__) + +pw_assert +--------- +* `Add module metadata + `__ + (issue `#339741960 `__) + +pw_async +-------- +* `Add module metadata + `__ + (issue `#339741960 `__) + +pw_async2 +--------- +* `Fix location of backends in sitenav + `__ + (issue `#339741960 `__) + +pw_base64 +--------- +* `Add module metadata + `__ + (issue `#339741960 `__) + +pw_bloat +-------- +* `Build and run \`pw bloat\` CLI command in Bazel + `__ +* `Add module metadata + `__ + (issue `#339741960 `__) + +pw_blob_store +------------- +* `Add module metadata + `__ + (issue `#339741960 `__) + +pw_bluetooth +------------ +* `Add module metadata + `__ + (issue `#339741960 `__) +* `Add HCI StatusCode values + `__ + +pw_bluetooth_hci +---------------- +* `Add module metadata + `__ + (issue `#339741960 `__) + +pw_bluetooth_profiles +--------------------- +* `Add module metadata + `__ + (issue `#339741960 `__) + +pw_bluetooth_proxy +------------------ +The new ``pw::bluetooth::proxy::HasSendAclCapability()`` function indicates +whether the proxy has the capability to send ACL packets. + +* `Remove H4HciPacketSendFn alias + `__ + (issue `#326499764 `__) +* `Fix const on sendGattNotify param + `__ + (issue `#326499764 `__) +* `Mark unused parameters with [[maybe_unused]] + `__ + (issue `#345526399 `__) +* `Add maybe_unused to make downstream happy + `__ + (issue `#344031126 `__) +* `Add ProxyHost::HasSendAclCapability() + `__ + (issue `#344030724 `__) +* `Update H4HciPacket construction + `__ +* `Add sendGattNotify stub + `__ + (issue `#344031126 `__) +* `Fix compilation errors + `__ +* `Pass H4 as event type plus an HCI span + `__ + (issue `#326499611 `__) +* `Tweak CreateNonInteractingToHostBuffer to take array + `__ + (issue `#326499611 `__) + +pw_boot_cortex_m +---------------- +* `Add module metadata + `__ + +pw_build +-------- +The new ``pw_py_test`` rule wraps ``py_test`` and defaults to setting +``target_compatible_with`` to ``host`` only. The new +:ref:`pw_elf_to_dump ` rule takes a +binary executable and produces a text file containing the full binary layout. +The new :ref:`pw_elf_to_bin ` rule takes +a binary executable and produces a file with all ELF headers removed. + +* `Move host_backend_alias (part 1) + `__ + (issue `#344654805 `__) +* `Add python.install into the default GN group + `__ +* `Introduce pw_py_test to bazel + `__ +* `Add module metadata + `__ + (issue `#339741960 `__) +* `Clarify docs on pw_elf_to_bin + `__ +* `Update intro + `__ + (issue `#339741960 `__) +* `Add pw_elf_to_dump rule + `__ +* `Add pw_elf_to_bin rule + `__ +* `Populate executable field in return from link_cc utility + `__ + +pw_build_info +------------- +* `Add module metadata + `__ + +pw_build_mcuxpresso +------------------- +* `Add module metadata + `__ + (issue `#339741960 `__) + +pw_bytes +-------- +* `Add module metadata + `__ + (issue `#339741960 `__) + +pw_channel +---------- +* `Add module metadata + `__ + (issue `#339741960 `__) +* `Update function documentation + `__ +* `Remove manual registration from epoll channel + `__ + +pw_checksum +----------- +* `Add module metadata + `__ + (issue `#339741960 `__) + +pw_chre +------- +* `Add module metadata + `__ + (issue `#339741960 `__) + +pw_chrono +--------- +:ref:`libc time wrappers ` are now +provided to improve compatibility with software not written for embedded +systems that depends on ``gettimeofday`` and ``time`` from POSIX. + +* `Group common backends in the GN build + `__ +* `Introduce SystemClock backed link time wrappers + `__ + +pw_cli +------ +.. _Fish: https://fishshell.com/ + +The ``pw`` and ``pw build`` commands now support `Fish`_ shell completion. + +* `Fish shell completion + `__ + +pw_clock_tree +------------- +The new ``pw::clock_tree::ClockSourceNoOp`` class can be used to satisfy +the dependency of a source clock tree element for other clock source classes. +The new ``pw::clock_tree::ElementController`` class provides easier integration +of optional clock tree logic into existing drivers. + +* `Introduce ClockSourceNoOp class + `__ + (issue `#331672574 `__) +* `Introduce ElementController class + `__ + (issue `#331672574 `__) +* `Fix source set name and visibility + `__ + (issue `#331672574 `__) + +pw_clock_tree_mcuxpresso +------------------------ +* `Comment clean up + `__ + (issue `#331672574 `__) +* `Add ClockMcuxpressoRtc support + `__ + (issue `#331672574 `__) +* `Remove unnecessary pw:: + `__ + (issue `#331672574 `__) +* `Add ClockMcuxpressoAudioPll support + `__ + (issue `#331672574 `__) +* `Configure ClkIn as source for osc_clk + `__ + (issue `#331672574 `__) +* `Make Mclk and ClkIn dependent elements + `__ + (issue `#331672574 `__) +* `Move example code out of docs + `__ + (issue `#331672574 `__) +* `Fix source set name and visibility + `__ + (issue `#331672574 `__) + +pw_console +---------- +Theme colors are now correctly applied when running ``pw console`` with the +``--config-file`` option. + +* `Reload theme when using a config-file + `__ + +pw_containers +------------- +The ``pw::Vector::at()`` function signature was changed to take ``size_t`` +instead of ``size_type``. The new ``pw::InlineVarLenEntryQueue::try_push()`` +function is similar to ``pw::InlineVarLenEntryQueue::push_overwrite()`` but it +drops entries instead of overwriting old ones. The new +``pw::InlineVarLenEntryQueue::max_size()`` function returns the maximum number +of empty entries. + +* `Make Vector::at() use size_t + `__ +* `Disallow deletion from InlineVarLenEntryQueue base + `__ +* `InlineVarLenEntryQueue::try_push() function + `__ + +pw_digital_io +------------- +* `Remove invalid digital_io_controller reference + `__ + +pw_digital_io_linux +------------------- +``pw_digital_io_linux`` now supports input interrupts. The new +:ref:`watch ` command in the CLI +tool configures a GPIO line as an input and watches for interrupt events. + +* `Add trigger option to CLI watch command + `__ +* `Add "watch" command + `__ +* `Add support for input interrupts + `__ +* `Move examples out to compiled source files + `__ +* `Update mock_vfs + `__ +* `Add log_errno.h + `__ + +pw_docgen +--------- +* `Update module metadata status badge colors + `__ + (issue `#339741960 `__) +* `Add module metadata + `__ + (issue `#339741960 `__) +* `Fix search results increasing in width + `__ + +pw_env_setup +------------ +The new `bootstrap.fish`_ script demonstrates how to bootstrap a Pigweed +project from a Fish shell and makes it easier for Fish users to contribute +to upstream Pigweed. + +* `Update clang next version + `__ +* `Bootstrap fish-shell support + `__ + +pw_grpc +------- +* `Remove send queue timeout + `__ + (issue `#345088816 `__) + +pw_ide +------ +* `Add module metadata + `__ +* `Preserve modified editor settings + `__ + (issue `#344681641 `__) +* `Fix constant Pylance crashes + `__ + (issue `#338607100 `__) + +pw_log +------ +* `Add module metadata + `__ + (issue `#339741960 `__) +* `Cast log level to int32_t + `__ + (issue `#343518613 `__) + +pw_log_string +------------- +* `Introduce link time assert() wrapper for newlib + `__ +* `Set default log backend + `__ + +pw_malloc +--------- +``pw_malloc`` now supports :ref:`pw_allocator `-based +backends. + +* `Add allocator backends + `__ + +pw_multibuf +----------- +The new ``pw::multibuf::MultiBuf::IsContiguous()`` method checks if a multibuf +is contiguous and the new ``pw::multibuf::MultiBuf::ContiguousSpan()`` method +provides a way to access contiguous data as a span. The new ``CopyTo()``, +``CopyFrom()``, and ``CopyFromAndTruncate()`` methods also simplify +interactions with contiguous byte spans. + +* `Contiguous span functions + `__ +* `Functions for copying into and out of a MultiBuf + `__ +* `Truncate after an iterator + `__ +* `AdvanceToData in iterator constructor + `__ +* `Fix Truncate(0) on empty MultiBuf + `__ +* `SimpleAllocatorForTest + `__ + +pw_multisink +------------ +The new ``pw::multisink::MultiSink::GetUnreadEntriesSize()`` and +``pw::multisink::MultiSink::UnsafeGetUnreadEntriesSize()`` methods +implement :ref:`seed-0124`. The new ``PW_MULTISINK_CONFIG_LOCK_TYPE`` +macro configures the underlying lock that's used to guard multisink +reads or writes. + +* `Add GetUnreadEntriesSize to Drain + `__ +* `Add option to inject a user defined lock + `__ + +pw_presubmit +------------ +* `Add --fresh to cmake presubmits + `__ +* `Add coverage of rp2040 build + `__ + (issue `#342638018 `__) +* `Add module metadata + `__ + (issue `#339741960 `__) +* `Remove shellcheck from lintformat program + `__ + +pw_protobuf +----------- +* `Add module metadata + `__ + (issue `#339741960 `__) + +pw_ring_buffer +-------------- +* `Add EntriesSize API to Reader + `__ + (issue `#337150071 `__) + +pw_router +--------- +* `Add module metadata + `__ + (issue `#339741960 `__) + +pw_rpc +------ +The Python client API now uses positional-only arguments. + +* `Use positional-only arguments in Python client API + `__ +* `Add module metadata + `__ + (issue `#339741960 `__) +* `Fix hyperlink + `__ + +pw_sensor +--------- +* `Add Bazel support for Python package + `__ + +pw_spi +------ +* `Fix sitenav location for RP2040 backend + `__ + (issue `#339741960 `__) + +pw_spi_rp2040 +------------- +* `Add module metadata + `__ + (issue `#339741960 `__) + +pw_stream +--------- +* `Fix include in mpsc_stream + `__ + +pw_stream_uart_mcuxpresso +------------------------- +* `Make dma_stream Write of size 0 succeed + `__ +* `InterruptSafeWriter example + `__ + (issue `#343773769 `__) +* `Stream example + `__ + (issue `#343773769 `__) +* `Use clock tree + `__ + (issue `#331672574 `__) +* `DMA stream example + `__ + (issue `#343773769 `__) + +pw_sync +------- +The new ``pw_targets_FREERTOS_BACKEND_GROUP`` GN rule sets up multiple +modules to use FreeRTOS backends. + +* `Group common backends in the GN build + `__ + +pw_system +--------- +``pw-system-console`` now connects to the first detected port if ``--device`` +isn't provided and only one port is detected or it shows an interactive +prompt if multiple ports are detected. :ref:`target-host-device-simulator-demo` +now shows how to run ``pw-system-console`` with ``host_device_simulator`` in +Bazel-based projects. + +* `Console interactive serial port selection + `__ + (issue `#343949763 `__) +* `Host device simulator entrypoint + `__ +* `Move config variables to config.h + `__ +* `Mention that extra libs need alwayslink + `__ +* `Add host_device_simulator transitions + `__ + +pw_target_runner +---------------- +* `Switch to Bazel build + `__ +* `Add module metadata + `__ + (issue `#339741960 `__) + +pw_thread +--------- +* `Group common backends in the GN build + `__ + +pw_thread_freertos +------------------ +* `Expand comment to help when debugging linker errors + `__ + +pw_toolchain +------------ +* `Enable PIC on host + `__ +* `Add bazel toolchain for cortex-m0plus + `__ + (issue `#346609655 `__) +* `Add module metadata + `__ + (issue `#339741960 `__) +* `Add IOKit and Security headers to mac toolchains + `__ + +pw_toolchain_bazel +------------------ +* `Add cortex-a32 mcpu value + `__ + (issue `#342510882 `__) + +pw_transfer +----------- +* `Remove unused imports + `__ +* `Fix ConcurrentModificationException in handleTimeouts() + `__ + (issue `#322919275 `__) +* `Always terminate transfers on stream reopen + `__ + +pw_uart +------- +* `Add module metadata + `__ + (issue `#339741960 `__) + +pw_varint +--------- +* `Add module metadata + `__ + (issue `#339741960 `__) + +pw_watch +-------- +Watching now works in directories other than ``PW_ROOT``. + +* `Enable watching from non-PW_ROOT + `__ + (issue `#328083083 `__) + +pw_web +------ +* `Get icon fonts via Google Fonts URL + `__ + (issue `#332587834 `__) +* `Fix last column filling space in log table + `__ + +Build systems +============= + +Bazel +----- +* `Stop using deprecated pw_facade aliases + `__ + (issue `#328679085 `__) +* `Don't use llvm_toolchain for fuchsia_clang + `__ + (issue `#346354914 `__) +* `Fix reference to nonexistent file + `__ +* `Roll latest rules_libusb + `__ +* `No integration tests in wildcard build + `__ + (issue `#344654806 `__) +* `Move integration build config in-repo + `__ + (issue `#344654806 `__) + +Hardware targets +================ + +host_device_simulator +--------------------- +* `Make host_device_simulator_binary \`bazel run\`-able + `__ + +rp2040 +------ +* `Add bazel picotool support + `__ +* `Add bazel support for rp2040_utils pylib + `__ + (issue `#342634966 `__) +* `Support running tests using the debug probe + `__ +* `Add pico/debug probe filtering flags + `__ +* `Temporarily disable remaining failing rp2040 tests + `__ +* `Fix test runner scripts to correct check if args are specified + `__ +* `Support bazel wildcard build on rp2040 + `__ + (issue `#343467774, `__) + +stm32f429i +---------- +* `Add baremetal bazel build support + `__ + (issue `#344661765 `__) + +OS support +========== + +Zephyr +------ +* `Fix typo + `__ + +FreeRTOS +-------- +FreeRTOS application function implementations like ``vApplicationStackOverflowHook()`` +are now shared between multiple hardware targets. + +* `Share common FreeRTOS function implementations + `__ + +Docs +==== +The :ref:`modules index ` now includes metadata for each +module such as a summary of each module and what languages each module +supports. The ``pigweed.dev`` sitenav was simplified. +:ref:`docs-blog-02-bazel-feature-flags` was published. A "skip to main +content" accessibility feature was added to ``pigweed.dev``. + +* `Fix Python package dependencies for sphinx + `__ +* `Auto-generate modules index from metadata + `__ + (issue `#339741960 `__) +* `Update sitenav + `__ +* `Update homepage tagline + `__ +* `Add "skip to main content" a11y feature + `__ + (issue `#344643289 `__) +* `blog: Bazel feature flags + `__ +* `Update changelog + `__ + +Third-party software support +============================ +* `Add @libusb to bazel workspace + `__ +* `Symlink probe-rs binary into common location + `__ +* `Add probe-rs + `__ + +mimxrt595 +--------- +* `Upgrade to SDK_2_14_0_EVK-MIMXRT59 + `__ + (issue `#343775421 `__) + +GitHub +------ +The new :ref:`docs-github` guide shows you how to set up GitHub Actions +for Pigweed projects. + +* `Fix step name + `__ +* `Add basic workflow and docs + `__ + (issue `#340900493 `__) + +io_bazel_rules_go +----------------- +* `Update to fork which disables warnings + `__ + +pigweed.json +============ +* `Add config for Bazel builders + `__ + (issue `#275107504 `__) + +------------ +May 30, 2024 +------------ Highlights (May 17, 2024 to May 30, 2024): * **Clock management**: The new :ref:`module-pw_clock_tree` module manages @@ -26,7 +791,7 @@ Highlights (May 17, 2024 to May 30, 2024): * **GitHub Actions**: The new :ref:`docs-github` guide shows you how to set up GitHub Actions to build and test a Bazel-based Pigweed project when a pull request is received. -* **pw_system and Bazel**:ref:`module-pw_system` usage in Bazel has been +* **pw_system and Bazel**: :ref:`module-pw_system` usage in Bazel has been simplified by gathering all required ``pw_system`` components into one target and providing label flags that can set platform-dependent dependencies. @@ -34,8 +799,6 @@ Highlights (May 17, 2024 to May 30, 2024): class sends and receives data through a file descriptor, with read and write notifications backed by Linux's epoll system. -.. changelog_highlights_end - Active SEEDs ============ Help shape the future of Pigweed! Please visit :ref:`seed-0000` diff --git a/pw_build/bazel.rst b/pw_build/bazel.rst index 165afca82..a0fa9e726 100644 --- a/pw_build/bazel.rst +++ b/pw_build/bazel.rst @@ -337,6 +337,8 @@ This should result in a ``test.map`` file generated next to the ``test`` binary. Note that it's only partially compatible with the ``cc_binary`` interface and certain things are not implemented like make variable substitution. +.. _module-pw_build-bazel-pw_elf_to_bin: + pw_elf_to_bin ------------- The ``pw_elf_to_bin`` rule takes in a binary executable target and produces a @@ -354,6 +356,8 @@ this type of file is booting directly on hardware with no bootloader. bin_out = "main.bin", ) +.. _module-pw_build-bazel-pw_elf_to_dump: + pw_elf_to_dump -------------- The ``pw_elf_to_dump`` rule takes in a binary executable target and produces a diff --git a/pw_chrono/docs.rst b/pw_chrono/docs.rst index b0c6f5c40..eb4b6ce38 100644 --- a/pw_chrono/docs.rst +++ b/pw_chrono/docs.rst @@ -552,14 +552,10 @@ Example in C++ foo_timer.InvokeAfter(42ms); // DoFoo will be invoked after 42ms. } -.. toctree:: - :hidden: - :maxdepth: 1 - - Backends +.. _module-pw_chrono-libc-time-wrappers: ------------------ -Libc Time Wrappers +libc time wrappers ------------------ The `gettimeofday ` and `time ` @@ -589,3 +585,9 @@ Wrap ``gettimeofday`` and ``time`` with an implementation that uses determined by the SystemClock backend epoch, which on most embedded systems will be time since boot. Use this option if you don't care about the time returned being close to actual time, but do care that it increments like a real clock. + +.. toctree:: + :hidden: + :maxdepth: 1 + + Backends diff --git a/pw_digital_io_linux/docs.rst b/pw_digital_io_linux/docs.rst index b2ea27bb4..46f9d3e7d 100644 --- a/pw_digital_io_linux/docs.rst +++ b/pw_digital_io_linux/docs.rst @@ -91,6 +91,7 @@ Configure an interrupt pin and handle events :linenos: :lines: 15- +.. _module-pw_digital_io_linux-cli: ---------------------- Command-Line Interface @@ -143,9 +144,11 @@ Arguments: * ``LINE``: GPIO line number (e.g. ``1``) * ``VALUE``: the value to set (``0`` = inactive or ``1`` = active) +.. _module-pw_digital_io_linux-cli-watch: + ``watch`` ========= -Configure a GPIO line as an input and watch for interrupt evnts. +Configure a GPIO line as an input and watch for interrupt events. By default, both rising and falling edges will trigger an event. This can be changed via the ``-t`` option. diff --git a/targets/host_device_simulator/target_docs.rst b/targets/host_device_simulator/target_docs.rst index a08248412..1a014ca5e 100644 --- a/targets/host_device_simulator/target_docs.rst +++ b/targets/host_device_simulator/target_docs.rst @@ -64,6 +64,9 @@ Setup dir_pw_third_party_nanopb = "//environment/packages/nanopb" dir_pw_third_party_freertos = "//environment/packages/freertos" + +.. _target-host-device-simulator-demo: + ----------------------------- Building and running the demo -----------------------------