diff options
Diffstat (limited to 'pw_string/docs.rst')
| -rw-r--r-- | pw_string/docs.rst | 65 |
1 files changed, 30 insertions, 35 deletions
diff --git a/pw_string/docs.rst b/pw_string/docs.rst index 4be6d93ae..cbd8906bf 100644 --- a/pw_string/docs.rst +++ b/pw_string/docs.rst @@ -7,7 +7,7 @@ pw_string :name: pw_string :tagline: Efficient, easy, and safe string manipulation :status: stable - :languages: C++14, C++17 + :languages: C++17 :code-size-impact: 500 to 1500 bytes - **Efficient**: No memory allocation, no pointer indirection. @@ -86,48 +86,43 @@ meets your needs. gives you the flexibility to move to smaller platforms later with much less rework. -.. _module-pw_string-get-started: +.. toctree:: + :hidden: + :maxdepth: 1 ---------------- -Getting Started ---------------- + guide + api + design + code_size -.. tab-set:: +.. grid:: 2 - .. tab-item:: GN + .. grid-item-card:: :octicon:`rocket` Get Started & Guides + :link: module-pw_string-get-started + :link-type: ref + :class-item: sales-pitch-cta-primary - Add ``$dir_pw_string`` to the ``deps`` list in your ``pw_executable()`` - build target: + Integrate pw_string into your project and learn common use cases - .. code-block:: + .. grid-item-card:: :octicon:`code-square` API Reference + :link: module-pw_string-api + :link-type: ref + :class-item: sales-pitch-cta-secondary - pw_executable("...") { - # ... - deps = [ - # ... - "$dir_pw_string", - # ... - ] - } + Detailed description of the pw_string's classes and methods - See `//source/BUILD.gn <https://pigweed.googlesource.com/pigweed/sample_project/+/refs/heads/main/source/BUILD.gn>`_ - in the Pigweed Sample Project for an example. +.. grid:: 2 - .. tab-item:: Zephyr + .. grid-item-card:: :octicon:`code-square` Design & Roadmap + :link: module-pw_string-design + :link-type: ref + :class-item: sales-pitch-cta-secondary - Add ``CONFIG_PIGWEED_STRING=y`` to the Zephyr project's configuration. + Learn why pw_string is designed the way it is, and upcoming plans -------- -Roadmap -------- -* The fixed size cost of :cpp:type:`pw::StringBuilder` can be dramatically - reduced by limiting support for 64-bit integers. -* ``pw_string`` may be integrated with :ref:`module-pw_tokenizer`. + .. grid-item-card:: :octicon:`code-square` Code Size Analysis + :link: module-pw_string-size-reports + :link-type: ref + :class-item: sales-pitch-cta-secondary -.. toctree:: - :hidden: - :maxdepth: 1 - - design - guide - api + Understand pw_string's code footprint and savings potential |