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