source: rtems/doc/TODO @ 027f1af

4.104.114.84.9
Last change on this file since 027f1af was 027f1af, checked in by Joel Sherrill <joel.sherrill@…>, on May 15, 1998 at 12:35:11 PM

New file.

  • Property mode set to 100644
File size: 4.4 KB
Line 
1#
2#  $Id$
3#
4
5This is a collection of things which need to be done to the various
6manuals.
7
8KA9Q
9====
10
11Outstanding questions with Eric Norum:
12
13+ "Understand the KA9Q scheduling conventions" makes reference
14  to driver tasks.  Do you think a sentence or two explaining
15  the driver tasks before going into this would be be helpful?
16
17+ In "Write your driver transmit function", there is the comment
18  "as far as I can tell".  Can we make this a stronger statement.
19
20+ In the section "Write your driver receive task", there is a
21  comment indicating that a copy can be avoided if space
22  for a pointer is left at the beginning of the mbuf's.  Do
23  we avoid this?  Do we depend on the driver doing something
24  special?  How to make this happen all the time?
25
26+ What do I need to do so all the BSPs can set the HeapSize like
27  the gen68360?
28
29+ In "Starting and intitializing the network tasks",
30  step 2 says "keep in mind...".  What impact does this have?
31
32+ In Step 5 (bootp), how long is each of the 10
33  tries?  Is there a built in timeout?
34
35+ Syslogd questions: How often is the log written? 
36
37+ Do we need to document the interface to the syslogd?
38
39+ How many incompatibilities are left between RTEMS/KA9Q sockets
40  and BSD sockets?  How hard are these be to fix? 
41
42+ What other levels could there be besides SOL_SOCKET and
43  what do they mean?
44
45+ Is there a standard naming convention for the DNS
46  name lookup routines?
47
48+ Does testdriver.c have all of the code outlined
49  in the Driver Basic Operation section?  Is it easy
50  to go through each of the steps with this test?
51  What is the discard port?
52
53+ How can I package your network tests?
54
55+ Simple server operation... after I telnet to the
56  specified ports, what should I see if it works?
57
58+ Could we include some sample output/benchmark
59  results in the Throughput section.  Ideally
60  there would be a little information on each
61  the system where these results were gathered.
62  And possibily we could get results on multiple
63  systems.
64
65+ Is there a README somewhere which could be included
66  to augment the instructions for executing the ttcp test.
67
68POSIX User Notes
69================
70
71Add pages for network services.
72
73Add timer() services if we have any.
74
75
76Development Environment Guide
77=============================
78Either rename to "A Tour of the RTEMS Source Tree" or include
79more information on the GNU tools. 
80
81The "C Suites" section is oddly named and the directory
82tree included is wrong in that make is no longer under
83the c directory.  I think the build-tools make have
84moved as well.
85
86All the paths should be provided as relative paths
87from the top of the RTEMS source tree.  It wastes
88valuable screen space to do otherwise.
89
90The last paragraph of "C Suites" is vague and could
91be written better.  It should include the subdirectory
92names as part of the textual description.
93
94
95Should this documentation even use the phrase "C Implementation"
96any longer?
97
98Directory names should be in @code -- not "quoted".
99
100In "Support Library Source Directory", look for "which installed"
101
102In the latter part of the "libbsp" paragraph in "Support
103Library Source Directory", there is reference to the
104stubdr directory which is no longer there.
105
106Update this section to include discussion of the shared
107subdirectory and its relationship to the BSPs.  Write this
108in such a way that it can be passed on to Geoffroy Montel.
109
110Include a better discussion of the subdirectories
111under each BSP.  This can be a starting point for
112Geoffroy Montel.  The sample tests also deserve mention
113in a BSP development guide.
114
115In the section, "Test Suite Source Directory", there is a
116numeric count of the number of tests in each suite.  This
117should be eliminated for maintenance purposes.
118
119The psxtest directory is not mentioned.  Check that no others
120have been forgotten.
121
122There should probably be no reference to the Ada sample
123applications.  This document used to cover both implementations.
124This now seems inappropriate.
125
126The hello world sample test discussion mentions that it provides
127a rudiementary test of the BSP startup code and the "RTEMS
128C Library".  This should be rewritten to tell mroe about what
129this test shows (actually a lot).  It should mention that this
130test tries to avoid using interrupts.
131
132The ticker test should mention that in contrast to hello, it
133does use interrupts. :)  It can be used to tune the clock
134tick.
135
136The ticker test documentation says it calls "tm_get" -- jeez
137how old is this manual.
Note: See TracBrowser for help on using the repository browser.