[PATCH v1] c-user: Add documentation for exception mapping
Kinsey Moore
kinsey.moore at oarcorp.com
Wed Apr 14 15:47:07 UTC 2021
This adds the documention generated by rtems-central for
CONFIGURE_APPLICATION_NEEDS_EXCEPTION_TO_SIGNAL_MAPPING.
---
c-user/config/device-driver.rst | 32 +++++++++++++++++++++++++++++++-
1 file changed, 31 insertions(+), 1 deletion(-)
diff --git a/c-user/config/device-driver.rst b/c-user/config/device-driver.rst
index 05ae08a..9dcc5f4 100644
--- a/c-user/config/device-driver.rst
+++ b/c-user/config/device-driver.rst
@@ -1,7 +1,7 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+.. Copyright (C) 1988, 2021 On-Line Applications Research Corporation (OAR)
.. This file is part of the RTEMS quality process and was automatically
.. generated. If you find something that needs to be fixed or
@@ -204,6 +204,36 @@ NOTES:
configuration options are mutually exclusive.
+.. Generated from spec:/acfg/if/appl-needs-exception-to-signal-mapping
+
+.. index:: CONFIGURE_APPLICATION_NEEDS_EXCEPTION_TO_SIGNAL_MAPPING
+
+.. _CONFIGURE_APPLICATION_NEEDS_EXCEPTION_TO_SIGNAL_MAPPING:
+
+CONFIGURE_APPLICATION_NEEDS_EXCEPTION_TO_SIGNAL_MAPPING
+-------------------------------------------------------
+
+CONSTANT:
+ ``CONFIGURE_APPLICATION_NEEDS_EXCEPTION_TO_SIGNAL_MAPPING``
+
+OPTION TYPE:
+ This configuration option is a boolean feature define.
+
+DEFAULT CONFIGURATION:
+ If this configuration option is undefined, then the described feature is not
+ enabled.
+
+DESCRIPTION:
+ In case this configuration option is defined, then the machine exception to
+ POSIX signal mapping is configured during system initialization.
+
+NOTES:
+ This device driver is responsible for setting up a mapping from machine
+ exceptions to POSIX signals so that applications may consume them and alter
+ task execution as necessary.
+
+ This is especially useful for applications written in Ada or C++.
+
.. Generated from spec:/acfg/if/appl-needs-framebuffer-driver
.. index:: CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER
--
2.20.1
More information about the devel
mailing list