source: rtems/doc/TODO @ e630235

4.11
Last change on this file since e630235 was 0f90482, checked in by Joel Sherrill <joel.sherrill@…>, on May 8, 2000 at 7:44:25 PM

Updated.

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