doc/html/user-guide/documentation-roadmap.html

   1 <!-- Copyright (C) 2003 Red Hat, Inc.                                -->
   2 <!-- This material may be distributed only subject to the terms      -->
   3 <!-- and conditions set forth in the Open Publication License, v1.0  -->
   4 <!-- or later (the latest version is presently available at          -->
   5 <!-- http://www.opencontent.org/openpub/).                           -->
   6 <!-- Distribution of the work or derivative of the work in any       -->
   7 <!-- standard (paper) book form is prohibited unless prior           -->
   8 <!-- permission is obtained from the copyright holder.               -->
   9 <HTML
  10 ><HEAD
  11 ><TITLE
  12 >Documentation Roadmap</TITLE
  13 ><meta name="MSSmartTagsPreventParsing" content="TRUE">
  14 <META
  15 NAME="GENERATOR"
  16 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
  17 "><LINK
  18 REL="HOME"
  19 TITLE="eCos User Guide"
  20 HREF="ecos-user-guide.html"><LINK
  21 REL="UP"
  22 TITLE="Introduction"
  23 HREF="user-guide-introduction.html"><LINK
  24 REL="PREVIOUS"
  25 TITLE="Version Conventions"
  26 HREF="version-conventions.html"><LINK
  27 REL="NEXT"
  28 TITLE="Installing eCos"
  29 HREF="user-guide-installation.html"></HEAD
  30 ><BODY
  31 CLASS="CHAPTER"
  32 BGCOLOR="#FFFFFF"
  33 TEXT="#000000"
  34 LINK="#0000FF"
  35 VLINK="#840084"
  36 ALINK="#0000FF"
  37 ><DIV
  38 CLASS="NAVHEADER"
  39 ><TABLE
  40 SUMMARY="Header navigation table"
  41 WIDTH="100%"
  42 BORDER="0"
  43 CELLPADDING="0"
  44 CELLSPACING="0"
  45 ><TR
  46 ><TH
  47 COLSPAN="3"
  48 ALIGN="center"
  49 >eCos User Guide</TH
  50 ></TR
  51 ><TR
  52 ><TD
  53 WIDTH="10%"
  54 ALIGN="left"
  55 VALIGN="bottom"
  56 ><A
  57 HREF="version-conventions.html"
  58 ACCESSKEY="P"
  59 >Prev</A
  60 ></TD
  61 ><TD
  62 WIDTH="80%"
  63 ALIGN="center"
  64 VALIGN="bottom"
  65 ></TD
  66 ><TD
  67 WIDTH="10%"
  68 ALIGN="right"
  69 VALIGN="bottom"
  70 ><A
  71 HREF="user-guide-installation.html"
  72 ACCESSKEY="N"
  73 >Next</A
  74 ></TD
  75 ></TR
  76 ></TABLE
  77 ><HR
  78 ALIGN="LEFT"
  79 WIDTH="100%"></DIV
  80 ><DIV
  81 CLASS="CHAPTER"
  82 ><H1
  83 ><A
  84 NAME="DOCUMENTATION-ROADMAP">Chapter 5. Documentation Roadmap</H1
  85 ><P
  86 >The <SPAN
  87 CLASS="PRODUCTNAME"
  88 >eCos</SPAN
  89 > documentation is divided into a
  90 three main parts:</P
  91 ><P
  92 ></P
  93 ><DIV
  94 CLASS="VARIABLELIST"
  95 ><DL
  96 ><DT
  97 ><SPAN
  98 CLASS="emphasis"
  99 ><I
 100 CLASS="EMPHASIS"
 101 >User Guide</I
 102 ></SPAN
 103 ></DT
 104 ><DD
 105 ><P
 106 >This document. It includes the following sections:</P
 107 ><P
 108 ></P
 109 ><DIV
 110 CLASS="VARIABLELIST"
 111 ><DL
 112 ><DT
 113 >Installing <SPAN
 114 CLASS="PRODUCTNAME"
 115 >eCos</SPAN
 116 ></DT
 117 ><DD
 118 ><P
 119 >  This section describes how to install the
 120   <SPAN
 121 CLASS="PRODUCTNAME"
 122 >eCos</SPAN
 123 > software, how to set up your
 124   hardware and how to test that it is all working.
 125   </P
 126 ></DD
 127 ><DT
 128 >Programming Under <SPAN
 129 CLASS="PRODUCTNAME"
 130 >eCos</SPAN
 131 ></DT
 132 ><DD
 133 ><P
 134 >  This section describes how to write programs that run under
 135   <SPAN
 136 CLASS="PRODUCTNAME"
 137 >eCos</SPAN
 138 > by running through some examples.
 139   </P
 140 ></DD
 141 ><DT
 142 >The <SPAN
 143 CLASS="PRODUCTNAME"
 144 >eCos</SPAN
 145 > <SPAN
 146 CLASS="APPLICATION"
 147 >Configuration Tool</SPAN
 148 ></DT
 149 ><DD
 150 ><P
 151 >  This section describes the <SPAN
 152 CLASS="PRODUCTNAME"
 153 >eCos</SPAN
 154 > graphical
 155   configuration tool and how to use it to change how
 156   <SPAN
 157 CLASS="PRODUCTNAME"
 158 >eCos</SPAN
 159 > behaves.</P
 160 ></DD
 161 ><DT
 162 ><SPAN
 163 CLASS="PRODUCTNAME"
 164 >eCos</SPAN
 165 > Programming Concepts and Techniques</DT
 166 ><DD
 167 ><P
 168 >An explanation of the <SPAN
 169 CLASS="PRODUCTNAME"
 170 >eCos</SPAN
 171 > programming
 172             cycle, and a description of some debugging facilities that
 173             <SPAN
 174 CLASS="PRODUCTNAME"
 175 >eCos</SPAN
 176 > offers.
 177   </P
 178 ></DD
 179 ><DT
 180 >Configuration and the Package
 181               Repository</DT
 182 ><DD
 183 ><P
 184 >Information on how to configure <SPAN
 185 CLASS="PRODUCTNAME"
 186 >eCos</SPAN
 187 >
 188               manually, including a reference on the
 189               <B
 190 CLASS="COMMAND"
 191 >ecosconfig</B
 192 > command, memory layouts,
 193               and information on how to manage a package repository
 194               using the <SPAN
 195 CLASS="PRODUCTNAME"
 196 >eCos</SPAN
 197 > Package Administration
 198               Tool.
 199             </P
 200 ></DD
 201 ></DL
 202 ></DIV
 203 ></DD
 204 ><DT
 205 ><SPAN
 206 CLASS="emphasis"
 207 ><I
 208 CLASS="EMPHASIS"
 209 >Reference Guide</I
 210 ></SPAN
 211 ></DT
 212 ><DD
 213 ><P
 214 >The Reference Guide provides detailed documentation on various
 215 aspects of <SPAN
 216 CLASS="PRODUCTNAME"
 217 >eCos</SPAN
 218 >. This document is being
 219 constantly updated, so the following list just mentions the more
 220 important sections, take a look at the guide itself for the full
 221 story.</P
 222 ><P
 223 ></P
 224 ><DIV
 225 CLASS="VARIABLELIST"
 226 ><DL
 227 ><DT
 228 >The <SPAN
 229 CLASS="PRODUCTNAME"
 230 >eCos</SPAN
 231 > Kernel</DT
 232 ><DD
 233 ><P
 234 >In-depth description of <SPAN
 235 CLASS="PRODUCTNAME"
 236 >eCos</SPAN
 237 >&quot;s
 238               native C kernel API Important considerations are given
 239               for programming the <SPAN
 240 CLASS="PRODUCTNAME"
 241 >eCos</SPAN
 242 >
 243               kernel. The semantics for each kernel function are
 244               described, including how they are affected by
 245               configuration. </P
 246 ></DD
 247 ><DT
 248 >POSIX and &micro;ITRON APIs</DT
 249 ><DD
 250 ><P
 251 >A description of the POSIX and &micro;ITRON APIs and how they
 252   are supported under <SPAN
 253 CLASS="PRODUCTNAME"
 254 >eCos</SPAN
 255 >.
 256   </P
 257 ></DD
 258 ><DT
 259 >The <SPAN
 260 CLASS="PRODUCTNAME"
 261 >eCos</SPAN
 262 > Hardware Abstraction Layer (HAL)</DT
 263 ><DD
 264 ><P
 265 >A description of the structure and functionality of the
 266   <SPAN
 267 CLASS="PRODUCTNAME"
 268 >eCos</SPAN
 269 > HAL. This section also includes a
 270   porting guide to help moving <SPAN
 271 CLASS="PRODUCTNAME"
 272 >eCos</SPAN
 273 > to
 274   different platforms.
 275   </P
 276 ></DD
 277 ><DT
 278 >Device Drivers</DT
 279 ><DD
 280 ><P
 281 >A description of the philosophy behind
 282               <SPAN
 283 CLASS="PRODUCTNAME"
 284 >eCos</SPAN
 285 > device drivers, as well as a
 286               presentation of the C language APIs for using the current
 287               device drivers. </P
 288 ><P
 289 >    Device driver support includes serial, ethernet and FLASH devices,
 290     and support for PCI, PCMCIA and USB interconnects.
 291   </P
 292 ></DD
 293 ><DT
 294 >RedBoot User's Guide</DT
 295 ><DD
 296 ><P
 297 >This describes RedBoot, which provides a complete bootstrap
 298         environment for a range of embedded operating systems, such as
 299         embedded Linux and <SPAN
 300 CLASS="PRODUCTNAME"
 301 >eCos</SPAN
 302 >, and
 303         includes facilities such as network downloading and
 304         debugging. It also provides a simple flash file system for
 305         boot images.
 306   </P
 307 ></DD
 308 ><DT
 309 >TCP/IP Stack Support</DT
 310 ><DD
 311 ><P
 312 >This describes the Common Networking for
 313         <SPAN
 314 CLASS="PRODUCTNAME"
 315 >eCos</SPAN
 316 > package, which provides
 317         support for a complete TCP/IP networking stack. The design
 318         allows for the actual stack to be modular and at the current
 319         time two different implementations, one based on OpenBSD from
 320         2000 and a new version based on FreeBSD, are available.
 321   </P
 322 ><P
 323 >Other components related to networking, including support for
 324         SNMP, DNS, HTTP and FTP, are also described.
 325   </P
 326 ></DD
 327 ></DL
 328 ></DIV
 329 ></DD
 330 ><DT
 331 ><SPAN
 332 CLASS="emphasis"
 333 ><I
 334 CLASS="EMPHASIS"
 335 >Component Writer's Guide</I
 336 ></SPAN
 337 ></DT
 338 ><DD
 339 ><P
 340 >The Component Writer's Guide is intended for developers who need
 341 to add or modify parts of <SPAN
 342 CLASS="PRODUCTNAME"
 343 >eCos</SPAN
 344 > itself. It
 345 describes the following things:</P
 346 ><P
 347 ></P
 348 ><DIV
 349 CLASS="VARIABLELIST"
 350 ><DL
 351 ><DT
 352 >Overview</DT
 353 ><DD
 354 ><P
 355 >An explanation of the configuration technology used in
 356   <SPAN
 357 CLASS="PRODUCTNAME"
 358 >eCos</SPAN
 359 >, why it is done this way, how it
 360   works and the terminology used.
 361   </P
 362 ></DD
 363 ><DT
 364 >Package Organization</DT
 365 ><DD
 366 ><P
 367 >A description of the <SPAN
 368 CLASS="PRODUCTNAME"
 369 >eCos</SPAN
 370 > package
 371   repository, how it is organized and how packages themselves are
 372   organized.
 373   </P
 374 ></DD
 375 ><DT
 376 >The CDL Language</DT
 377 ><DD
 378 ><P
 379 >A description of the CDL language and how it is used to
 380   control the configuration of <SPAN
 381 CLASS="PRODUCTNAME"
 382 >eCos</SPAN
 383 >
 384   components. The document also contains a complete specification of
 385   the language.
 386   </P
 387 ></DD
 388 ><DT
 389 >The Build Process</DT
 390 ><DD
 391 ><P
 392 >A description of what happens once a configuration has been
 393   created and must be built into a set of executables.
 394   </P
 395 ></DD
 396 ></DL
 397 ></DIV
 398 ></DD
 399 ></DL
 400 ></DIV
 401 ></DIV
 402 ><DIV
 403 CLASS="NAVFOOTER"
 404 ><HR
 405 ALIGN="LEFT"
 406 WIDTH="100%"><TABLE
 407 SUMMARY="Footer navigation table"
 408 WIDTH="100%"
 409 BORDER="0"
 410 CELLPADDING="0"
 411 CELLSPACING="0"
 412 ><TR
 413 ><TD
 414 WIDTH="33%"
 415 ALIGN="left"
 416 VALIGN="top"
 417 ><A
 418 HREF="version-conventions.html"
 419 ACCESSKEY="P"
 420 >Prev</A
 421 ></TD
 422 ><TD
 423 WIDTH="34%"
 424 ALIGN="center"
 425 VALIGN="top"
 426 ><A
 427 HREF="ecos-user-guide.html"
 428 ACCESSKEY="H"
 429 >Home</A
 430 ></TD
 431 ><TD
 432 WIDTH="33%"
 433 ALIGN="right"
 434 VALIGN="top"
 435 ><A
 436 HREF="user-guide-installation.html"
 437 ACCESSKEY="N"
 438 >Next</A
 439 ></TD
 440 ></TR
 441 ><TR
 442 ><TD
 443 WIDTH="33%"
 444 ALIGN="left"
 445 VALIGN="top"
 446 >Version Conventions</TD
 447 ><TD
 448 WIDTH="34%"
 449 ALIGN="center"
 450 VALIGN="top"
 451 ><A
 452 HREF="user-guide-introduction.html"
 453 ACCESSKEY="U"
 454 >Up</A
 455 ></TD
 456 ><TD
 457 WIDTH="33%"
 458 ALIGN="right"
 459 VALIGN="top"
 460 >Installing <SPAN
 461 CLASS="PRODUCTNAME"
 462 >eCos</SPAN
 463 ></TD
 464 ></TR
 465 ></TABLE
 466 ></DIV
 467 ></BODY
 468 ></HTML
 469 >