summaryrefslogtreecommitdiff
path: root/spec/if/acfg/appl-needs-simple-task-console-driver.yml
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-07-07 08:49:58 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-07-07 12:58:52 +0200
commitb29dd738f97901f464400a19510056790807dc47 (patch)
tree12530221be861aad0f8ba217192fc52db98dffd4 /spec/if/acfg/appl-needs-simple-task-console-driver.yml
parent374e1bf214e0f9691b06fcec30a7d88407ccba0a (diff)
spec: Use ${...} references in /if/acfg/*
This allows generation of Sphinx and Doxygen output.
Diffstat (limited to 'spec/if/acfg/appl-needs-simple-task-console-driver.yml')
-rw-r--r--spec/if/acfg/appl-needs-simple-task-console-driver.yml12
1 files changed, 6 insertions, 6 deletions
diff --git a/spec/if/acfg/appl-needs-simple-task-console-driver.yml b/spec/if/acfg/appl-needs-simple-task-console-driver.yml
index 15ad5efa..d276efdd 100644
--- a/spec/if/acfg/appl-needs-simple-task-console-driver.yml
+++ b/spec/if/acfg/appl-needs-simple-task-console-driver.yml
@@ -17,17 +17,17 @@ notes: |
device file. This device is used to initialize the standard input, output,
and error file descriptors.
- This device driver reads via :c:func:`getchark`.
+ This device driver reads via ``getchark()``.
This device driver writes into a write buffer. The count of characters
written into the write buffer is returned. It might be less than the
requested count, in case the write buffer is full. The write is
non-blocking and may be called from interrupt context. A dedicated task
reads from the write buffer and outputs the characters via
- :c:func:`rtems_putc`. This task runs with the least important priority.
+ ``rtems_putc()``. This task runs with the least important priority.
The write buffer size is 2047 characters and it is not configurable.
- Use ``fsync(STDOUT_FILENO)`` or ``fdatasync(STDOUT_FILENO)`` to drain the
+ Use ``fsync( STDOUT_FILENO )`` or ``fdatasync( STDOUT_FILENO )`` to drain the
write buffer.
The Termios framework is not used. There is no support to change device
@@ -35,11 +35,11 @@ notes: |
The
- * :ref:`CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER`,
+ * ${appl-needs-console-driver:/name},
- * :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER`, and
+ * ${appl-needs-simple-console-driver:/name}, and
- * :ref:`CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER`
+ * ${appl-needs-simple-task-console-driver:/name}
configuration options are mutually exclusive.
text: ''