Changeset aa41429 in rtems
- Timestamp:
- Feb 18, 2003, 4:16:12 PM (18 years ago)
- Branches:
- 4.10, 4.11, 4.8, 4.9, 5, master
- Children:
- 64151bf
- Parents:
- b22fa3ab
- Location:
- doc/develenv
- Files:
-
- 3 edited
- 3 moved
Legend:
- Unmodified
- Added
- Removed
-
doc/develenv/ChangeLog
rb22fa3ab raa41429 1 2003-02-18 Joel Sherrill <joel@OARcorp.com> 2 3 * Makefile.am, develenv.texi: Relect generating .texi from .t's. 4 * direct.t, sample.t, utils.t: New files. 5 * direct.texi, sample.texi, utils.texi: Removed. Now generated from 6 corresponding .t files which are in the process of being updated. 7 This commit is a anspshot of the update effort. 1 8 2003-01-25 Ralf Corsepius <corsepiu@faw.uni-ulm.de> 2 9 -
doc/develenv/Makefile.am
rb22fa3ab raa41429 16 16 FILES = compile.texi direct.texi intro.texi sample.texi utils.texi 17 17 18 GENERATED_FILES = direct.texi sample.texi utils.texi 19 18 20 COMMON_FILES = $(top_srcdir)/common/setup.texi \ 19 21 $(top_srcdir)/common/cpright.texi 20 22 21 23 info_TEXINFOS = develenv.texi 22 develenv_TEXINFOS = $(FILES) $(COMMON_FILES) 24 develenv_TEXINFOS = $(FILES) $(COMMON_FILES) $(GENERATED_FILES) 25 26 $(srcdir)/direct.texi: direct.t 27 $(BMENU2) -p "Introduction" \ 28 -u "Top" \ 29 -n "Sample Applications" < $< > $@ 30 31 $(srcdir)/sample.texi: sample.t 32 $(BMENU2) -p "Directory Structure Test Suite Source Directory" \ 33 -u "Top" \ 34 -n "RTEMS Specific Utilities" < $< > $@ 35 36 $(srcdir)/utils.texi: utils.t 37 $(BMENU2) -p "Sample Applications Paranoia Floating Point Application" \ 38 -u "Top" \ 39 -n "Command and Variable Index" < $< > $@ -
doc/develenv/develenv.texi
rb22fa3ab raa41429 1 1 \input texinfo @c -*-texinfo-*- 2 2 @c %**start of header 3 @setfilename develenv .info3 @setfilename develenv 4 4 @setcontentsaftertitlepage 5 5 @syncodeindex vr fn … … 99 99 @c 100 100 101 @node Command and Variable Index, Concept Index, RTEMS Specific Utilities Ada Language Specific Utilities, Top101 @node Command and Variable Index, Concept Index, RTEMS Specific Utilities size_rtems - report RTEMS size information, Top 102 102 @unnumbered Command and Variable Index 103 103 -
doc/develenv/direct.t
rb22fa3ab raa41429 7 7 @c 8 8 9 @ifinfo10 @node Directory Structure, Directory Structure Suites, Introduction, Top11 @end ifinfo12 9 @chapter Directory Structure 13 @ifinfo14 @menu15 * Directory Structure Suites::16 @end menu17 @end ifinfo18 10 19 11 The RTEMS directory structure is designed to meet … … 25 17 @item isolate processor and target dependent code, while 26 18 allowing as much common source code as possible to be shared 27 across multiple processors and target s.19 across multiple processors and target boards. 28 20 29 21 @item allow multiple RTEMS users to perform simultaneous … … 33 25 34 26 The resulting directory structure has processor and 35 target dependent source files isolated from generic files. When 36 RTEMS is built, object directories and an install point will be 37 automatically created based upon the target BSP selected. The 38 placement of object files based upon the selected BSP name 39 insures that object files are not mixed across CPUs or targets. 40 This in combination with the make files allows the specific 27 board dependent source files isolated from generic files. When 28 RTEMS is configured and built, object directories and 29 an install point will be automatically created based upon 30 the target CPU family and BSP selected. 31 32 The placement of object files based upon the selected BSP name 33 ensures that object files are not mixed across CPUs or targets. 34 This in combination with the makefiles allows the specific 41 35 compilation options to be tailored for a particular target 42 36 board. For example, the efficiency of the memory subsystem for … … 48 42 memory. It is impossible to achieve this degree of flexibility 49 43 without providing source code. 50 @ifinfo 51 @node Directory Structure Suites, C Suites, Directory Structure, Directory Structure 52 @end ifinfo 53 @section Suites 54 @ifinfo 55 @menu 56 * C Suites:: 57 * Executive Source Directory:: 58 * Support Library Source Directory:: 59 * Test Suite Source Directory:: 60 @end menu 61 @end ifinfo 44 45 @c 46 @c Directory Organization 47 @c 48 @section Directory Organization 62 49 63 50 The RTEMS source tree is organized based on the 64 following fourvariables:51 following variables: 65 52 66 53 @itemize @bullet 67 @item language, 68 69 @item target processor ,70 71 @item target board, and72 73 @item compiler vendor (Ada only). 54 55 @item functionality, 56 @item target processor family, 57 @item target processor model, 58 @item peripherals, and 59 @item target board. 60 74 61 @end itemize 75 62 76 The language may be either C or Ada and there is 77 currently nothing shared between the source trees for these two 78 implementations of RTEMS. The user generally selects the 79 subdirectory for the implementation they are using and ignores 80 that for the other implementation. The only exceptions to this 81 normally occurs when comparing the source code for the two 82 implementations or when porting both to a new CPU or target 83 board. The following shows the top level RTEMS directory 84 structure which includes directories for each language 85 implementation and a language independent source documentation 86 directory. The source documentation directory is currently not 87 supported. 88 89 @c 90 @c Tree 1 - Top Level 91 @c 92 93 @ifset use-ascii 94 @example 95 @group 96 RTEMS 97 | 98 +-----------------------+-----------------------+ 99 | | 100 c doc 101 @end group 102 @end example 103 @end ifset 63 Each of the following sections will describe the 64 contents of the directories in the RTEMS source 65 tree. The top of the tree will be referenced 66 as @code{$@{RTEMS_ROOT@}} in this discussion. 67 68 @c 69 @c Top Level Tree 70 @c 71 72 @c @ifset use-ascii 73 @example 74 @group 75 rtems-VERSION 76 | 77 +--------+----+----+----+--+-----+---+------+-----+ 78 | | | | | | | | | 79 aclocal automake c contrib cpukit doc make scripts tools 80 @end group 81 @end example 82 @c @end ifset 104 83 105 84 @ifset use-tex 106 @sp 1 107 108 @tex 109 {\parskip=0pt\offinterlineskip% 110 \hskip 15.0em 111 \hskip 1.25em\hbox to 3.00em{\hss{RTEMS}\hss}% 112 \vrule width0em height1.972ex depth0.812ex\par\penalty10000 113 \hskip 15.0em 114 \hskip 2.75em\vrule width.04em% 115 \vrule width0em height1.500ex depth0.500ex\par\penalty10000 116 \hskip 15.0em 117 \hskip 0.25em\vrule width2.50em height-0.407ex depth0.500ex% 118 \vrule width.04em\vrule width2.50em height-0.407ex depth0.500ex% 119 \vrule width0em height1.500ex depth0.500ex\par\penalty10000 120 \hskip 15.0em 121 \hskip 0.25em\vrule width.04em% 122 \hskip 4.92em\vrule width.04em% 123 \vrule width0em height1.500ex depth0.500ex\par\penalty10000 124 \hskip 15.0em 125 \hskip 0.00em\hbox to 0.50em{\hss{c}\hss}% 126 \hskip 1.50em\hbox to 1.50em{\hss{ }\hss}% 127 \hskip 1.00em\hbox to 1.50em{\hss{doc}\hss}% 128 \vrule width0em height1.972ex depth0.812ex\par} 129 @end tex 130 @end ifset 131 132 @c 133 @c for now continue to use the ascii 134 @c 85 @end ifset 86 135 87 @ifset use-html 136 @example137 @group138 RTEMS139 |140 +-----------------------+-----------------------+141 | |142 c doc143 @end group144 @end example145 88 @html 146 89 @end html 147 90 @end ifset 148 91 149 Each of the following sections will describe the150 contents of the directories in the RTEMS source151 tree.152 153 @ifinfo154 @node C Suites, Executive Source Directory, Directory Structure Suites, Directory Structure Suites155 @end ifinfo156 @subsection C Suites157 158 The following table lists the suites currently included with the159 C implementation of RTEMS and the directory in which they may be located:160 161 @ifset use-texinfo-tables162 92 @table @code 163 @item Support Libraries (BSPs, C library, CPU support) 164 $RTEMS_ROOT/c/src/lib 165 166 @item Single Processor Tests 167 $RTEMS_ROOT/c/src/tests/sptests 168 169 @item Timing Tests 170 $RTEMS_ROOT/c/src/tests/tmtests 171 172 @item Multiprocessor Tests 173 $RTEMS_ROOT/c/src/tests/mptests 174 175 @item Sample Applications 176 $RTEMS_ROOT/c/src/tests/samples 177 178 @item RTEMS Build Tools 179 $RTEMS_SRC_BASE/c/build_tools 180 181 @item Make Support 182 $RTEMS_ROOT/c/make 93 @item $@{RTEMS_ROOT@}/aclocal/ 94 This directory contains the custom M4 macros which are available to 95 the various GNU autoconf @code{configure.ac} scripts throughout 96 the RTEMS source tree. GNU autoconf interprets @code{configure.ac} 97 files to produce the @code{configure} files used to tailor 98 RTEMS build for a particular host and target environment. The 99 contents of this directory will not be discussed further in this 100 document. 101 102 @item $@{RTEMS_ROOT@}/automake/ 103 This directory contains the custom GNU automake fragments 104 which are used to support the various @code{Makefile.am} 105 files throughout the RTEMS source tree. The 106 contents of this directory will not be discussed 107 further in this document. 108 109 @item $@{RTEMS_ROOT@}/c/ 110 This directory is the root of the portions of the RTEMS source 111 tree which must be built tailored for a particular CPU model 112 or BSP. The contents of this directory will be discussed 113 in the @ref{Directory Structure c/ Directory} section. 114 115 @item $@{RTEMS_ROOT@}/contrib/ 116 This directory contains contributed support software. Currently 117 this directory contains the RPM specifications for cross-compilers 118 hosted on GNU/Linux that target Cygwin and Solaris. The 119 cross-compilers produced using these specifications are then 120 used in a Canadian cross build procedure to produce the Cygwin 121 and Solaris hosted RTEMS toolsets on a GNU/Linux host. This 122 directory will not be discussed further in this document. 123 124 @item $@{RTEMS_ROOT@}/cpukit/ 125 This directory is the root for all of the "multilib'able" 126 portions of RTEMS. This is a GNU way of saying the the 127 contents of this directory can be compiled like the 128 C Library (@code{libc.a}) and the functionality is 129 neither CPU model nor BSP specific. The source code 130 for most RTEMS services reside under this directory. 131 The contents of this directory will be discussed 132 in the @ref{Directory Structure CPUKit Directory} section. 133 134 @item $@{RTEMS_ROOT@}/doc/ 135 This directory is the root for all RTEMS documentation. 136 The source for RTEMS is written in GNU TeXinfo and 137 used to produce HTML, PDF, and "info" files. 138 The RTEMS documentation is configured, built, 139 and installed separately from the RTEMS executive and tests. 140 The contents of this directory will be discussed 141 in the @ref{Directory Structure Documentation Directory} section. 142 143 @item $@{RTEMS_ROOT@}/make/ 144 This directory contains files which support the 145 RTEMS Makefile's. From a user's perspective, the 146 most important parts are found in the @code{custom/} 147 subdirectory. Each ".cfg" file in this directory 148 is associated with a specific BSP and describes 149 the CPU model, compiler flags, and procedure to 150 a produce an executable for the target board. 151 These files are described in detail in the 152 @b{RTEMS BSP and Device Driver Development Guide} 153 and will not be discussed further in this document. 154 155 @item $@{RTEMS_ROOT@}/scripts/ 156 This directory contains the RPM specifications for the 157 prebuilt cross-compilation toolsets provided by the 158 RTEMS project. There are separate subdirectories 159 for each of the components in the RTEMS Cross Compilation 160 Environment including @code{binutils/}, @code{gcc3newlib/}, 161 and @code{gdb/}. This directory is configured, built, 162 and installed separately from the RTEMS executive 163 and tests. This directory will not be discussed further 164 in this document. 165 166 @item $@{RTEMS_ROOT@}/tools/ 167 This directory contains RTEMS specific support utilities which 168 execute on the development host. These utilities are divided 169 into subdirectories based upon whether they are used in the process 170 of building RTEMS and applications, are CPU specific, or are 171 used to assist in updating the RTEMS source tree and applications. 172 The support utilities used in the process of building RTEMS are 173 described in @ref{RTEMS Specific Utilities}. These are the 174 only components of this subtree that will be discussed in this 175 document. 176 183 177 @end table 184 @end ifset 185 186 @ifclear use-texinfo-tables 187 @html 188 <CENTER> 189 <TABLE COLS=2 WIDTH="80%" BORDER=2> 190 <TR><TD ALIGN=center>Support Libraries (BSPs, C library, CPU support)</TD> 191 <TD ALIGN=center>$RTEMS_ROOT/c/src/lib</TD></TR> 192 <TR><TD ALIGN=center>Single Processor Tests</TD> 193 <TD ALIGN=center>$RTEMS_ROOT/c/src/tests/sptests</TD></TR> 194 <TR><TD ALIGN=center>Timing Tests</TD> 195 <TD ALIGN=center>$RTEMS_ROOT/c/src/tests/tmtests</TD></TR> 196 <TR><TD ALIGN=center>Multiprocessor Tests</TD> 197 <TD ALIGN=center>$RTEMS_ROOT/c/src/tests/mptests</TD></TR> 198 <TR><TD ALIGN=center>Sample Applications</TD> 199 <TD ALIGN=center>$RTEMS_ROOT/c/src/tests/samples</TD></TR> 200 <TR><TD ALIGN=center>RTEMS Build Tools</TD> 201 <TD ALIGN=center>$RTEMS_SRC_BASE/c/build_tools</TD></TR> 202 <TR><TD ALIGN=center>Make Support</TD> 203 <TD ALIGN=center>$RTEMS_ROOT/c/make</TD></TR> 204 </TABLE> 205 </CENTER> 206 @end html 207 @end ifclear 208 209 210 The top level directory structure for the C implementation of RTEMS 211 is as follows: 212 213 @c 214 @c Tree 2 - Top C Level 178 179 180 181 @c 182 @c c/ Directions 183 @c 184 @subsection c/ Directory 185 186 The @code{$@{RTEMS_ROOT@}/c/} directory was formerly 187 the root directory of all RTEMS source code. At this time, it contains 188 the root directory for only those RTEMS components 189 which must be compiled or linked in a way that is specific to a 190 particular CPU model or board. This directory contains the 191 following subdirectories: 192 193 @table @code 194 @item $@{RTEMS_ROOT@}/c/src/ 195 This directory is logically the root for the RTEMS components 196 which are CPU model or board dependent. Thus this directory 197 is the root for the BSPs and the various Test Suites as well 198 as CPU model and BSP dependent libraries. The contents of 199 this directory are discussed in the 200 @ref{Directory Structure c/src/ Directory} section. 201 202 @item $@{RTEMS_ROOT@}/c/make/ 203 This directory is used to generate the file @code{target.cfg} 204 which is installed as part of the Application Makefiles. This 205 file contains settings for various Makefile variables to 206 tailor them to the particular CPU model and BSP configured. 207 208 @end table 209 210 @c 211 @c c/src/ Directory 212 @c 213 @subsubsection c/src/ Directory 214 215 As mentioned previously, this directory is logically 216 the root for the RTEMS components 217 which are CPU model or board dependent. The 218 following is a list of the subdirectories in this 219 directorie and a description of each. 220 221 @table @code 222 @item $@{RTEMS_ROOT@}/c/src/ada-tests/ 223 This directory contains the test suite for the Ada 224 language bindings to the Classic API. 225 226 @item $@{RTEMS_ROOT@}/c/src/lib/ 227 228 @item $@{RTEMS_ROOT@}/c/src/libchip/ 229 This directory contains device drivers for various 230 peripheral chips which are designed to be CPU and 231 board dependent. This directory contains a variety 232 of drivers for serial devices, network interface 233 controllers, and real-time clocks. 234 235 @item $@{RTEMS_ROOT@}/c/src/libmisc/ 236 This directory contains support facilities which 237 are RTEMS specific but otherwise unclassified. In 238 general, they do not adhere to a standard API. 239 Among the support facilities in this directory are 240 a @code{/dev/null} device driver, the Stack 241 Overflow Checker, a mini-shell, the CPU and 242 rate monotonic period usage monitoring libraries, 243 and a utility to "dump a buffer" in a nicely 244 formatted way similar to many ROM monitors. 245 246 @item $@{RTEMS_ROOT@}/c/src/libnetworking/ 247 This directory contains the networking components which 248 might be tailored based upon the particular BSP. This 249 includes the RTEMS telnetd, httpd, and ftpd servers. 250 251 @item $@{RTEMS_ROOT@}/c/src/librdbg/ 252 This directory contains the Ethernet-based remote debugging 253 stub. This software must be built to be intimately aware 254 of a particular CPU model. 255 256 @item $@{RTEMS_ROOT@}/c/src/librtems++/ 257 258 @item $@{RTEMS_ROOT@}/c/src/make/ 259 260 @item $@{RTEMS_ROOT@}/c/src/optman/ 261 262 @item $@{RTEMS_ROOT@}/c/src/tests/ 263 This directory contains the test suites for the 264 various RTEMS APIs and support libraries. This 265 contents of this directory are discussed in the 266 @ref{Directory Structure Test Suites} section. 267 268 @item $@{RTEMS_ROOT@}/c/src/wrapup/ 269 270 @end table 271 272 @c 273 @c Test Suites 274 @c 275 @lowersections 276 @subsubsection Test Suites 277 278 The following table lists the test suites currently included with the 279 RTEMS and the directory in which they may be located: 280 281 @table @code 282 283 @item @{RTEMS_ROOT@}c/src/tests/itrontests 284 ITRON API Tests 285 286 @item @{RTEMS_ROOT@}c/src/tests/libtests 287 Support Library Tests 288 289 @item @{RTEMS_ROOT@}c/src/tests/mptests 290 Classic API Multiprocessor Tests 291 292 @item @{RTEMS_ROOT@}c/src/tests/psxtests 293 POSIX API Tests 294 295 @item @{RTEMS_ROOT@}c/src/tests/samples 296 Sample Applications 297 298 @item @{RTEMS_ROOT@}c/src/tests/sptests 299 Classic API Single Processor Tests 300 301 @item @{RTEMS_ROOT@}c/src/tests/support 302 Test Support Software 303 304 @item @{RTEMS_ROOT@}c/src/tests/tmitrontests 305 ITRON API Timing Tests 306 307 @item @{RTEMS_ROOT@}c/src/tests/tmtests 308 Classic API Timing Tests 309 310 @item @{RTEMS_ROOT@}c/src/tests/tools 311 XXX 312 313 @end table 314 315 @raisesections 316 317 318 @c 319 @c CPUKit Directory 320 @c 321 @subsection CPUKit Directory 322 323 The @code{cpukit/} directory structure is as follows: 324 325 @c 326 @c CPUKit Tree 215 327 @c 216 328 … … 218 330 @example 219 331 @group 220 C 221 | 222 +----------+-----------+----------+ 223 | | | | 224 build_tools make src update_tools 225 @end group 226 @end example 227 @end ifset 228 229 @ifset use-tex 230 @sp 1 231 232 @tex 233 {\parskip=0pt\offinterlineskip% 234 \hskip 08.0em 235 \hskip 13.00em\hbox to 0.50em{\hss{C}\hss}% 236 \vrule width0em height1.972ex depth0.812ex\par\penalty10000 237 \hskip 08.0em 238 \hskip 13.25em\vrule width.04em% 239 \vrule width0em height1.500ex depth0.500ex\par\penalty10000 240 \hskip 08.0em 241 \hskip 1.75em\vrule width11.50em height-0.407ex depth0.500ex% 242 \vrule width.04em\vrule width11.50em height-0.407ex depth0.500ex% 243 \vrule width0em height1.500ex depth0.500ex\par\penalty10000 244 \hskip 08.0em 245 \hskip 1.75em\vrule width.04em% 246 \hskip 5.71em\vrule width.04em% 247 \hskip 5.71em\vrule width.04em% 248 \hskip 5.71em\vrule width.04em% 249 \hskip 5.71em\vrule width.04em% 250 \vrule width0em height1.500ex depth0.500ex\par\penalty10000 251 \hskip 08.0em 252 \hskip 0.00em\hbox to 3.50em{\hss{Modules}\hss}% 253 \hskip 1.00em\hbox to 6.00em{\hss{build\_tools}\hss}% 254 \hskip 1.75em\hbox to 2.00em{\hss{make}\hss}% 255 \hskip 4.00em\hbox to 1.50em{\hss{src}\hss}% 256 \hskip 1.75em\hbox to 6.50em{\hss{update\_tools}\hss}% 257 \vrule width0em height1.972ex depth0.812ex\par} 258 @end tex 259 @end ifset 260 261 @ifset use-html 262 @example 263 @group 264 C 265 | 266 +----------+-----------+----------+ 267 | | | | 268 build_tools make src update_tools 269 @end group 270 @end example 271 @html 272 @end html 273 @end ifset 274 275 This directory contains the subdirectories which 276 contain the entire C implementation of the RTEMS executive. 277 The "build-tools" directory contains an assortment of support tools 278 for the RTEMS development environment. Two subdirectories exist 279 under "build-tools" which contain scripts (executables) and 280 source for the support tools. The "make" directory contains 281 configuration files and subdirectories which provide a robust 282 host and cross-target makefile system supporting the building of 283 the executive for numerous application environments. The 284 "update_tools" directory contains utilities which aid in the 285 updating from a previous version to the current version of the 286 RTEMS executive. 287 288 The "src" directory structure for the C implementation of RTEMS is as follows: 289 290 @c 291 @c Tree 3 - Top C src Level 292 @c 293 294 @ifset use-ascii 295 @example 296 @group 297 C Source 298 | 299 +-----------------------+-----------------------+ 300 | | | 301 exec lib tests 302 @end group 303 @end example 304 @end ifset 305 306 @ifset use-tex 307 @sp 1 308 309 @tex 310 {\parskip=0pt\offinterlineskip% 311 \hskip 15.0em 312 \hskip 2.00em\hbox to 4.00em{\hss{C Source}\hss}% 313 \vrule width0em height1.972ex depth0.812ex\par\penalty10000 314 \hskip 15.0em 315 \hskip 4.00em\vrule width.04em% 316 \vrule width0em height1.500ex depth0.500ex\par\penalty10000 317 \hskip 15.0em 318 \hskip 1.00em\vrule width3.00em height-0.407ex depth0.500ex% 319 \vrule width.04em\vrule width3.00em height-0.407ex depth0.500ex% 320 \vrule width0em height1.500ex depth0.500ex\par\penalty10000 321 \hskip 15.0em 322 \hskip 1.00em\vrule width.04em% 323 \hskip 2.96em\vrule width.04em% 324 \hskip 2.96em\vrule width.04em% 325 \vrule width0em height1.500ex depth0.500ex\par\penalty10000 326 \hskip 15.0em 327 \hskip 0.00em\hbox to 2.00em{\hss{exec}\hss}% 328 \hskip 1.25em\hbox to 1.50em{\hss{lib}\hss}% 329 \hskip 1.00em\hbox to 2.50em{\hss{tests}\hss}% 330 \vrule width0em height1.972ex depth0.812ex\par} 331 @end tex 332 @end ifset 333 334 @ifset use-html 335 @example 336 @group 337 C Source 338 | 339 +-----------------------+-----------------------+ 340 | | | 341 exec lib tests 342 @end group 343 @end example 344 @html 345 @end html 346 @end ifset 347 348 This directory contains all source files that 349 comprises the RTEMS executive, supported target board support 350 packages, and the RTEMS Test Suite. 351 352 @ifinfo 353 @node Executive Source Directory, Support Library Source Directory, C Suites, Directory Structure Suites 354 @end ifinfo 355 @subsection Executive Source Directory 356 357 The "exec" directory structure for the C implementation is as follows: 358 359 @c 360 @c Tree 4 - C Executive Tree 361 @c 362 363 @ifset use-ascii 364 @example 365 @group 366 C Executive 332 CPUKit 367 333 | 368 334 +-----------+----------+-----------+----------+ … … 373 339 @end ifset 374 340 375 @ifset use-tex376 @sp 1377 378 @tex379 {\parskip=0pt\offinterlineskip%380 \hskip 10.0em381 \hskip 6.00em\hbox to 5.50em{\hss{C Executive}\hss}%382 \vrule width0em height1.972ex depth0.812ex\par\penalty10000383 \hskip 10.0em384 \hskip 8.75em\vrule width.04em%385 \vrule width0em height1.500ex depth0.500ex\par\penalty10000386 \hskip 10.0em387 \hskip 1.25em\vrule width7.50em height-0.407ex depth0.500ex%388 \vrule width.04em\vrule width7.50em height-0.407ex depth0.500ex%389 \vrule width0em height1.500ex depth0.500ex\par\penalty10000390 \hskip 10.0em391 \hskip 1.25em\vrule width.04em%392 \hskip 3.71em\vrule width.04em%393 \hskip 3.71em\vrule width.04em%394 \hskip 3.71em\vrule width.04em%395 \hskip 3.71em\vrule width.04em%396 \vrule width0em height1.500ex depth0.500ex\par\penalty10000397 \hskip 10.0em398 \hskip 0.00em\hbox to 2.50em{\hss{posix}\hss}%399 \hskip 1.25em\hbox to 2.50em{\hss{rtems}\hss}%400 \hskip 1.50em\hbox to 2.00em{\hss{sapi}\hss}%401 \hskip 1.50em\hbox to 2.50em{\hss{score}\hss}%402 \hskip 1.00em\hbox to 3.00em{\hss{wrapup}\hss}%403 \vrule width0em height1.972ex depth0.812ex\par}404 @end tex405 @end ifset406 407 @ifset use-html408 @example409 @group410 C Executive411 |412 +-----------+----------+-----------+----------+413 | | | | |414 posix rtems sapi score wrapup415 @end group416 @end example417 @html418 @end html419 @end ifset420 421 341 This directory contains a set of subdirectories which 422 342 contains the source files comprising the executive portion of 423 the RTEMS development environment. At this point the API 424 specific and "supercore" source code files are separated into 425 distinct directory trees. The "rtems" and the "posix" 426 subdirectories contain the C language source files for each 343 the RTEMS development environment as well as portable support 344 libraries such as support for the C Library and filesystems. 345 The API specific and "SuperCore" (e.g. @code{score/} directory) 346 source code files are separated into 347 distinct directory trees. The @code{rtems/}, @code{posix/}, and 348 @code{itron/} subdirectories contain the C language source files for each 427 349 module comprising the respective API. Also included in this 428 directory are the subdirectories "sapi" and "score"which are429 the supercore modules. Within the "score"directory the CPU350 directory are the subdirectories @code{sapi/} and @code{score/} which are 351 the SuperCore modules. Within the @code{score/} directory the CPU 430 352 dependent modules are found. 431 353 432 The "cpu"directory contains a subdirectory for each354 The @code{score/cpu/} subdirectory contains a subdirectory for each 433 355 target CPU supported by the @value{RELEASE} release of the RTEMS 434 356 executive. Each processor directory contains the CPU dependent … … 439 361 processors. 440 362 441 @ifinfo 442 @node Support Library Source Directory, Test Suite Source Directory, Executive Source Directory, Directory Structure Suites 443 @end ifinfo 363 364 @c 365 @c 366 @c 367 @subsection Documentation Directory 368 369 XXX 370 371 @c 372 @c 373 @c 444 374 @subsection Support Library Source Directory 445 375 … … 550 480 @end ifset 551 481 552 @ ifinfo553 @ node Test Suite Source Directory, Sample Applications, Support Library Source Directory, Directory Structure Suites554 @ end ifinfo482 @c 483 @c 484 @c 555 485 @subsection Test Suite Source Directory 556 486 -
doc/develenv/sample.t
rb22fa3ab raa41429 7 7 @c 8 8 9 @ifinfo10 @node Sample Applications, Sample Applications Introduction, Test Suite Source Directory, Top11 @end ifinfo12 9 @chapter Sample Applications 13 @ifinfo 14 @menu 15 * Sample Applications Introduction:: 16 * Sample Applications Hello World:: 17 * Sample Applications Clock Tick:: 18 * Sample Applications Base Single Processor Application:: 19 * Sample Applications Base Multiple Processor Application:: 20 * Sample Applications Constructor/Destructor C++ Application:: 21 * Sample Applications Paranoia Floating Point Application:: 22 @end menu 23 @end ifinfo 24 25 @ifinfo 26 @node Sample Applications Introduction, Sample Applications Hello World, Sample Applications, Sample Applications 27 @end ifinfo 10 28 11 @section Introduction 29 12 … … 54 37 material presented in the RTEMS Applications User's Guide. 55 38 56 @ifinfo57 @node Sample Applications Hello World, Sample Applications Clock Tick, Sample Applications Introduction, Sample Applications58 @end ifinfo59 39 @section Hello World 60 40 … … 85 65 console output routine is not operating properly. 86 66 87 @ifinfo88 @node Sample Applications Clock Tick, Sample Applications Base Single Processor Application, Sample Applications Hello World, Sample Applications89 @end ifinfo90 67 @section Clock Tick 91 68 … … 135 112 operating properly. 136 113 137 @ifinfo138 @node Sample Applications Base Single Processor Application, Sample Applications Base Multiple Processor Application, Sample Applications Clock Tick, Sample Applications139 @end ifinfo140 114 @section Base Single Processor Application 141 115 … … 165 139 are printed from the single application task. 166 140 167 @ifinfo168 @node Sample Applications Base Multiple Processor Application, Sample Applications Constructor/Destructor C++ Application, Sample Applications Base Single Processor Application, Sample Applications169 @end ifinfo170 141 @section Base Multiple Processor Application 171 142 … … 217 188 must be unique on each node. 218 189 219 @ifinfo220 @node Sample Applications Constructor/Destructor C++ Application, Sample Applications Paranoia Floating Point Application, Sample Applications Base Multiple Processor Application, Sample Applications221 @end ifinfo222 190 @section Constructor/Destructor C++ Application 223 191 … … 266 234 @end example 267 235 268 @ifinfo269 @node Sample Applications Paranoia Floating Point Application, RTEMS Specific Utilities, Sample Applications Constructor/Destructor C++ Application, Sample Applications270 @end ifinfo271 236 @section Paranoia Floating Point Application 272 237 -
doc/develenv/utils.t
rb22fa3ab raa41429 7 7 @c 8 8 9 @ifinfo10 @node RTEMS Specific Utilities, RTEMS Specific Utilities C Language Specific Utilities, Sample Applications Paranoia Floating Point Application, Top11 @end ifinfo12 9 @chapter RTEMS Specific Utilities 13 @ifinfo14 @menu15 * RTEMS Specific Utilities C Language Specific Utilities::16 * RTEMS Specific Utilities Ada Language Specific Utilities::17 @end menu18 @end ifinfo19 10 20 11 This section describes the additional commands … … 102 93 the description of gcc020 in section 1 of the GNU documentation. 103 94 104 @ifinfo105 @node RTEMS Specific Utilities C Language Specific Utilities, packhex - Compress Hexadecimal File, RTEMS Specific Utilities, RTEMS Specific Utilities106 @end ifinfo107 95 @section C Language Specific Utilities 108 @ifinfo109 @menu110 * packhex - Compress Hexadecimal File::111 * unhex - Convert Hexadecimal File into Binary::112 * size_rtems - report RTEMS size information::113 @end menu114 @end ifinfo115 96 116 97 The C language utilities provide a powerful set of … … 121 102 utilities are described in the section below. 122 103 123 @ifinfo124 @node packhex - Compress Hexadecimal File, unhex - Convert Hexadecimal File into Binary, RTEMS Specific Utilities C Language Specific Utilities, RTEMS Specific Utilities C Language Specific Utilities125 @end ifinfo126 104 @subsection packhex - Compress Hexadecimal File 127 105 … … 167 145 provided in the listing. 168 146 169 @ifinfo170 @node unhex - Convert Hexadecimal File into Binary, size_rtems - report RTEMS size information, packhex - Compress Hexadecimal File, RTEMS Specific Utilities C Language Specific Utilities171 @end ifinfo172 147 @subsection unhex - Convert Hexadecimal File into Binary Equivalent 173 148 … … 219 194 @end example 220 195 221 @ifinfo222 @node size_rtems - report RTEMS size information, RTEMS Specific Utilities Ada Language Specific Utilities, unhex - Convert Hexadecimal File into Binary, RTEMS Specific Utilities C Language Specific Utilities223 @end ifinfo224 196 @subsection size_rtems - report RTEMS size information 225 197 … … 294 266 295 267 296 @ifinfo297 @node RTEMS Specific Utilities Ada Language Specific Utilities, Command and Variable Index, size_rtems - report RTEMS size information, RTEMS Specific Utilities298 @end ifinfo299 @section Ada Language Specific Utilities300 301 The Ada language utilities provide a powerful set of302 tools which combine to allow operations within the RTEMS303 Development Environment to be consistent and easy to use. Much304 effort was devoted to providing as close to the standard UNIX305 and GNU style of operations as possible. Each of these306 utilities are described in the section below.307 308 NOTE: The Ada implementation is not included in this309 release.310 311 312
Note: See TracChangeset
for help on using the changeset viewer.