Add an rtems-table class to wrap and align HTML tables.

2025-05-17 09:01:50 +08:00 · 2016-01-27 11:27:31 +11:00 · 2016-01-27 11:27:31 +11:00 · 859f0b7319
commit 859f0b7319
parent 1a72a9806f
6 changed files with 104 additions and 10 deletions
--- a/c_user/interrupt_manager.rst
+++ b/c_user/interrupt_manager.rst
@ -167,10 +167,12 @@ is a list of RTEMS system calls that may be made from an ISR:
  currently executing task), while in an ISR, this will refer to the
  interrupted task.  Most of the time, it is an application implementation
  error to use RTEMS_SELF from an ISR.
+
  - rtems_task_suspend
  - rtems_task_resume

 - Interrupt Management
+
  - rtems_interrupt_enable
  - rtems_interrupt_disable
  - rtems_interrupt_flash
@ -182,6 +184,7 @@ is a list of RTEMS system calls that may be made from an ISR:
  - rtems_interrupt_catch

 - Clock Management
+
  - rtems_clock_set
  - rtems_clock_get
  - rtems_clock_get_tod
@ -194,6 +197,7 @@ is a list of RTEMS system calls that may be made from an ISR:
  - rtems_clock_tick

 - Timer Management
+
  - rtems_timer_cancel
  - rtems_timer_reset
  - rtems_timer_fire_after
@ -202,21 +206,26 @@ is a list of RTEMS system calls that may be made from an ISR:
  - rtems_timer_server_fire_when

 - Event Management
+
  - rtems_event_send
  - rtems_event_system_send
  - rtems_event_transient_send

 - Semaphore Management
+
  - rtems_semaphore_release

 - Message Management
+
  - rtems_message_queue_send
  - rtems_message_queue_urgent

 - Signal Management
+
  - rtems_signal_send

 - Dual-Ported Memory Management
+
  - rtems_port_external_to_internal
  - rtems_port_internal_to_external

@ -224,6 +233,7 @@ is a list of RTEMS system calls that may be made from an ISR:
  The following services are safe to call from an ISR if and only if
  the device driver service invoked is also safe.  The IO Manager itself
  is safe but the invoked driver entry point may or may not be.
+
  - rtems_io_initialize
  - rtems_io_open
  - rtems_io_close
@ -232,10 +242,12 @@ is a list of RTEMS system calls that may be made from an ISR:
  - rtems_io_control

 - Fatal Error Management
+
  - rtems_fatal
  - rtems_fatal_error_occurred

 - Multiprocessing
+
  - rtems_multiprocessing_announce

 Directives
@ -267,6 +279,7 @@ INTERRUPT_CATCH - Establish an ISR
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-wrap

 * - ``RTEMS_SUCCESSFUL``
   -  ISR established successfully
--- a/c_user/rate_monotonic_manager.rst
+++ b/c_user/rate_monotonic_manager.rst
@ -480,6 +480,7 @@ relationship between the period's status and the directive status code returned
 by the ``rtems_rate_monotonic_period`` directive:

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - period is running
@ -656,6 +657,7 @@ RATE_MONOTONIC_CREATE - Create a rate monotonic period
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - rate monotonic period created successfully
@ -697,6 +699,7 @@ RATE_MONOTONIC_IDENT - Get ID of a period
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - period identified successfully
@ -734,6 +737,7 @@ RATE_MONOTONIC_CANCEL - Cancel a period
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - period canceled successfully
@ -773,6 +777,7 @@ RATE_MONOTONIC_DELETE - Delete a rate monotonic period
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - period deleted successfully
@ -814,6 +819,7 @@ RATE_MONOTONIC_PERIOD - Conclude current/Start next period
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - period initiated successfully
@ -863,6 +869,7 @@ RATE_MONOTONIC_GET_STATUS - Obtain status from a period
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - period initiated successfully
@ -926,6 +933,7 @@ RATE_MONOTONIC_GET_STATISTICS - Obtain statistics from a period
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - period initiated successfully
@ -993,6 +1001,7 @@ RATE_MONOTONIC_RESET_STATISTICS - Reset statistics for a period
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - period initiated successfully
--- a/c_user/semaphore_manager.rst
+++ b/c_user/semaphore_manager.rst
@ -189,6 +189,7 @@ In general, an attribute set is built by a bitwise OR of the desired attribute
 components.  The following table lists the set of valid semaphore attributes:

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_FIFO``
   - tasks wait by FIFO (default)
@ -252,6 +253,7 @@ components.  The set of valid options for the ``rtems_semaphore_obtain``
 directive are listed in the following table:

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_WAIT``
   - task will wait for semaphore (default)
@ -308,10 +310,9 @@ The ``rtems_semaphore_obtain`` directive is used to acquire the
 specified semaphore.  A simplified version of the ``rtems_semaphore_obtain``
 directive can be described as follows:

-.. sidebar:: Note
-
-    If semaphore's count is greater than zero then decrement semaphore's count
-    else wait for release of semaphore return SUCCESSFUL.
+    If the semaphore's count is greater than zero then decrement the
+    semaphore's count else wait for release of semaphore then return
+    SUCCESSFUL.

 When the semaphore cannot be immediately acquired, one of the following
 situations applies:
@ -343,10 +344,9 @@ The ``rtems_semaphore_release`` directive is used to release the specified
 semaphore.  A simplified version of the``rtems_semaphore_release`` directive
 can be described as follows:

-.. sidebar:: Note
-
-    If no tasks are waiting on this semaphore then increment semaphore's count
-    else assign semaphore to a waiting task return SUCCESSFUL.
+    If there sre no tasks are waiting on this semaphore then increment the
+    semaphore's count else assign semaphore to a waiting task and return
+    SUCCESSFUL.

 If this is the outermost release of a binary semaphore that uses priority
 inheritance or priority ceiling and the task does not currently hold any other
@ -393,6 +393,7 @@ SEMAPHORE_CREATE - Create a semaphore
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - semaphore created successfully
@ -436,8 +437,9 @@ The following semaphore attribute constants are
 defined by RTEMS:

 .. list-table::
+ :class: rtems-table

- * - - ``RTEMS_FIFO``
+ * - ``RTEMS_FIFO``
   - tasks wait by FIFO (default)
 * - ``RTEMS_PRIORITY``
   - tasks wait by priority
@ -503,6 +505,7 @@ SEMAPHORE_IDENT - Get ID of a semaphore
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - semaphore identified successfully
@ -552,6 +555,7 @@ SEMAPHORE_DELETE - Delete a semaphore
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - semaphore deleted successfully
@ -611,6 +615,7 @@ SEMAPHORE_OBTAIN - Acquire a semaphore
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - semaphore obtained successfully
@ -665,8 +670,9 @@ this case.
 The following semaphore acquisition option constants are defined by RTEMS:

 .. list-table::
+ :class: rtems-table

- * - - ``RTEMS_WAIT``
+ * - ``RTEMS_WAIT``
   - task will wait for semaphore (default)
 * - - ``RTEMS_NO_WAIT``
   - task should not wait
@ -704,6 +710,7 @@ SEMAPHORE_RELEASE - Release a semaphore
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - semaphore released successfully
@ -763,6 +770,7 @@ SEMAPHORE_FLUSH - Unblock all tasks waiting on a semaphore
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - semaphore released successfully
@ -820,6 +828,7 @@ SEMAPHORE_SET_PRIORITY - Set priority by scheduler for a semaphore
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - successful operation
--- a/c_user/task_manager.rst
+++ b/c_user/task_manager.rst
@ -200,6 +200,7 @@ enabled when the task is executing. ``RTEMS_INTERRUPT_LEVEL(n)`` specifies that
 the task will execute at interrupt level n.

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_PREEMPT``
   - enable preemption (default)
@ -346,6 +347,7 @@ In general, an attribute set is built by a bitwise OR of the desired
 components.  The set of valid task attribute components is listed below:

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_NO_FLOATING_POINT``
   - does not use coprocessor (default)
@ -380,6 +382,7 @@ desired components.  The set of valid mode constants and each mode's
 corresponding mask constant is listed below:

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_PREEMPT``
   - is masked by``RTEMS_PREEMPT_MASK`` and enables preemption
@ -592,6 +595,7 @@ TASK_CREATE - Create a task
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - task created successfully
@ -659,6 +663,7 @@ when calculating the stack size required for tasks which utilize the driver.
 The following task attribute constants are defined by RTEMS:

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_NO_FLOATING_POINT``
   - does not use coprocessor (default)
@ -672,6 +677,7 @@ The following task attribute constants are defined by RTEMS:
 The following task mode constants are defined by RTEMS:

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_PREEMPT``
   - enable preemption (default)
@ -724,6 +730,7 @@ TASK_IDENT - Get ID of a task
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - task identified successfully
@ -805,6 +812,7 @@ TASK_START - Start a task
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - ask started successfully
@ -857,6 +865,7 @@ TASK_RESTART - Restart a task
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - task restarted successfully
@ -917,6 +926,7 @@ TASK_DELETE - Delete a task
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - task deleted successfully
@ -972,6 +982,7 @@ TASK_SUSPEND - Suspend a task
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - task suspended successfully
@ -1019,6 +1030,7 @@ TASK_RESUME - Resume a task
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - task resumed successfully
@ -1064,6 +1076,7 @@ TASK_IS_SUSPENDED - Determine if a task is Suspended
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - task is NOT suspended
@ -1106,6 +1119,7 @@ TASK_SET_PRIORITY - Set task priority
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - task priority set successfully
@ -1171,6 +1185,7 @@ TASK_MODE - Change the current task mode
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - task mode set successfully
@ -1204,6 +1219,7 @@ The set of task mode constants and each mode's corresponding mask constant is
 provided in the following table:

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_PREEMPT``
   - is masked by ``RTEMS_PREEMPT_MASK`` and enables preemption
@ -1242,6 +1258,7 @@ TASK_WAKE_AFTER - Wake up after interval
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - always successful
@ -1285,6 +1302,7 @@ TASK_WAKE_WHEN - Wake up when specified
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - awakened at date/time successfully
@ -1372,6 +1390,7 @@ TASK_VARIABLE_ADD - Associate per task variable
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - per task variable added successfully
@ -1433,6 +1452,7 @@ TASK_VARIABLE_GET - Obtain value of a per task variable
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - per task variable obtained successfully
@ -1490,6 +1510,7 @@ TASK_VARIABLE_DELETE - Remove per task variable
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - per task variable deleted successfully
--- a/c_user/timer_manager.rst
+++ b/c_user/timer_manager.rst
@ -207,6 +207,7 @@ TIMER_CREATE - Create a timer
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - timer created successfully
@ -248,6 +249,7 @@ TIMER_IDENT - Get ID of a timer
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - timer identified successfully
@ -287,6 +289,7 @@ TIMER_CANCEL - Cancel a timer
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - timer canceled successfully
@ -322,6 +325,7 @@ TIMER_DELETE - Delete a timer
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - timer deleted successfully
@ -362,6 +366,7 @@ TIMER_FIRE_AFTER - Fire timer after interval
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - timer initiated successfully
@ -405,6 +410,7 @@ TIMER_FIRE_WHEN - Fire timer when specified
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - timer initiated successfully
@ -452,6 +458,7 @@ TIMER_INITIATE_SERVER - Initiate server for task-based timers
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - Timer Server initiated successfully
@ -497,6 +504,7 @@ TIMER_SERVER_FIRE_AFTER - Fire task-based timer after interval
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - timer initiated successfully
@ -545,6 +553,7 @@ TIMER_SERVER_FIRE_WHEN - Fire task-based timer when specified
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - timer initiated successfully
@ -594,6 +603,7 @@ TIMER_RESET - Reset an interval timer
 **DIRECTIVE STATUS CODES:**

 .. list-table::
+ :class: rtems-table

 * - ``RTEMS_SUCCESSFUL``
   - timer reset successfully
--- a/common/_static/my-styles.css
+++ b/common/_static/my-styles.css
@ -29,6 +29,14 @@
 	color: #a87892;
 }

+/*
+ * Special table for RTEMS. Wrap cell contents and vertically align to the top.
+ */
+table.rtems-table.docutils td {
+    white-space: normal;
+    vertical-align: top;
+}
+
 /*
 * Special table. We do not use this because the format is only for HTML
 * not PDF. Left here as a record.
@ -50,6 +58,30 @@ table.rtems-items-table.docutils:not(.field-list) tr td:nth-child(2n) {
    text-align: left;
 }

+/*
+ * Notes.
+ */
+.rst-content .note .admonition-title {
+    background-color: #38532F;
+    color: #fdfdfd;
+}
+.admonition.note {
+    background:#dbe5c6;
+    color: #333333;
+}
+
+/*
+ * Todo
+ */
+.rst-content .todo .admonition-title {
+    background-color: #38532F;
+    color: #fdfdfd;
+}
+.admonition.todo {
+    background:#dbe5c6;
+    color: #333333;
+}
+
 /*
 * Nav side-bar in RTEMS colours.
 */