| 1 |
1026 |
ivang |
#
|
| 2 |
|
|
# TODO,v 1.7 2002/01/17 21:47:44 joel Exp
|
| 3 |
|
|
#
|
| 4 |
|
|
|
| 5 |
|
|
This is a collection of things which need to be done to the various
|
| 6 |
|
|
manuals.
|
| 7 |
|
|
|
| 8 |
|
|
General Issues
|
| 9 |
|
|
==============
|
| 10 |
|
|
May need a Documentation Roadmap - for now, the "Where to
|
| 11 |
|
|
go from here" chapter in Getting Started is it.
|
| 12 |
|
|
|
| 13 |
|
|
Need a description of hello world and writing an application.
|
| 14 |
|
|
|
| 15 |
|
|
More automatic handling of version, date, revision, release, etc.
|
| 16 |
|
|
|
| 17 |
|
|
Eliminate use of gifs. [NOTE: ps, pdf, and dvi.gif are from
|
| 18 |
|
|
http://www.cit.gu.edu.au/images and the various arrow and
|
| 19 |
|
|
bookshelf icons came with texi2www.]
|
| 20 |
|
|
|
| 21 |
|
|
Redraw pictures as appropriate in open source tools.
|
| 22 |
|
|
|
| 23 |
|
|
|
| 24 |
|
|
Getting Started (C and Ada versions)
|
| 25 |
|
|
====================================
|
| 26 |
|
|
Switch back to using @url{} when pdf generation error is fixed.
|
| 27 |
|
|
|
| 28 |
|
|
Classic Users Guide
|
| 29 |
|
|
===================
|
| 30 |
|
|
May need to enhance descriptions in Primitive Data Types Chapter
|
| 31 |
|
|
|
| 32 |
|
|
POSIX User Notes
|
| 33 |
|
|
================
|
| 34 |
|
|
|
| 35 |
|
|
Add pages for network services.
|
| 36 |
|
|
|
| 37 |
|
|
Add timer() services if we have any.
|
| 38 |
|
|
|
| 39 |
|
|
|
| 40 |
|
|
Development Environment Guide
|
| 41 |
|
|
=============================
|
| 42 |
|
|
Either rename to "A Tour of the RTEMS Source Tree" or include
|
| 43 |
|
|
more information on the GNU tools.
|
| 44 |
|
|
|
| 45 |
|
|
The "C Suites" section is oddly named and the directory
|
| 46 |
|
|
tree included is wrong in that make is no longer under
|
| 47 |
|
|
the c directory. I think the build-tools make have
|
| 48 |
|
|
moved as well.
|
| 49 |
|
|
|
| 50 |
|
|
All the paths should be provided as relative paths
|
| 51 |
|
|
from the top of the RTEMS source tree. It wastes
|
| 52 |
|
|
valuable screen space to do otherwise.
|
| 53 |
|
|
|
| 54 |
|
|
The last paragraph of "C Suites" is vague and could
|
| 55 |
|
|
be written better. It should include the subdirectory
|
| 56 |
|
|
names as part of the textual description.
|
| 57 |
|
|
|
| 58 |
|
|
Should this documentation even use the phrase "C Implementation"
|
| 59 |
|
|
any longer?
|
| 60 |
|
|
|
| 61 |
|
|
Directory names should be in @code -- not "quoted".
|
| 62 |
|
|
|
| 63 |
|
|
In "Support Library Source Directory", look for "which installed"
|
| 64 |
|
|
|
| 65 |
|
|
In the latter part of the "libbsp" paragraph in "Support
|
| 66 |
|
|
Library Source Directory", there is reference to the
|
| 67 |
|
|
stubdr directory which is no longer there.
|
| 68 |
|
|
|
| 69 |
|
|
Update this section to include discussion of the shared
|
| 70 |
|
|
subdirectory and its relationship to the BSPs. Write this
|
| 71 |
|
|
in such a way that it can be passed on to Geoffroy Montel.
|
| 72 |
|
|
|
| 73 |
|
|
In the section, "Test Suite Source Directory", there is a
|
| 74 |
|
|
numeric count of the number of tests in each suite. This
|
| 75 |
|
|
should be eliminated for maintenance purposes.
|
| 76 |
|
|
|
| 77 |
|
|
The psxtest directory is not mentioned. Check that no others
|
| 78 |
|
|
have been forgotten.
|
| 79 |
|
|
|
| 80 |
|
|
There should probably be no reference to the Ada sample
|
| 81 |
|
|
applications. This document used to cover both implementations.
|
| 82 |
|
|
This now seems inappropriate.
|
| 83 |
|
|
|
| 84 |
|
|
The hello world sample test discussion mentions that it provides
|
| 85 |
|
|
a rudiementary test of the BSP startup code and the "RTEMS
|
| 86 |
|
|
C Library". This should be rewritten to tell mroe about what
|
| 87 |
|
|
this test shows (actually a lot). It should mention that this
|
| 88 |
|
|
test tries to avoid using interrupts.
|
| 89 |
|
|
|
| 90 |
|
|
The ticker test should mention that in contrast to hello, it
|
| 91 |
|
|
does use interrupts. :) It can be used to tune the clock
|
| 92 |
|
|
tick.
|
| 93 |
|
|
|
| 94 |
|
|
The ticker test documentation says it calls "tm_get" -- jeez
|
| 95 |
|
|
how old is this manual.
|
