summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoel Sherrill <joel@rtems.org>2016-10-27 19:47:07 -0500
committerJoel Sherrill <joel@rtems.org>2016-10-27 19:47:07 -0500
commit36def9125c9adf4049a18105d48715ac8606e1ec (patch)
treeb9a3c06d3fad69f3213474d5d16d844b862cc268
parent2b175c323836ceb3bfcf0f5e32409c8bb570a89b (diff)
downloadrtems-docs-36def9125c9adf4049a18105d48715ac8606e1ec.tar.bz2
rtems-docs: Fix many unnecessary back slashes
-rw-r--r--bsp_howto/console.rst10
-rw-r--r--bsp_howto/miscellanous_support.rst8
-rw-r--r--c_user/constant_bandwidth_server.rst2
-rw-r--r--c_user/semaphore_manager.rst2
-rw-r--r--networking/testing_the_driver.rst8
-rw-r--r--porting/cpu_init.rst2
-rw-r--r--porting/idle_thread.rst12
-rw-r--r--porting/interrupts.rst42
-rw-r--r--porting/priority_bitmap.rst12
-rw-r--r--porting/task_context.rst60
-rw-r--r--posix_users/input_and_output.rst4
-rw-r--r--posix_users/process_environment.rst4
-rw-r--r--posix_users/signal.rst4
-rw-r--r--shell/file_and_directory.rst2
-rw-r--r--shell/general_commands.rst20
15 files changed, 96 insertions, 96 deletions
diff --git a/bsp_howto/console.rst b/bsp_howto/console.rst
index 3b15a65..bcca519 100644
--- a/bsp_howto/console.rst
+++ b/bsp_howto/console.rst
@@ -220,18 +220,18 @@ header file.
#include <rtems/termiostypes.h>
#include <some-chip-header.h>
- /* Low-level driver specific data structure \*/
+ /* Low-level driver specific data structure */
typedef struct {
rtems_termios_device_context base;
- const char \*device_name;
- volatile module_register_block \*regs;
- /* More stuff \*/
+ const char *device_name;
+ volatile module_register_block *regs;
+ /* More stuff */
} my_driver_context;
extern const rtems_termios_handler my_driver_handler_polled;
extern const rtems_termios_handler my_driver_handler_interrupt;
- #endif /* MY_DRIVER_H \*/
+ #endif /* MY_DRIVER_H */
Termios and Polled IO
---------------------
diff --git a/bsp_howto/miscellanous_support.rst b/bsp_howto/miscellanous_support.rst
index 0009654..59b1339 100644
--- a/bsp_howto/miscellanous_support.rst
+++ b/bsp_howto/miscellanous_support.rst
@@ -260,10 +260,10 @@ follows:
.. code:: c
- rtems_isr_entry set_vector( /* returns old vector \*/
- rtems_isr_entry handler, /* isr routine \*/
- rtems_vector_number vector, /* vector number \*/
- int type /* RTEMS or RAW intr \*/
+ rtems_isr_entry set_vector( /* returns old vector */
+ rtems_isr_entry handler, /* isr routine */
+ rtems_vector_number vector, /* vector number */
+ int type /* RTEMS or RAW intr */
)
{
if the type is RAW
diff --git a/c_user/constant_bandwidth_server.rst b/c_user/constant_bandwidth_server.rst
index 53e7316..135dfdb 100644
--- a/c_user/constant_bandwidth_server.rst
+++ b/c_user/constant_bandwidth_server.rst
@@ -214,7 +214,7 @@ overrun.
while ( 1 ) {
if (rtems_rate_monotonic_period(rmid, params.deadline) == RTEMS_TIMEOUT)
break;
- /* Perform some periodic action \*/
+ /* Perform some periodic action */
}
rtems_rate_monotonic_delete( rmid );
diff --git a/c_user/semaphore_manager.rst b/c_user/semaphore_manager.rst
index 21024d0..16ae2d1 100644
--- a/c_user/semaphore_manager.rst
+++ b/c_user/semaphore_manager.rst
@@ -917,7 +917,7 @@ semaphore object.
assert(sc == RTEMS_SUCCESSFUL);
assert(prio == 1);
- /* Check the ceiling priority values \*/
+ /* Check the ceiling priority values */
prio = RTEMS_CURRENT_PRIORITY;
sc = rtems_semaphore_set_priority(semaphore_id, scheduler_a_id, prio, &prio);
assert(sc == RTEMS_SUCCESSFUL);
diff --git a/networking/testing_the_driver.rst b/networking/testing_the_driver.rst
index 2ec3113..8c150c8 100644
--- a/networking/testing_the_driver.rst
+++ b/networking/testing_the_driver.rst
@@ -124,7 +124,7 @@ tracing the behavior of the network stack. The following is a list of them:
.. code-block:: shell
- ************ MBUF STATISTICS \************
+ ************ MBUF STATISTICS ************
mbufs:4096 clusters: 256 free: 241
drops: 0 waits: 0 drains: 0
free:4080 data:16 header:0 socket:0
@@ -139,8 +139,8 @@ tracing the behavior of the network stack. The following is a list of them:
.. code-block:: shell
- ************ INTERFACE STATISTICS \************
- \***** smc1 \*****
+ ************ INTERFACE STATISTICS ************
+ ***** smc1 *****
Ethernet Address: 00:12:76:43:34:25
Address:10.8.1.1 Broadcast Address:10.255.255.255 Net mask:255.0.0.0
Flags: Up Broadcast Running Simplex
@@ -153,7 +153,7 @@ tracing the behavior of the network stack. The following is a list of them:
No Carrier:0 Retransmit Limit:0 Late Collision:0
Underrun:0 Raw output wait:0 Coalesced:0
Coalesce failed:0 Retries:0
- \***** lo0 \*****
+ ***** lo0 *****
Address:127.0.0.1 Net mask:255.0.0.0
Flags: Up Loopback Running Multicast
Send queue limit:50 length:0 Dropped:0
diff --git a/porting/cpu_init.rst b/porting/cpu_init.rst
index 8de4744..39a27ed 100644
--- a/porting/cpu_init.rst
+++ b/porting/cpu_init.rst
@@ -19,7 +19,7 @@ The _CPU_Initialize routine performs processor dependent initialization.
.. code:: c
void _CPU_Initialize(
- void (\*thread_dispatch) /* may be ignored \*/
+ void (*thread_dispatch) /* may be ignored */
)
The thread_dispatch argument is the address of the entry point for the
diff --git a/porting/idle_thread.rst b/porting/idle_thread.rst
index 397a218..c0a350a 100644
--- a/porting/idle_thread.rst
+++ b/porting/idle_thread.rst
@@ -73,7 +73,7 @@ CPU_PROVIDES_IDLE_THREAD_BODY macro should be defined to TRUE. This
routine is prototyped as follows:
.. code:: c
- void \*_CPU_Thread_Idle_body( uintptr_t );
+ void *_CPU_Thread_Idle_body( uintptr_t );
As mentioned above, RTEMS does not require that a CPU dependent IDLE
thread body be provided as part of the port. If
@@ -82,9 +82,9 @@ independent algorithm is used. This algorithm consists of a "branch to
self" which is implemented in a routine as follows.
.. code:: c
- void \*_Thread_Idle_body( uintptr_t ignored )
+ void *_Thread_Idle_body( uintptr_t ignored )
{
- while( 1 ) ;
+ while( 1 ) ;
}
If the CPU dependent IDLE thread body is implementation centers upon using
@@ -93,10 +93,10 @@ in an infinite loop as the CPU will have to reexecute this instruction
each time the IDLE thread is dispatched.
.. code:: c
- void \*_CPU_Thread_Idle_body( uintptr_t ignored )
+ void *_CPU_Thread_Idle_body( uintptr_t ignored )
{
- for( ; ; )
- /* insert your "halt" instruction here \*/ ;
+ for( ; ; )
+ /* insert your "halt" instruction here */ ;
}
Be warned. Some processors with onboard DMA have been known to stop the
diff --git a/porting/interrupts.rst b/porting/interrupts.rst
index 970bb58..00013ed 100644
--- a/porting/interrupts.rst
+++ b/porting/interrupts.rst
@@ -87,8 +87,8 @@ dummy implementation that simply sets the previous level to 0.
.. code:: c
#define _CPU_ISR_Disable( _isr_cookie ) \\
- { \\
- (_isr_cookie) = 0; /* do something to prevent warnings \*/ \\
+ { \
+ (_isr_cookie) = 0; /* do something to prevent warnings */ \
}
The following is the implementation from the Motorola M68K port:
@@ -186,8 +186,8 @@ NOTE: This should be TRUE is CPU_HAS_SOFTWARE_INTERRUPT_STACK is TRUE.
If the CPU_HAS_SOFTWARE_INTERRUPT_STACK macro is set to TRUE, then RTEMS automatically allocates the stack memory in the initialization of the Interrupt Manager and the switch to that stack is performed in ``_ISR_Handler`` on the outermost interrupt. The _CPU_Interrupt_stack_low and _CPU_Interrupt_stack_high variables contain the addresses of the the lowest and highest addresses of the memory allocated for the interrupt stack. Although technically only one of these addresses is required to switch to the interrupt stack, by always providing both addresses, the port has more options avaialble to it without requiring modifications to the portable parts of the executive. Whether the stack grows up or down, this give the CPU dependent code the option of picking the version it wants to use.
.. code:: c
- SCORE_EXTERN void \*_CPU_Interrupt_stack_low;
- SCORE_EXTERN void \*_CPU_Interrupt_stack_high;
+ SCORE_EXTERN void *_CPU_Interrupt_stack_low;
+ SCORE_EXTERN void *_CPU_Interrupt_stack_high;
NOTE: These two variables are required if the macro
CPU_HAS_SOFTWARE_INTERRUPT_STACK is defined as TRUE.
@@ -214,9 +214,9 @@ The _CPU_ISR_install_raw_handler XXX
.. code:: c
void _CPU_ISR_install_raw_handler(
- unsigned32 vector,
- proc_ptr new_handler,
- proc_ptr \*old_handler
+ unsigned32 vector,
+ proc_ptr new_handler,
+ proc_ptr *old_handler
)
This is where we install the interrupt handler into the "raw" interrupt
@@ -239,7 +239,7 @@ and mapped into a user provided handler.
#define CPU_INTERRUPT_NUMBER_OF_VECTORS 32
#define CPU_INTERRUPT_MAXIMUM_VECTOR_NUMBER \\
- (CPU_INTERRUPT_NUMBER_OF_VECTORS - 1)
+ (CPU_INTERRUPT_NUMBER_OF_VECTORS - 1)
Install RTEMS Interrupt Handler
-------------------------------
@@ -254,9 +254,9 @@ new_handler - replacement ISR for this vector number
.. code:: c
void _CPU_ISR_install_vector(
- unsigned32 vector,
- proc_ptr new_handler,
- proc_ptr \*old_handler
+ unsigned32 vector,
+ proc_ptr new_handler,
+ proc_ptr *old_handler
)
.. code:: c
@@ -293,8 +293,8 @@ examine the saved state.
.. code:: c
typedef struct {
- unsigned32 not_preserved_register_1;
- unsigned32 special_interrupt_register;
+ unsigned32 not_preserved_register_1;
+ unsigned32 special_interrupt_register;
} CPU_Interrupt_frame;
Interrupt Dispatching
@@ -338,22 +338,22 @@ another interrupt nests this one) and branches to ``_ISR_Handler``.
save some or all context on stack
may need to save some special interrupt information for exit
#if ( CPU_HAS_SOFTWARE_INTERRUPT_STACK == TRUE )
- if ( _ISR_Nest_level == 0 )
- switch to software interrupt stack
+ if ( _ISR_Nest_level == 0 )
+ switch to software interrupt stack
#endif
_ISR_Nest_level++;
_Thread_Dispatch_disable_level++;
- (\*_ISR_Vector_table[ vector ])( vector );
+ (*_ISR_Vector_table[ vector ])( vector );
--_ISR_Nest_level;
if ( _ISR_Nest_level )
- goto the label "exit interrupt (simple case)"
+ goto the label "exit interrupt (simple case)"
#if ( CPU_HAS_SOFTWARE_INTERRUPT_STACK == TRUE )
- restore stack
+ restore stack
#endif
if ( _Thread_Dispatch_disable_level )
- goto the label "exit interrupt (simple case)"
+ goto the label "exit interrupt (simple case)"
if ( _Thread_Dispatch_necessary )
- call _Thread_Dispatch() or prepare to return to _ISR_Dispatch
+ call _Thread_Dispatch() or prepare to return to _ISR_Dispatch
prepare to get out of interrupt
return from interrupt (maybe to _ISR_Dispatch)
LABEL "exit interrupt (simple case):
@@ -392,7 +392,7 @@ invoke that routine at the end of the interrupt sequence (if a dispatch is
necessary).
.. code:: c
- void (\*_CPU_Thread_dispatch_pointer)();
+ void (*_CPU_Thread_dispatch_pointer)();
.. COMMENT: COPYRIGHT (c) 1988-2002.
diff --git a/porting/priority_bitmap.rst b/porting/priority_bitmap.rst
index d546f8f..4ce89cb 100644
--- a/porting/priority_bitmap.rst
+++ b/porting/priority_bitmap.rst
@@ -56,9 +56,9 @@ The _CPU_Bitfield_Find_first_bit routine sets _output to the bit number of
the first bit set in ``_value``. ``_value`` is of CPU dependent type``Priority_bit_map_Control``. A stub version of this routine is as follows:
.. code:: c
- #define _CPU_Bitfield_Find_first_bit( _value, _output ) \\
- { \\
- (_output) = 0; /* do something to prevent warnings \*/ \\
+ #define _CPU_Bitfield_Find_first_bit( _value, _output ) \
+ { \
+ (_output) = 0; /* do something to prevent warnings */ \
}
There are a number of variables in using a "find first bit" type
@@ -129,9 +129,9 @@ something like this stub example did:
.. code:: c
#if (CPU_USE_GENERIC_BITFIELD_CODE == FALSE)
- #define _CPU_Bitfield_Find_first_bit( _value, _output ) \\
- { \\
- (_output) = 0; /* do something to prevent warnings \*/ \\
+ #define _CPU_Bitfield_Find_first_bit( _value, _output ) \
+ { \
+ (_output) = 0; /* do something to prevent warnings */ \
}
#endif
diff --git a/porting/task_context.rst b/porting/task_context.rst
index 206372d..c9cf53a 100644
--- a/porting/task_context.rst
+++ b/porting/task_context.rst
@@ -64,7 +64,7 @@ when there are no special requirements:
#define CPU_STACK_ALIGNMENT 0
-NOTE: This must be a power of 2 either 0 or greater than CPU_ALIGNMENT. \[XXX is this true?]
+NOTE: This must be a power of 2 either 0 or greater than CPU_ALIGNMENT. [XXX is this true?]
Task Context
============
@@ -149,12 +149,12 @@ start time. The _CPU_Context_initialize routine is prototyped as follows:
.. code:: c
void _CPU_Context_Initialize(
- Context_Control \*_the_context,
- void \*_stack_base,
- unsigned32 _size,
- unsigned32 _isr,
- void \*_entry_point,
- unsigned32 _is_fp
+ Context_Control *_the_context,
+ void *_stack_base,
+ unsigned32 _size,
+ unsigned32 _isr,
+ void *_entry_point,
+ unsigned32 _is_fp
);
The ``is_fp`` parameter is TRUE if the thread is to be a floating point
@@ -186,8 +186,8 @@ context of the current executing thread to the context of the heir thread.
.. code:: c
void _CPU_Context_switch(
- Context_Control \*run,
- Context_Control \*heir
+ Context_Control *run,
+ Context_Control *heir
);
This routine begins by saving the current state of the
@@ -239,7 +239,7 @@ unnecessary to reload some registers.
.. code:: c
void _CPU_Context_restore(
- Context_Control \*new_context
+ Context_Control *new_context
);
Restarting the Currently Executing Task
@@ -257,8 +257,8 @@ The following is an implementation of _CPU_Context_Restart_self that can
be used when no special handling is required for this case.
.. code:: c
- #define _CPU_Context_Restart_self( _the_context ) \\
- _CPU_Context_restore( (_the_context) )
+ #define _CPU_Context_Restart_self( _the_context ) \
+ _CPU_Context_restore( (_the_context) )
XXX find a port which does not do it this way and include it here
@@ -284,11 +284,11 @@ The following example illustrates how the CPU_HARDWARE_FP (XXX macro name
is varying) macro is set based on the CPU family dependent macro.
.. code:: c
- #if ( THIS_CPU_FAMILY_HAS_FPU == 1 ) /* where THIS_CPU_FAMILY \*/
- /* might be M68K \*/
- #define CPU_HARDWARE_FP TRUE
+ #if ( THIS_CPU_FAMILY_HAS_FPU == 1 ) /* where THIS_CPU_FAMILY */
+ /* might be M68K */
+ #define CPU_HARDWARE_FP TRUE
#else
- #define CPU_HARDWARE_FP FALSE
+ #define CPU_HARDWARE_FP FALSE
#endif
The macro name THIS_CPU_FAMILY_HAS_FPU should be made CPU specific. It
@@ -438,8 +438,8 @@ use this implementation since the floating point context is saved as a
sequence of store operations.
.. code:: c
- #define _CPU_Context_Fp_start( _base, _offset ) \\
- ( (void \*) _Addresses_Add_offset( (_base), (_offset) ) )
+ #define _CPU_Context_Fp_start( _base, _offset ) \
+ ( (void *) _Addresses_Add_offset( (_base), (_offset) ) )
In contrast, the m68k treats the floating point context area as a stack
which grows downward in memory. Thus the following implementation of
@@ -468,10 +468,10 @@ point context passed to it. The following example implementation shows
how to accomplish this:
.. code:: c
- #define _CPU_Context_Initialize_fp( _destination ) \\
- { \\
- \*((Context_Control_fp \*) \*((void \**) _destination)) = \\
- _CPU_Null_fp_context; \\
+ #define _CPU_Context_Initialize_fp( _destination ) \
+ { \
+ *((Context_Control_fp *) *((void **) _destination)) = \\
+ _CPU_Null_fp_context; \\
}
The _CPU_Null_fp_context is optional. A port need only include this variable when it uses the above mechanism to initialize a floating point context. This is typically done on CPUs where it is difficult to generate an "uninitialized" FP context. If the port requires this variable, then it is declared as follows:
@@ -483,34 +483,34 @@ Saving a Floating Point Context
-------------------------------
The _CPU_Context_save_fp_context routine is responsible for saving the FP
-context at \*fp_context_ptr. If the point to load the FP context from is
+context at *fp_context_ptr. If the point to load the FP context from is
changed then the pointer is modified by this routine.
Sometimes a macro implementation of this is in cpu.h which dereferences
-the \** and a similarly named routine in this file is passed something like
-a (Context_Control_fp \*). The general rule on making this decision is to
+the ** and a similarly named routine in this file is passed something like
+a (Context_Control_fp *). The general rule on making this decision is to
avoid writing assembly language.
.. code:: c
void _CPU_Context_save_fp(
- void \**fp_context_ptr
+ void **fp_context_ptr
)
Restoring a Floating Point Context
----------------------------------
The _CPU_Context_restore_fp_context is responsible for restoring the FP
-context at \*fp_context_ptr. If the point to load the FP context from is
+context at *fp_context_ptr. If the point to load the FP context from is
changed then the pointer is modified by this routine.
Sometimes a macro implementation of this is in cpu.h which dereferences
-the \** and a similarly named routine in this file is passed something like
-a (Context_Control_fp \*). The general rule on making this decision is to
+the ** and a similarly named routine in this file is passed something like
+a (Context_Control_fp *). The general rule on making this decision is to
avoid writing assembly language.
.. code:: c
void _CPU_Context_restore_fp(
- void \**fp_context_ptr
+ void **fp_context_ptr
);
.. COMMENT: COPYRIGHT (c) 1988-2002.
diff --git a/posix_users/input_and_output.rst b/posix_users/input_and_output.rst
index b236991..5a3b9d8 100644
--- a/posix_users/input_and_output.rst
+++ b/posix_users/input_and_output.rst
@@ -688,7 +688,7 @@ unmount - Unmount file systems
#include <libio.h>
int unmount(
- const char \*mount_path
+ const char *mount_path
);
**STATUS CODES:**
@@ -767,7 +767,7 @@ writev - Vectored write to a file
#include <sys/uio.h>
ssize_t writev(
int fd,
- const struct iovec \*iov,
+ const struct iovec *iov,
int iovcnt
);
diff --git a/posix_users/process_environment.rst b/posix_users/process_environment.rst
index bb1550c..0556d12 100644
--- a/posix_users/process_environment.rst
+++ b/posix_users/process_environment.rst
@@ -523,7 +523,7 @@ uname - Get System Name
.. code-block:: c
int uname(
- struct utsname \*name
+ struct utsname *name
);
**STATUS CODES:**
@@ -592,7 +592,7 @@ getenv - Get Environment Variables
.. code-block:: c
char *getenv(
- const char \*name
+ const char *name
);
**STATUS CODES:**
diff --git a/posix_users/signal.rst b/posix_users/signal.rst
index 9e976f8..490c132 100644
--- a/posix_users/signal.rst
+++ b/posix_users/signal.rst
@@ -527,8 +527,8 @@ pthread_sigmask - Examine and Change Thread Blocked Signals
#include <signal.h>
int pthread_sigmask(
int how,
- const sigset_t \*set,
- sigset_t \*oset
+ const sigset_t *set,
+ sigset_t *oset
);
**STATUS CODES:**
diff --git a/shell/file_and_directory.rst b/shell/file_and_directory.rst
index eb4b276..fd63c1e 100644
--- a/shell/file_and_directory.rst
+++ b/shell/file_and_directory.rst
@@ -1334,7 +1334,7 @@ The format is required and must be surrounded by double quote (" ") marks. It
is interpreted as a fprintf-style format string (see*fprintf*), with the
following exceptions:
-- An asterisk (\*) may not be used as a field width or precision.
+- An asterisk (*) may not be used as a field width or precision.
- A byte count or field precision is required for each "s" con- version
character (unlike the fprintf(3) default which prints the entire string if
diff --git a/shell/general_commands.rst b/shell/general_commands.rst
index 7024647..eba2c0e 100644
--- a/shell/general_commands.rst
+++ b/shell/general_commands.rst
@@ -475,34 +475,34 @@ solely for compatibility with other systems. Only one of the options *-n* and
If any of the following sequences of characters is encountered during output,
the sequence is not output. Instead, the specified action is performed:
-*\\b*
+*\b*
A backspace character is output.
-*\\c*
+*\c*
Subsequent output is suppressed. This is normally used at the end of the
last argument to suppress the trailing newline that echo would otherwise
output.
-*\\f*
+*\f*
Output a form feed.
-*\\n*
+*\n*
Output a newline character.
-*\\r*
+*\r*
Output a carriage return.
-*\\t*
+*\t*
Output a (horizontal) tab character.
-*\\v*
+*\v*
Output a vertical tab.
-*\\0digits*
+*\0digits*
Output the character whose value is given by zero to three digits. If
there are zero digits, a nul character is output.
-*\\\\*
+*\\*
Output a backslash.
**EXIT STATUS:**
@@ -511,7 +511,7 @@ This command returns 0 on success and non-zero if an error is encountered.
**NOTES:**
-The octal character escape mechanism (\\0digits) differs from the C language
+The octal character escape mechanism (\0digits) differs from the C language
mechanism.
There is no way to force ``echo`` to treat its arguments literally, rather than