third_party/pigweed/repo/pw_sys_io_stdio/docs.rst

   1 .. _module-pw_sys_io_stdio:
   2
   3 ---------------
   4 pw_sys_io_stdio
   5 ---------------
   6 The ``pw_sys_io_stdio`` backend implements the ``pw_sys_io`` facade using
   7 stdio.
   8
   9 Why not just use stdio directly?
  10 --------------------------------
  11
  12 The nice thing about using ``pw_sys_io`` is that it's rather easy to get a
  13 board up and running with a target-specific backend. This means when drafting
  14 out a quick application you can write it against ``pw_sys_io`` and, with some
  15 care, the application will be able to run on both host and target devices.
  16
  17 While it's not recommended to use ``pw_sys_io`` for any production
  18 applications, it can be rather helpful for early prototyping.
  19
  20 Setup
  21 =====
  22 This module requires relatively minimal setup:
  23
  24   1. Write code against the ``pw_sys_io`` facade.
  25   2. Direct the ``pw_sys_io_BACKEND`` GN build arg to point to this backend.
  26
  27 Module usage
  28 ============
  29 For the most part, applications built with this backend will behave similarly
  30 to an application built directly against stdio.
  31
  32 Dependencies
  33 ============
  34   * ``pw_sys_io`` facade