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