mirror of
https://fuchsia.googlesource.com/third_party/pigweed.googlesource.com/pigweed/pigweed
synced 2024-09-21 06:12:09 +00:00
f7a5a742ab
Rename pw_dumb_io facade and backends to use the more deliberate name pw_sys_io moving forward. Change-Id: I968480715967ab8de491856afa1b7692b973ed7e
40 lines
1.1 KiB
ReStructuredText
40 lines
1.1 KiB
ReStructuredText
.. _chapter-pw-sys-io-stdio:
|
|
|
|
.. default-domain:: cpp
|
|
|
|
.. highlight:: sh
|
|
|
|
---------------
|
|
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. Specify the ``dir_pw_sys_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_sys_io facade
|