Changeset 873859a4 in rtems


Ignore:
Timestamp:
Jun 9, 2013, 2:13:00 AM (6 years ago)
Author:
Cynthia Rempel <cynt6007@…>
Branches:
4.11, master
Children:
6f8adb0
Parents:
aabfcd0
git-author:
Cynthia Rempel <cynt6007@…> (06/09/13 02:13:00)
git-committer:
Gedare Bloom <gedare@…> (06/12/13 17:52:55)
Message:

Make the default values easier for the configuration GUI to parse

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/user/conf.t

    raabfcd0 r873859a4  
    478478
    479479@item DEFAULT VALUE:
    480 The default for this field is 0.
     480The default value is 0.
    481481
    482482@end table
     
    524524
    525525@item DEFAULT VALUE:
    526 By default, this is not defined and Classic API Notepads are supported.
     526This is not defined by default, and Classic API Notepads are supported.
    527527
    528528@end table
     
    557557
    558558@item DEFAULT VALUE:
    559 The default for this field is 0.
     559The default value is 0.
    560560
    561561@end table
     
    586586
    587587@item DEFAULT VALUE:
    588 The default for this field is 0.
     588The default value is 0.
    589589
    590590@end table
     
    615615
    616616@item DEFAULT VALUE:
    617 The default for this field is 0.
     617The default value is 0.
    618618
    619619@end table
     
    644644
    645645@item DEFAULT VALUE:
    646 The default for this field is 0.
     646The default value is 0.
    647647
    648648@end table
     
    673673
    674674@item DEFAULT VALUE:
    675 The default for this field is 0.
     675The default value is 0.
    676676
    677677@end table
     
    702702
    703703@item DEFAULT VALUE:
    704 The default for this field is 0.
     704The default value is 0.
    705705
    706706@end table
     
    731731
    732732@item DEFAULT VALUE:
    733 The default for this field is 0.
     733The default value is 0.
    734734
    735735@end table
     
    760760
    761761@item DEFAULT VALUE:
    762 The default for this field is 0.
     762The default value is 0.
    763763
    764764@end table
     
    789789
    790790@item DEFAULT VALUE:
    791 The default for this field is 0.
     791The default value is 0.
    792792
    793793@end table
     
    867867
    868868@item DEFAULT VALUE:
    869 By default the value is @code{Init}.
     869The default value is @code{Init}.
    870870
    871871@end table
     
    898898
    899899@item DEFAULT VALUE:
    900 By default the value is @code{rtems_build_name( 'U', 'I', '1', ' ' )}.
     900The default value is @code{rtems_build_name( 'U', 'I', '1', ' ' )}.
    901901
    902902@end table
     
    927927
    928928@item DEFAULT VALUE:
    929 By default value is the configured minimum stack size.
     929The default value is RTEMS_MINIMUM_STACK_SIZE.
    930930
    931931@end table
     
    959959
    960960@item DEFAULT VALUE:
    961 By default the value is one (1) which is the highest priority in the
     961The default value is 1, which is the highest priority in the
    962962Classic API.
    963963
     
    990990
    991991@item DEFAULT VALUE:
    992 By default the tvalue is @code{RTEMS_DEFAULT_ATTRIBUTES}.
     992The default value is @code{RTEMS_DEFAULT_ATTRIBUTES}.
    993993
    994994@end table
     
    10191019
    10201020@item DEFAULT VALUE:
    1021 By default the value is @code{RTEMS_NO_PREEMPT}.
     1021The default value is @code{RTEMS_NO_PREEMPT}.
    10221022
    10231023@end table
     
    10491049
    10501050@item DEFAULT VALUE:
    1051 By default the value is 0.
     1051The default value is 0.
    10521052
    10531053@end table
     
    11181118
    11191119@item DEFAULT VALUE:
    1120 The default for this field is 0.
     1120The default value is 0.
    11211121
    11221122@end table
     
    11621162
    11631163@item DEFAULT VALUE:
    1164 The default for this field is 0.
     1164The default value is 0.
    11651165
    11661166@end table
     
    11911191
    11921192@item DEFAULT VALUE:
    1193 The default for this field is 0.
     1193The default value is 0.
    11941194
    11951195@end table
     
    12201220
    12211221@item DEFAULT VALUE:
    1222 The default for this field is 0.
     1222The default value is 0.
    12231223
    12241224@end table
     
    12511251
    12521252@item DEFAULT VALUE:
    1253 The default for this field is 0.
     1253The default value is 0.
    12541254
    12551255@end table
     
    12801280
    12811281@item DEFAULT VALUE:
    1282 The default for this field is 0.
     1282The default value is 0.
    12831283
    12841284@end table
     
    13091309
    13101310@item DEFAULT VALUE:
    1311 The default for this field is 0.
     1311The default value is 0.
    13121312
    13131313@end table
     
    13401340
    13411341@item DEFAULT VALUE:
    1342 The default for this field is 0.
     1342The default value is 0.
    13431343
    13441344@end table
     
    13731373
    13741374@item DEFAULT VALUE:
    1375 The default for this field is 0.
     1375The default value is 0.
    13761376
    13771377@end table
     
    14021402
    14031403@item DEFAULT VALUE:
    1404 The default for this field is 0.
     1404The default value is 0.
    14051405
    14061406@end table
     
    14311431
    14321432@item DEFAULT VALUE:
    1433 The default for this field is 0.
     1433The default value is 0.
    14341434
    14351435@end table
     
    14601460
    14611461@item DEFAULT VALUE:
    1462 The default for this field is 0.
     1462The default value is 0.
    14631463
    14641464@end table
     
    14991499
    15001500@item DEFAULT VALUE:
    1501 By default, this field is not defined as the user MUST select their own
     1501This field is not defined by default, as the user MUST select their own
    15021502API for initialization tasks.
    15031503
     
    15401540
    15411541@item DEFAULT VALUE:
    1542 By default the value is @code{POSIX_Init}.
     1542The default value is @code{POSIX_Init}.
    15431543
    15441544@end table
     
    15711571
    15721572@item DEFAULT VALUE:
    1573 By default value is twice the configured minimum stack size.
     1573The default value is 2 * RTEMS_MINIMUM_STACK_SIZE.
    15741574
    15751575@end table
     
    16471647
    16481648@item DEFAULT VALUE:
    1649 By default, this is undefined which specifies that the C Program Heap
     1649This is not defined by default, which specifies that the C Program Heap
    16501650and the RTEMS Workspace will be separate.
    16511651
     
    16891689
    16901690@item DEFAULT VALUE:
    1691 When not defined, the clock tick quantum is configured to be 10,000
     1691This is not defined by default. When not defined,
     1692the clock tick quantum is configured to be 10,000
    16921693microseconds which is ten (10) milliseconds.
    16931694
     
    17391740
    17401741@item DEFAULT VALUE:
    1741 If unspecified, this parameter defaults to fifty (50).
     1742The default value is 50.
    17421743
    17431744@end table
     
    17731774
    17741775@item DEFAULT VALUE:
    1775 By default, RTEMS must support 256 priority levels to be compliant with
    1776 various standards. These priorities range from zero (0) to 255.  Thus,
    1777 the default value for this field is 255.
     1776The default value is 255, because RTEMS must support 256 priority levels to be
     1777compliant with various standards. These priorities range from zero (0) to 255.
    17781778
    17791779@end table
     
    18191819
    18201820@item DEFAULT VALUE:
    1821 When not defined by the application, this is set to the recommended
     1821This is not defined by default, which sets the executive to the recommended
    18221822minimum stack size for this processor.
    18231823
     
    18601860
    18611861@item DEFAULT VALUE:
    1862 If not specified, the interrupt stack will be of minimum size.
    1863 The default value is the configured minimum task stack size.
     1862The default value is CONFIGURE_MINIMUM_TASK_STACK_SIZE, which is the minimum
     1863interrupt stack size.
    18641864
    18651865@end table
     
    18991899
    19001900@item DEFAULT VALUE:
    1901 When this is not defined, the default value is 0.
     1901The default value is 0.
    19021902
    19031903@end table
     
    19351935
    19361936@item DEFAULT VALUE:
    1937 Unless overridden by the BSP, this is not defined by default.  The default
    1938 is @b{NOT} to zero out the RTEMS Workspace or C Program Heap.
     1937This is not defined by default, unless overridden by the BSP.
     1938The default is @b{NOT} to zero out the RTEMS Workspace or C Program Heap.
    19391939
    19401940@end table
     
    19671967
    19681968@item DEFAULT VALUE:
    1969 By default, this is not defined and thus stack checking is disabled.
     1969This is not defined by default, and thus stack checking is disabled.
    19701970
    19711971@end table
     
    20012001
    20022002@item DEFAULT VALUE:
    2003 This value is not defined by default.
     2003This is not defined by default.
    20042004
    20052005@end table
     
    20412041
    20422042@item DEFAULT VALUE:
    2043 The default value for this field is NULL which indicates that
     2043The default value is NULL, which indicates that
    20442044task stacks will be allocated from the RTEMS Workspace.
    20452045
     
    20802080
    20812081@item DEFAULT VALUE:
    2082 The default value for this field is @code{_Workspace_Allocate} which indicates
     2082The default value is @code{_Workspace_Allocate}, which indicates
    20832083that task stacks will be allocated from the RTEMS Workspace.
    20842084
     
    21172117
    21182118@item DEFAULT VALUE:
    2119 The default value for this field is @code{_Workspace_Free} which indicates that
     2119The default value is @code{_Workspace_Free}, which indicates that
    21202120task stacks will be allocated from the RTEMS Workspace.
    21212121
     
    21622162
    21632163@item DEFAULT VALUE:
    2164 None.
     2164The default value is None.
    21652165
    21662166@end table
     
    22032203
    22042204@item DEFAULT VALUE:
    2205 By default, this is not defined and zero (0) memory is reserved.
     2205This is not defined by default, and zero (0) memory is reserved.
    22062206
    22072207@end table
     
    23322332
    23332333@item DEFAULT VALUE:
    2334 This is undefined by default and Malloc Statistics are disabled.
     2334This is not defined by default, and Malloc Statistics are disabled.
    23352335
    23362336@end table
     
    23632363
    23642364@item DEFAULT VALUE:
    2365 If not defined, the default value is either zero (0) or three if
    2366 @code{CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER} is defined. Three file
    2367 descriptors allows RTEMS to support standard input, output, and error
    2368 I/O streams on @code{/dev/console}.
     2365
     2366If @code{CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER} is defined, then the
     2367default value is 3, otherwise the default value is 0.
     2368
     2369Three file descriptors allows RTEMS to support standard input, output, and
     2370error I/O streams on @code{/dev/console}.
    23692371
    23702372@end table
     
    23952397
    23962398@item DEFAULT VALUE:
    2397 By default, this is not defined and resources are reserved for the
     2399This is not defined by default, and resources are reserved for the
    23982400termios functionality.
    23992401
     
    24272429
    24282430@item DEFAULT VALUE:
    2429 By default, this is set to one (1) so a console port can be used.
     2431The default value is 1, so a console port can be used.
    24302432
    24312433@end table
     
    25032505
    25042506@item DEFAULT VALUE:
    2505 This value is not defined by default. If no other root file system
     2507This is not defined by default. If no other root file system
    25062508configuration parameters are specified, the IMFS will be used as the
    25072509root file system.
     
    25372539
    25382540@item DEFAULT VALUE:
    2539 This value is not defined by default. If no other root file system
     2541This is not defined by default. If no other root file system
    25402542configuration parameters are specified, the IMFS will be used as the
    25412543root file system.
     
    25722574
    25732575@item DEFAULT VALUE:
    2574 This value is not defined by default. If no other root file system
     2576This is not defined by default. If no other root file system
    25752577configuration parameters are specified, the IMFS will be used as the
    25762578root file system.
     
    26122614
    26132615@item DEFAULT VALUE:
    2614 This option is not defined by default.
     2616This is not defined by default.
    26152617
    26162618@end table
     
    26422644
    26432645@item DEFAULT VALUE:
    2644 The default value is 32KiB.
     2646The default value is 32768 bytes.
    26452647
    26462648@end table
     
    28682870
    28692871@item DEFAULT VALUE:
    2870 The default value is the RTEMS minimum stack size.
     2872The default value is RTEMS_MINIMUM_STACK_SIZE.
    28712873
    28722874@end table
     
    32923294
    32933295@item DEFAULT VALUE:
    3294 By default, this is not defined.
     3296This is not defined by default.
    32953297
    32963298@end table
     
    33223324
    33233325@item DEFAULT VALUE:
    3324 If not specified, the IDLE task will have a stack of the configured
    3325 minimum stack size.
     3326The default value is RTEMS_MINIMUM_STACK_SIZE.
    33263327
    33273328@end table
     
    33523353
    33533354@item DEFAULT VALUE:
    3354 By default, this is not the mode of operation and the user is assumed
     3355This is not defined by default, the user is assumed
    33553356to provide one or more initialization tasks.
    33563357
     
    34043405
    34053406@item DEFAULT VALUE:
    3406 This is the default scheduler and specifying this configuration parameter
    3407 is redundant.
     3407This is defined by default.
     3408This is the default scheduler and specifying this
     3409configuration parameter is redundant.
    34083410
    34093411@end table
     
    35983600
    35993601@item DEFAULT VALUE:
     3602This is not defined by default.
    36003603
    36013604@end table
     
    37283731
    37293732@item DEFAULT VALUE:
    3730 By default, this is not defined indicating the @code{<rtems/confdefs.h>}
     3733This is not defined default, indicating the @code{<rtems/confdefs.h>}
    37313734is providing the device driver table.
    37323735
     
    37613764
    37623765@item DEFAULT VALUE:
    3763 By default, this is set to the number of device drivers configured
    3764 using the @code{CONFIGURE_APPLICATIONS_NEEDS_XXX_DRIVER} configuration
    3765 parameters.
     3766This is computed by default, and is set to the number of device drivers
     3767configured using the @code{CONFIGURE_APPLICATIONS_NEEDS_XXX_DRIVER}
     3768configuration parameters.
    37663769
    37673770@end table
     
    38303833
    38313834@item DEFAULT VALUE:
    3832 By default, this is not defined.
     3835This is not defined by default.
    38333836
    38343837@end table
     
    38633866
    38643867@item DEFAULT VALUE:
    3865 By default, this is not defined.
     3868This is not defined by default.
    38663869
    38673870@end table
     
    38983901
    38993902@item DEFAULT VALUE:
    3900 By default, this is not defined.
     3903This is not defined by default.
    39013904
    39023905@end table
     
    39643967
    39653968@item DEFAULT VALUE:
    3966 By default, this is not defined.
     3969This is not defined by default.
    39673970
    39683971@end table
     
    39974000
    39984001@item DEFAULT VALUE:
    3999 By default, this is not defined.
     4002This is not defined by default.
    40004003
    40014004@end table
     
    40304033
    40314034@item DEFAULT VALUE:
    4032 By default, this is not defined.
     4035This is not defined by default.
    40334036
    40344037@end table
     
    40634066
    40644067@item DEFAULT VALUE:
    4065 By default, this is not defined.
     4068This is not defined by default.
    40664069
    40674070@end table
     
    40934096
    40944097@item DEFAULT VALUE:
    4095 By default,this is not defined.
     4098This is not defined by default.
    40964099
    40974100@end table
     
    41324135
    41334136@item DEFAULT VALUE:
    4134 By default,this is not defined.
     4137This is not defined by default.
    41354138
    41364139@end table
     
    41644167
    41654168@item DEFAULT VALUE:
    4166 By default,this is not defined.
     4169This is not defined by default.
    41674170
    41684171@end table
     
    41944197
    41954198@item DEFAULT VALUE:
    4196 By default,this is not defined.
     4199This is not defined by default.
    41974200
    41984201@end table
     
    42684271
    42694272@item DEFAULT VALUE:
    4270 If not defined, it is set to @code{NODE_NUMBER} which is assumed to be
     4273The default value is @code{NODE_NUMBER}, which is assumed to be
    42714274set by the compilation environment.
    42724275
     
    43024305
    43034306@item DEFAULT VALUE:
    4304 The default is two (2).
     4307The default is 2.
    43054308
    43064309@end table
     
    43314334
    43324335@item DEFAULT VALUE:
    4333 The default is 32.
     4336The default value is 32.
    43344337
    43354338@end table
     
    43614364
    43624365@item DEFAULT VALUE:
    4363 The default is 32.
     4366The default value is 32.
    43644367
    43654368@end table
     
    45374540
    45384541@item DEFAULT VALUE:
    4539 By default, this is undefined which implies zero (0) @i{fake} Ada Tasks.
     4542This is not defined by default, which implies zero (0) @i{fake} Ada Tasks.
    45404543
    45414544@end table
Note: See TracChangeset for help on using the changeset viewer.