Changeset d12091dc in rtems


Ignore:
Timestamp:
Nov 3, 2008, 7:02:25 PM (12 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.9
Children:
3d15f1b2
Parents:
421d76d7
Message:

2008-11-03 Joel Sherrill <joel.sherrill@…>

PR 1334/doc

  • user/Makefile.am, user/concepts.t, user/init.t, user/overview.t, user/part.t, user/task.t: Correct typos and correctly document 4 parts of 32-bit object id.
  • user/ObjectId-32Bits.eps, user/ObjectId-32Bits.png: New files.
Location:
doc
Files:
2 added
7 edited

Legend:

Unmodified
Added
Removed
  • doc/ChangeLog

    r421d76d7 rd12091dc  
     12008-11-03      Joel Sherrill <joel.sherrill@OARcorp.com>
     2
     3        PR 1334/doc
     4        * user/Makefile.am, user/concepts.t, user/init.t, user/overview.t,
     5        user/part.t, user/task.t: Correct typos and correctly document 4
     6        parts of 32-bit object id.
     7        * user/ObjectId-32Bits.eps, user/ObjectId-32Bits.png: New files.
     8
    192008-09-30      Joel Sherrill <joel.sherrill@oarcorp.com>
    210
  • doc/user/Makefile.am

    r421d76d7 rd12091dc  
    2828TXT_FILES = rtemsarc.txt rtemspie.txt states.txt
    2929
    30 PNG_FILES = rtemsarc.png rtemspie.png states.png
     30PNG_FILES = rtemsarc.png rtemspie.png states.png ObjectId-32Bits.png
    3131
    3232EPS_IMAGES = rtemspie.eps states.eps
  • doc/user/concepts.t

    r421d76d7 rd12091dc  
    120120
    121121An object ID is a unique unsigned thirty-two bit
    122 entity composed of three parts: object class, node, and index.
     122entity composed of three parts: API, object class, node, and index.
    123123The data type @code{@value{DIRPREFIX}id} is used to store object IDs.
    124124
     
    127127@example
    128128@group
    129      31        26 25              16 15                             0
    130      +-----------+------------------+-------------------------------+
    131      |           |                  |                               |
    132      |   Class   |       Node       |             Index             |
    133      |           |                  |                               |
    134      +-----------+------------------+-------------------------------+
     129     31      27 26   24 23          16 15                             0
     130     +---------+-------+--------------+-------------------------------+
     131     |         |       |              |                               |
     132     |  Class  |  API  |     Node     |             Index             |
     133     |         |       |              |                               |
     134     +---------+-------+--------------+-------------------------------+
    135135@end group
    136136@end example
     
    138138
    139139@ifset use-tex
    140 @sp 1
    141 @tex
    142 \centerline{\vbox{\offinterlineskip\halign{
    143 \strut#&
    144 \hbox to 0.50in{\enskip#}&
    145 \hbox to 0.50in{\enskip#}&
    146 #&
    147 \hbox to 0.50in{\enskip#}&
    148 \hbox to 0.50in{\enskip#}&
    149 #&
    150 \hbox to 1.00in{\enskip#}&
    151 \hbox to 1.00in{\enskip#}&
    152 #\cr
    153 \multispan{9}\cr
    154 \multispan{2}31\hfil&\multispan{2}\hfil26\enskip&
    155  \multispan{1}\enskip25\hfil&\multispan{2}\hfil16\enskip&
    156  \multispan{1}\enskip15\hfil&\multispan{2}\hfil0\cr
    157 &&&&&&&&&\cr
    158 }}\hfil}
    159 \centerline{\vbox{\offinterlineskip\halign{
    160 \strut\vrule#&
    161 \hbox to 0.50in{\enskip#}&
    162 \hbox to 0.50in{\enskip#}&
    163 \vrule#&
    164 \hbox to 0.50in{\enskip#}&
    165 \hbox to 0.50in{\enskip#}&
    166 \vrule#&
    167 \hbox to 0.50in{\enskip#}&
    168 \hbox to 0.50in{\enskip#}&
    169 \vrule#\cr
    170 \multispan{9}\cr
    171 \noalign{\hrule}
    172 &&&&&&&&&\cr
    173 &\multispan{2}\hfil Class\hfil&&
    174  \multispan{2}\hfil Node\hfil&&
    175  \multispan{2}\hfil Index\hfil&\cr
    176 &&&&&&&&&\cr
    177 \noalign{\hrule}
    178 }}\hfil}
    179 @end tex
     140@sp1
     141@center{@image{ObjectId-32Bits,,2in}}
    180142@end ifset
    181143
    182144@ifset use-html
    183145@html
    184 <CENTER>
    185   <TABLE COLS=6 WIDTH="60%" BORDER=0>
    186 <TR><TD ALIGN=left><STRONG>31</STRONG></TD>
    187     <TD ALIGN=right><STRONG>26</STRONG></TD>
    188     <TD ALIGN=left><STRONG>25</STRONG></TD>
    189     <TD ALIGN=right><STRONG>16</STRONG></TD>
    190     <TD ALIGN=left><STRONG>15</STRONG></TD>
    191     <TD ALIGN=right><STRONG>0</STRONG></TD></TR>
    192   </TABLE>
    193 </CENTER>
    194 <CENTER>
    195   <TABLE COLS=6 WIDTH="60%" BORDER=2>
    196 <TR><TD ALIGN=center COLSPAN=2>Class</TD>
    197     <TD ALIGN=center COLSPAN=2>Node</TD>
    198     <TD ALIGN=center COLSPAN=2>Index</TD></TD>
    199   </TABLE>
    200 </CENTER>
     146<IMG SRC="ObjectId-16Bits.png" WIDTH=550 HEIGHT=400 ALT="32 Bit Object Id">
    201147@end html
    202148@end ifset
    203149
    204 The most significant six bits are the object class.  The next
    205 ten bits are the number of the node on which this object was
    206 created.  The node number is always one (1) in a single
     150
     151The most significant five bits are the object class.  The next
     152three bits indicate the API to which the object class belongs.
     153The next eight bits (16-23) are the number of the node on which
     154this object was created.  The node number is always one (1) in a single
    207155processor system.  The least significant sixteen bits form an
    208156identifier within a particular object type.  This identifier,
     
    210158number of objects configured for this object type.
    211159
    212 
    213 The three components of an object ID make it possible
     160The four components of an object ID make it possible
    214161to quickly locate any object in even the most complicated
    215162multiprocessor system.  Object ID's are associated with an
  • doc/user/init.t

    r421d76d7 rd12091dc  
    166166The effect of calling any blocking RTEMS directives before
    167167@code{@value{DIRPREFIX}initialize_start_multitasking}
    168 is unpredictable but guaranteed to be bad.  Afer the
     168is unpredictable but guaranteed to be bad.  After the
    169169directive @code{@value{DIRPREFIX}initialize_data_structures}
    170170is invoked, it is permissible to allocate RTEMS objects and
  • doc/user/overview.t

    r421d76d7 rd12091dc  
    333333leave out all services that are not required from the run-time
    334334environment.  Features such as networking, various fileystems,
    335 and many other features are completely optionsl.  This allows
     335and many other features are completely optional.  This allows
    336336the application designer the flexibility to tailor RTEMS to most
    337337efficiently meet system requirements while still satisfying even
  • doc/user/part.t

    r421d76d7 rd12091dc  
    201201target architecture.
    202202
    203 Th @code{buffer_size} parameter must be a multiple of
     203The @code{buffer_size} parameter must be a multiple of
    204204the CPU alignment factor.  Additionally, @code{buffer_size}
    205205must be large enough to hold two pointers on the target
  • doc/user/task.t

    r421d76d7 rd12091dc  
    945945
    946946@subheading DESCRIPTION:
    947 This directive readies the task, specified by tid, for execution
     947This directive readies the task, specified by @code{id}, for execution
    948948based on the priority and execution mode specified when the task
    949949was created.  The starting address of the task is given in
    950 entry_point.  The task's starting argument is contained in
     950@code{entry_point}.  The task's starting argument is contained in
    951951argument.  This argument can be a single value or used as an index into an
    952952array of parameter blocks.  The type of this numeric argument is an unsigned
Note: See TracChangeset for help on using the changeset viewer.