[RTEMS Project] #3075: rtems_interrupt_lock_acquire interface documentation issue in the "RTEMS C Users Guide"

[RTEMS trac]

#3075: rtems_interrupt_lock_acquire interface documentation issue in the "RTEMS C
Users Guide"
---------------------------+------------------------------------
 Reporter:  Jeffrey Hill   |      Owner:  chrisj@…
     Type:  defect         |     Status:  new
 Priority:  low            |  Milestone:
Component:  Documentation  |    Version:  4.11
 Severity:  minor          |   Keywords:  interrupt lock acquire
---------------------------+------------------------------------
 I suspect that in this section it should indicate that the second argument
 is "rtems_interrupt_level * level" instead of "rtems_interrupt_level
 level". Furthermore, perhaps it should state that the function is caching
 some type of opaque context inside of "level" to be restored when the lock
 is released. Also, perhaps a better argument name would be "pPrvCtx"? The
 documentation might also divulge additional _functional_ details about
 what occurs on an SMP system. Does it prevent interrupts from running on
 all CPUs simultaneously when the lock is acquired? It does say something
 about an SMP lock, but that perhaps is an implementation detail, and not a
 functional description of what the function does.

 {{{
 7.4.8 INTERRUPT_LOCK_ACQUIRE - Acquire an ISR Lock
 CALLING SEQUENCE:

 void rtems_interrupt_lock_acquire(
   rtems_interrupt_lock *lock,
   rtems_interrupt_level level
 );
 }}}

--
Ticket URL: <http://devel.rtems.org/ticket/3075>
RTEMS Project <http://www.rtems.org/>
RTEMS Project