mirror of
https://fuchsia.googlesource.com/third_party/pigweed.googlesource.com/pigweed/pigweed
synced 2024-09-20 05:41:06 +00:00
f9fb90f299
- Update labels so they use consistent naming. Instead of the copy-and-pasted `chapter` prefix, name labels with a prefix consistent with what they point to: - "module-" for module - "target-" for targets - "docs-" for general documentation - Remove the unnecessary highlight and default-domain directives. Neither is necessary since the Pigweed docs always specify the language in code snippets and other directives. Change-Id: I55c34e9ec919f6f4670e5d3d008e0edf5fecf05b Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/19328 Commit-Queue: Wyatt Hepler <hepler@google.com> Reviewed-by: Keir Mierle <keir@google.com>
35 lines
1.0 KiB
ReStructuredText
35 lines
1.0 KiB
ReStructuredText
.. _module-pw_sys_io_stdio:
|
|
|
|
---------------
|
|
pw_sys_io_stdio
|
|
---------------
|
|
The ``pw_sys_io_stdio`` backend implements the ``pw_sys_io`` facade using
|
|
stdio.
|
|
|
|
Why not just use stdio directly?
|
|
--------------------------------
|
|
|
|
The nice thing about using ``pw_sys_io`` is that it's rather easy to get a
|
|
board up and running with a target-specific backend. This means when drafting
|
|
out a quick application you can write it against ``pw_sys_io`` and, with some
|
|
care, the application will be able to run on both host and target devices.
|
|
|
|
While it's not recommended to use ``pw_sys_io`` for any production
|
|
applications, it can be rather helpful for early prototyping.
|
|
|
|
Setup
|
|
=====
|
|
This module requires relatively minimal setup:
|
|
|
|
1. Write code against the ``pw_sys_io`` facade.
|
|
2. Direct the ``pw_sys_io_BACKEND`` GN build arg to point to this backend.
|
|
|
|
Module usage
|
|
============
|
|
For the most part, applications built with this backend will behave similarly
|
|
to an application built directly against stdio.
|
|
|
|
Dependencies
|
|
============
|
|
* ``pw_sys_io`` facade
|