Changeset e4ced53 in rtems
- Timestamp:
- 10/15/13 17:14:13 (10 years ago)
- Branches:
- 4.11, 5, master
- Children:
- 1f724a0
- Parents:
- 816a9cad
- git-author:
- Shubham Somani <shubhamsomani92@…> (10/15/13 17:14:13)
- git-committer:
- Gedare Bloom <gedare@…> (10/15/13 17:14:13)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/user/conf.t
r816a9cad re4ced53 182 182 information. However, it is quite easy to use a library and forget to 183 183 account for its resources. 184 185 @c 186 @c === Format to be followed for making changes in this file === 187 @c 188 @section Format to be followed for making changes in this file 189 190 @itemize @bullet 191 @item MACRO NAME 192 Should be alphanumeric. Can have '_' (underscore). 193 194 @item DATA TYPE 195 Please refer to all existing formats. 196 197 @item RANGE: 198 The range depends on the Data Type of the macro. 199 @itemize @minus 200 @item If the data type is of type task priority, then its value should 201 be an integer in the range of 1 to 255. 202 203 @item If the data type is an integer, then it can have numbers, characters 204 (in case the value is defined using another macro) and arithmetic operations 205 (+, -, *, /). 206 207 @item If the data type is a function pointer the first character 208 should be an alphabet or an underscore. The rest of the string 209 can be alphanumeric. 210 211 @item If the data type is RTEMS Attributes or RTEMS Mode then 212 the string should be alphanumeric. 213 214 @item If the data type is RTEMS NAME then the value should be 215 an integer>=0 or RTEMS_BUILD_NAME( 'U', 'I', '1', ' ' ) 216 @end itemize 217 218 @item DEFAULT VALUE 219 The default value should be in the following formats- 220 Please note that the '.' (full stop) is necessary. 221 222 @itemize @minus 223 @item In case the value is not defined then: 224 This is not defined by default. 225 226 @item If we know the default value then: 227 The default value is XXX. 228 229 @item If the default value is BSP Specific then: 230 This option is BSP specific. 231 @end itemize 232 233 @item DESCRIPTION 234 The description of the macro. (No specific format) 235 236 @item NOTES 237 Any further notes. (No specific format) 238 239 @end itemize 184 240 185 241 @c
Note: See TracChangeset
for help on using the changeset viewer.