source: rtems/doc/TODO @ bb546a22

4.104.114.84.9
Last change on this file since bb546a22 was bb546a22, checked in by Joel Sherrill <joel.sherrill@…>, on Apr 27, 2000 at 2:44:43 PM

Updated.

  • Property mode set to 100644
File size: 2.6 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==============
10More automatic handling of version, date, revision, release, etc.
11
12Eliminate use of gifs.
13
14Redraw pictures as appropriate in open source tools
15
16
17Getting Started (C and Ada versions)
18====================================
19Produce PDF
20
21POSIX User Notes
22================
23
24Add pages for network services.
25
26Add timer() services if we have any.
27
28
29Development Environment Guide
30=============================
31Either rename to "A Tour of the RTEMS Source Tree" or include
32more information on the GNU tools. 
33
34The "C Suites" section is oddly named and the directory
35tree included is wrong in that make is no longer under
36the c directory.  I think the build-tools make have
37moved as well.
38
39All the paths should be provided as relative paths
40from the top of the RTEMS source tree.  It wastes
41valuable screen space to do otherwise.
42
43The last paragraph of "C Suites" is vague and could
44be written better.  It should include the subdirectory
45names as part of the textual description.
46
47
48Should this documentation even use the phrase "C Implementation"
49any longer?
50
51Directory names should be in @code -- not "quoted".
52
53In "Support Library Source Directory", look for "which installed"
54
55In the latter part of the "libbsp" paragraph in "Support
56Library Source Directory", there is reference to the
57stubdr directory which is no longer there.
58
59Update this section to include discussion of the shared
60subdirectory and its relationship to the BSPs.  Write this
61in such a way that it can be passed on to Geoffroy Montel.
62
63Include a better discussion of the subdirectories
64under each BSP.  This can be a starting point for
65Geoffroy Montel.  The sample tests also deserve mention
66in a BSP development guide.
67
68In the section, "Test Suite Source Directory", there is a
69numeric count of the number of tests in each suite.  This
70should be eliminated for maintenance purposes.
71
72The psxtest directory is not mentioned.  Check that no others
73have been forgotten.
74
75There should probably be no reference to the Ada sample
76applications.  This document used to cover both implementations.
77This now seems inappropriate.
78
79The hello world sample test discussion mentions that it provides
80a rudiementary test of the BSP startup code and the "RTEMS
81C Library".  This should be rewritten to tell mroe about what
82this test shows (actually a lot).  It should mention that this
83test tries to avoid using interrupts.
84
85The ticker test should mention that in contrast to hello, it
86does use interrupts. :)  It can be used to tune the clock
87tick.
88
89The ticker test documentation says it calls "tm_get" -- jeez
90how old is this manual.
Note: See TracBrowser for help on using the repository browser.