[Sdcc-user] Documentation typographical errors + suggestion

[Didier G. <di...@da...>]

TWIMC,

I found the following errors in the html manual:

2.3 Testing out the SDCC Compiler

The first thing you should do after installing your SDCC compiler is to see
if it runs.

Type "sdcc --version" at the prompt, and the program should run and tell you
the version. If it
           ^
4.7 Cyclomatic Complexity

Having said that the industry standard is 10, you should be aware that in
some cases it be may unavoidable to have a complexity level of greater than
10. For example if you have switch statement
                                          ^^^^^^^
A few additional points:

1. I recommend you add a link to some assembler documentation.  Here's one
for ASX8051:

http://venus.ece.ndsu.nodak.edu/~jezerr/design/resources/asxhtm.html

2. You may want to consider publishing an email address for users to send in
errors they notice in the documentation.  This is the reason why I am
sending to the list, as I couldn't find a dedicated email for this sort of
thing.

3. Also, I strongly suggest that you place the user manual under some form
of configuration control, so that users can easily determine when their
version is out of date.  This could be as simple as assigning a now version
number with each update.

Keep up the good work - hope this helps.

djg