mirror of
https://fuchsia.googlesource.com/third_party/pigweed.googlesource.com/pigweed/pigweed
synced 2024-09-20 13:51:05 +00:00
d2e4903a42
Add/update docs for the pw_dumb_io facade and backends. Configures GN build files such that all the backend docs are built even if the backend isn't in use. Change-Id: I91fca1cb2d3f5d4b57ae1f6991a89270a35be1c6
40 lines
1.1 KiB
ReStructuredText
40 lines
1.1 KiB
ReStructuredText
.. _chapter-pw-dumb-io-stdio:
|
|
|
|
.. default-domain:: cpp
|
|
|
|
.. highlight:: sh
|
|
|
|
----------------
|
|
pw_dumb_io_stdio
|
|
----------------
|
|
The ``pw_dumb_io_stdio`` backend implements the ``pw_dumb_io`` facade using
|
|
stdio.
|
|
|
|
Why not just use stdio directly?
|
|
--------------------------------
|
|
|
|
The nice thing about using ``pw_dumb_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_dumb_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_dumb_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_dumb_io`` facade.
|
|
2. Specify the ``dir_pw_dumb_io_backend`` GN global variable 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_dumb_io facade
|