On Wed, 2009-05-27 at 16:53 -0700, David Brownell wrote: > Here are more doc updates > > - get rid of most PDF generation errors, like the > "line too long" ones, as well as the "can't do > sane linebreak" warnings > > - restructure flash driver descriptions so each > driver's info is in one place, not scattered > through up to three locations > > - restructure flash command presentation > > This was done with reference to the code, so many > errors and omissions were also fixed. > > Basically after these three patches, NOR and NAND > flash docs use parallel structure, and the command > index is much more filled out. The NOR docs are > now a *LOT* more complete and accurate.
Committed, r1936-1938. Very nice work. Keep 'em coming. :) > However, there are still six flash drivers that > are not documented. And the str9xpec driver docs > are still a mess (albeit now a *localized* mess); More generally, I am wondering how many users are using this driver. There do not appear to be any examples of the usage of it in the tcl/ tree, though the mailing list might have something archived. It looks like Spencer Oliver committed that code originally in 2007, so I've cc'd him to ensure we get his feedback. > and the "mflash" stuff still looks kind of like > it doesn't really belong in that chapter. I have cc'd unsik Kim to see what he thinks might be done, since he is the principle author of that code and recently updated those sections. David, could I talk you into taking a stab at the newly added Texinfo sections of The Manual? [1,2] I think a guide for preferred markup and style would help clean up the documentation as much the C style guide should help clean up the code. You seem to understand Texinfo, and I figure your recent efforts should mean the information is still fresh in your brain. If the Doxygen markup poses an obstacle, I recommend reading the Doxygen Primer and Style Guide (and providing feedback). ;) At the very least, it would be nice to have fairly direct links to on-line documentation and tutorials (as I will do with the links I posted for learning LaTeX). With driver information and style guidance, others can take a look at the str9xpec part of the manual and audit the driver commands and code. Cheers, Zach [1] doc/manual/primer/docs.txt -- contains a skeletal Texinfo Primer [2] doc/manual/style.txt -- contains a skeletal Texinfo Style Guide _______________________________________________ Openocd-development mailing list [email protected] https://lists.berlios.de/mailman/listinfo/openocd-development
