Re: [f-cpu] Yet Another Upload

[Michael Riepe <michael@stud.uni-hannover.de>]

On Mon, Apr 21, 2003 at 12:57:18PM +0200, Cedric wrote:
[...]
> I don't have time to work on the manual now, but at the end of may it will be 
> ok. I have noted a big list of instructions that must be added and updated, 
> but before that work I will be interested to change some of the latex macro 
> so that the manual will be easily parse it (Yann suggest to me, month ago, to 
> create a script that will synchronised assembler and manual).

Don't worry about the new instructions.  I'm going to review the ISA pages
and send you an update.

> 	I was thinking before that it could be a good idea to generate the manual 
> from the VHDL source code, but in fact it will obfuscate the VHDL code with 
> information that are not needed.

The problem with automatic generation is that it still requires editing.
E.g. in Java, you can provide inline documentation, but if you don't edit
the comments when you change a function, the documentation will still be
wrong (and therefore useless).  When the documentation is in a separate
file, you will at least be able to check if it is out of date (by looking
at the timestamps).

[...]
> So the latest versions I have modified is the one available from seul.org.

Ok, I'll look at it.

-- 
 Michael "Tired" Riepe <Michael.Riepe@stud.uni-hannover.de>
 "All I wanna do is have a little fun before I die"
*************************************************************
To unsubscribe, send an e-mail to majordomo@seul.org with
unsubscribe f-cpu       in the body. http://f-cpu.seul.org/