Changeset 36def91 in rtems-docs


Ignore:
Timestamp:
Oct 28, 2016, 12:47:07 AM (3 years ago)
Author:
Joel Sherrill <joel@…>
Branches:
4.11, master
Children:
f29b7c1c
Parents:
2b175c3
Message:

rtems-docs: Fix many unnecessary back slashes

Files:
15 edited

Legend:

Unmodified
Added
Removed
  • bsp_howto/console.rst

    r2b175c3 r36def91  
    221221    #include <some-chip-header.h>
    222222
    223     /* Low-level driver specific data structure \*/
     223    /* Low-level driver specific data structure */
    224224    typedef struct {
    225225      rtems_termios_device_context base;
    226       const char \*device_name;
    227       volatile module_register_block \*regs;
    228       /* More stuff \*/
     226      const char *device_name;
     227      volatile module_register_block *regs;
     228      /* More stuff */
    229229    } my_driver_context;
    230230
     
    232232    extern const rtems_termios_handler my_driver_handler_interrupt;
    233233
    234     #endif /* MY_DRIVER_H \*/
     234    #endif /* MY_DRIVER_H */
    235235
    236236Termios and Polled IO
  • bsp_howto/miscellanous_support.rst

    r2b175c3 r36def91  
    261261.. code:: c
    262262
    263     rtems_isr_entry set_vector(                 /* returns old vector \*/
    264       rtems_isr_entry handler,                  /* isr routine        \*/
    265       rtems_vector_number vector,               /* vector number      \*/
    266       int                 type                  /* RTEMS or RAW intr  \*/
     263    rtems_isr_entry set_vector(                 /* returns old vector */
     264      rtems_isr_entry handler,                  /* isr routine        */
     265      rtems_vector_number vector,               /* vector number      */
     266      int                 type                  /* RTEMS or RAW intr  */
    267267    )
    268268    {
  • c_user/constant_bandwidth_server.rst

    r2b175c3 r36def91  
    215215            if (rtems_rate_monotonic_period(rmid, params.deadline) == RTEMS_TIMEOUT)
    216216                break;
    217             /* Perform some periodic action \*/
     217            /* Perform some periodic action */
    218218        }
    219219
  • c_user/semaphore_manager.rst

    r2b175c3 r36def91  
    918918        assert(prio == 1);
    919919
    920         /* Check the ceiling priority values \*/
     920        /* Check the ceiling priority values */
    921921        prio = RTEMS_CURRENT_PRIORITY;
    922922        sc = rtems_semaphore_set_priority(semaphore_id, scheduler_a_id, prio, &prio);
  • networking/testing_the_driver.rst

    r2b175c3 r36def91  
    125125  .. code-block:: shell
    126126
    127       ************ MBUF STATISTICS \************
     127      ************ MBUF STATISTICS ************
    128128      mbufs:4096    clusters: 256    free: 241
    129129      drops:   0       waits:   0  drains:   0
     
    140140  .. code-block:: shell
    141141
    142       ************ INTERFACE STATISTICS \************
    143       \***** smc1 \*****
     142      ************ INTERFACE STATISTICS ************
     143      ***** smc1 *****
    144144      Ethernet Address: 00:12:76:43:34:25
    145145      Address:10.8.1.1        Broadcast Address:10.255.255.255  Net mask:255.0.0.0
     
    154154      Underrun:0             Raw output wait:0              Coalesced:0
    155155      Coalesce failed:0                Retries:0
    156       \***** lo0 \*****
     156      ***** lo0 *****
    157157      Address:127.0.0.1       Net mask:255.0.0.0
    158158      Flags: Up Loopback Running Multicast
  • porting/cpu_init.rst

    r2b175c3 r36def91  
    2020
    2121    void _CPU_Initialize(
    22     void            (\*thread_dispatch)  /* may be ignored \*/
     22    void            (*thread_dispatch)  /* may be ignored */
    2323    )
    2424
  • porting/idle_thread.rst

    r2b175c3 r36def91  
    7474.. code:: c
    7575
    76     void \*_CPU_Thread_Idle_body( uintptr_t );
     76    void *_CPU_Thread_Idle_body( uintptr_t );
    7777
    7878As mentioned above, RTEMS does not require that a CPU dependent IDLE
     
    8383.. code:: c
    8484
    85     void \*_Thread_Idle_body( uintptr_t ignored )
     85    void *_Thread_Idle_body( uintptr_t ignored )
    8686    {
    87     while( 1 ) ;
     87      while( 1 ) ;
    8888    }
    8989
     
    9494.. code:: c
    9595
    96     void \*_CPU_Thread_Idle_body( uintptr_t ignored )
     96    void *_CPU_Thread_Idle_body( uintptr_t ignored )
    9797    {
    98     for( ; ; )
    99     /* insert your "halt" instruction here \*/ ;
     98      for( ; ; )
     99        /* insert your "halt" instruction here */ ;
    100100    }
    101101
  • porting/interrupts.rst

    r2b175c3 r36def91  
    8888
    8989    #define _CPU_ISR_Disable( _isr_cookie ) \\
    90     { \\
    91     (_isr_cookie) = 0;   /* do something to prevent warnings \*/ \\
     90    { \
     91      (_isr_cookie) = 0;   /* do something to prevent warnings */ \
    9292    }
    9393
     
    187187.. code:: c
    188188
    189     SCORE_EXTERN void               \*_CPU_Interrupt_stack_low;
    190     SCORE_EXTERN void               \*_CPU_Interrupt_stack_high;
     189    SCORE_EXTERN void               *_CPU_Interrupt_stack_low;
     190    SCORE_EXTERN void               *_CPU_Interrupt_stack_high;
    191191
    192192NOTE: These two variables are required if the macro
     
    215215
    216216    void _CPU_ISR_install_raw_handler(
    217     unsigned32  vector,
    218     proc_ptr    new_handler,
    219     proc_ptr   \*old_handler
     217      unsigned32  vector,
     218      proc_ptr    new_handler,
     219      proc_ptr   *old_handler
    220220    )
    221221
     
    240240    #define CPU_INTERRUPT_NUMBER_OF_VECTORS      32
    241241    #define CPU_INTERRUPT_MAXIMUM_VECTOR_NUMBER \\
    242     (CPU_INTERRUPT_NUMBER_OF_VECTORS - 1)
     242      (CPU_INTERRUPT_NUMBER_OF_VECTORS - 1)
    243243
    244244Install RTEMS Interrupt Handler
     
    255255
    256256    void _CPU_ISR_install_vector(
    257     unsigned32  vector,
    258     proc_ptr    new_handler,
    259     proc_ptr   \*old_handler
     257      unsigned32  vector,
     258      proc_ptr    new_handler,
     259      proc_ptr   *old_handler
    260260    )
    261261
     
    294294
    295295    typedef struct {
    296     unsigned32 not_preserved_register_1;
    297     unsigned32 special_interrupt_register;
     296      unsigned32 not_preserved_register_1;
     297      unsigned32 special_interrupt_register;
    298298    } CPU_Interrupt_frame;
    299299
     
    339339    may need to save some special interrupt information for exit
    340340    #if ( CPU_HAS_SOFTWARE_INTERRUPT_STACK == TRUE )
    341     if ( _ISR_Nest_level == 0 )
    342     switch to software interrupt stack
     341      if ( _ISR_Nest_level == 0 )
     342        switch to software interrupt stack
    343343    #endif
    344344    _ISR_Nest_level++;
    345345    _Thread_Dispatch_disable_level++;
    346     (\*_ISR_Vector_table[ vector ])( vector );
     346    (*_ISR_Vector_table[ vector ])( vector );
    347347    --_ISR_Nest_level;
    348348    if ( _ISR_Nest_level )
    349     goto the label "exit interrupt (simple case)"
     349      goto the label "exit interrupt (simple case)"
    350350    #if ( CPU_HAS_SOFTWARE_INTERRUPT_STACK == TRUE )
    351     restore stack
     351      restore stack
    352352    #endif
    353353    if ( _Thread_Dispatch_disable_level )
    354     goto the label "exit interrupt (simple case)"
     354      goto the label "exit interrupt (simple case)"
    355355    if ( _Thread_Dispatch_necessary )
    356     call _Thread_Dispatch() or prepare to return to _ISR_Dispatch
     356      call _Thread_Dispatch() or prepare to return to _ISR_Dispatch
    357357    prepare to get out of interrupt
    358358    return from interrupt  (maybe to _ISR_Dispatch)
     
    393393.. code:: c
    394394
    395     void (\*_CPU_Thread_dispatch_pointer)();
     395    void (*_CPU_Thread_dispatch_pointer)();
    396396
    397397.. COMMENT: COPYRIGHT (c) 1988-2002.
  • porting/priority_bitmap.rst

    r2b175c3 r36def91  
    5757.. code:: c
    5858
    59     #define _CPU_Bitfield_Find_first_bit( _value, _output ) \\
    60     { \\
    61     (_output) = 0;   /* do something to prevent warnings \*/ \\
     59    #define _CPU_Bitfield_Find_first_bit( _value, _output ) \
     60    { \
     61      (_output) = 0;   /* do something to prevent warnings */ \
    6262    }
    6363
     
    130130
    131131    #if (CPU_USE_GENERIC_BITFIELD_CODE == FALSE)
    132     #define _CPU_Bitfield_Find_first_bit( _value, _output ) \\
    133     { \\
    134     (_output) = 0;   /* do something to prevent warnings \*/ \\
     132    #define _CPU_Bitfield_Find_first_bit( _value, _output ) \
     133    { \
     134      (_output) = 0;   /* do something to prevent warnings */ \
    135135    }
    136136    #endif
  • porting/task_context.rst

    r2b175c3 r36def91  
    6565    #define CPU_STACK_ALIGNMENT        0
    6666
    67 NOTE:  This must be a power of 2 either 0 or greater than CPU_ALIGNMENT. \[XXX is this true?]
     67NOTE:  This must be a power of 2 either 0 or greater than CPU_ALIGNMENT. [XXX is this true?]
    6868
    6969Task Context
     
    150150
    151151    void _CPU_Context_Initialize(
    152     Context_Control \*_the_context,
    153     void            \*_stack_base,
    154     unsigned32       _size,
    155     unsigned32       _isr,
    156     void            \*_entry_point,
    157     unsigned32       _is_fp
     152      Context_Control *_the_context,
     153      void            *_stack_base,
     154      unsigned32       _size,
     155      unsigned32       _isr,
     156      void            *_entry_point,
     157      unsigned32       _is_fp
    158158    );
    159159
     
    187187
    188188    void _CPU_Context_switch(
    189     Context_Control  \*run,
    190     Context_Control  \*heir
     189    Context_Control  *run,
     190    Context_Control  *heir
    191191    );
    192192
     
    240240
    241241    void _CPU_Context_restore(
    242     Context_Control \*new_context
     242      Context_Control *new_context
    243243    );
    244244
     
    258258.. code:: c
    259259
    260     #define _CPU_Context_Restart_self( _the_context ) \\
    261     _CPU_Context_restore( (_the_context) )
     260    #define _CPU_Context_Restart_self( _the_context ) \
     261      _CPU_Context_restore( (_the_context) )
    262262
    263263XXX find a port which does not do it this way and include it here
     
    285285.. code:: c
    286286
    287     #if ( THIS_CPU_FAMILY_HAS_FPU == 1 ) /* where THIS_CPU_FAMILY \*/
    288     /* might be M68K \*/
    289     #define CPU_HARDWARE_FP     TRUE
     287    #if ( THIS_CPU_FAMILY_HAS_FPU == 1 ) /* where THIS_CPU_FAMILY */
     288                                         /* might be M68K */
     289      #define CPU_HARDWARE_FP     TRUE
    290290    #else
    291     #define CPU_HARDWARE_FP     FALSE
     291      #define CPU_HARDWARE_FP     FALSE
    292292    #endif
    293293
     
    439439.. code:: c
    440440
    441     #define _CPU_Context_Fp_start( _base, _offset ) \\
    442     ( (void \*) _Addresses_Add_offset( (_base), (_offset) ) )
     441    #define _CPU_Context_Fp_start( _base, _offset ) \
     442      ( (void *) _Addresses_Add_offset( (_base), (_offset) ) )
    443443
    444444In contrast, the m68k treats the floating point context area as a stack
     
    469469.. code:: c
    470470
    471     #define _CPU_Context_Initialize_fp( _destination ) \\
    472     { \\
    473     \*((Context_Control_fp \*) \*((void \**) _destination)) = \\
    474     _CPU_Null_fp_context; \\
     471    #define _CPU_Context_Initialize_fp( _destination ) \
     472    { \
     473      *((Context_Control_fp *) *((void **) _destination)) = \\
     474        _CPU_Null_fp_context; \\
    475475    }
    476476
     
    484484
    485485The _CPU_Context_save_fp_context routine is responsible for saving the FP
    486 context at \*fp_context_ptr.  If the point to load the FP context from is
     486context at *fp_context_ptr.  If the point to load the FP context from is
    487487changed then the pointer is modified by this routine.
    488488
    489489Sometimes a macro implementation of this is in cpu.h which dereferences
    490 the \** and a similarly named routine in this file is passed something like
    491 a (Context_Control_fp \*).  The general rule on making this decision is to
     490the ** and a similarly named routine in this file is passed something like
     491a (Context_Control_fp *).  The general rule on making this decision is to
    492492avoid writing assembly language.
    493493.. code:: c
    494494
    495495    void _CPU_Context_save_fp(
    496     void \**fp_context_ptr
     496      void **fp_context_ptr
    497497    )
    498498
     
    501501
    502502The _CPU_Context_restore_fp_context is responsible for restoring the FP
    503 context at \*fp_context_ptr.  If the point to load the FP context from is
     503context at *fp_context_ptr.  If the point to load the FP context from is
    504504changed then the pointer is modified by this routine.
    505505
    506506Sometimes a macro implementation of this is in cpu.h which dereferences
    507 the \** and a similarly named routine in this file is passed something like
    508 a (Context_Control_fp \*).  The general rule on making this decision is to
     507the ** and a similarly named routine in this file is passed something like
     508a (Context_Control_fp *).  The general rule on making this decision is to
    509509avoid writing assembly language.
    510510.. code:: c
    511511
    512512    void _CPU_Context_restore_fp(
    513     void \**fp_context_ptr
     513    void **fp_context_ptr
    514514    );
    515515
  • posix_users/input_and_output.rst

    r2b175c3 r36def91  
    689689    #include <libio.h>
    690690    int unmount(
    691         const char \*mount_path
     691        const char *mount_path
    692692    );
    693693
     
    768768    ssize_t writev(
    769769        int                 fd,
    770         const struct iovec \*iov,
     770        const struct iovec *iov,
    771771        int                 iovcnt
    772772    );
  • posix_users/process_environment.rst

    r2b175c3 r36def91  
    524524
    525525    int uname(
    526         struct utsname \*name
     526        struct utsname *name
    527527    );
    528528
     
    593593
    594594    char *getenv(
    595         const char \*name
     595        const char *name
    596596    );
    597597
  • posix_users/signal.rst

    r2b175c3 r36def91  
    528528    int pthread_sigmask(
    529529    int             how,
    530     const sigset_t \*set,
    531     sigset_t       \*oset
     530    const sigset_t *set,
     531    sigset_t       *oset
    532532    );
    533533
  • shell/file_and_directory.rst

    r2b175c3 r36def91  
    13351335following exceptions:
    13361336
    1337 - An asterisk (\*) may not be used as a field width or precision.
     1337- An asterisk (*) may not be used as a field width or precision.
    13381338
    13391339- A byte count or field precision is required for each "s" con- version
  • shell/general_commands.rst

    r2b175c3 r36def91  
    476476the sequence is not output.  Instead, the specified action is performed:
    477477
    478 *\\b*
     478*\b*
    479479    A backspace character is output.
    480480
    481 *\\c*
     481*\c*
    482482    Subsequent output is suppressed.  This is normally used at the end of the
    483483    last argument to suppress the trailing newline that echo would otherwise
    484484    output.
    485485
    486 *\\f*
     486*\f*
    487487    Output a form feed.
    488488
    489 *\\n*
     489*\n*
    490490    Output a newline character.
    491491
    492 *\\r*
     492*\r*
    493493    Output a carriage return.
    494494
    495 *\\t*
     495*\t*
    496496    Output a (horizontal) tab character.
    497497
    498 *\\v*
     498*\v*
    499499    Output a vertical tab.
    500500
    501 *\\0digits*
     501*\0digits*
    502502    Output the character whose value is given by zero to three digits.  If
    503503    there are zero digits, a nul character is output.
    504504
    505 *\\\\*
     505*\\*
    506506    Output a backslash.
    507507
     
    512512**NOTES:**
    513513
    514 The octal character escape mechanism (\\0digits) differs from the C language
     514The octal character escape mechanism (\0digits) differs from the C language
    515515mechanism.
    516516
Note: See TracChangeset for help on using the changeset viewer.