Rockbox General > Rockbox General Discussion

fixed.cfg and documentation

(1/1)

seani:
After asking for this:

http://www.rockbox.org/tracker/task/7290#close

It was kindly pointed out to me that fixed.cfg scratches that particular itch. This isn't documented in the Toshiba PDF or found if searching on the Wiki.

How do you request that something is added to the docs? Happy to add to the Wiki myself (shallow understanding, but at least it will become searchabe), but how does the PDF get generated?

Llorean:
It's written in laTex, and the source files for the manual are in the main SVN sources. You can simply check out a copy and submit a patch to the patch tracker like you would submit a patch for the actual program.

If you can't manage latex, write up a text document explaining its use, what section you'd put it in, etc, for the manual, and post that to the patch tracker (this is likely to take longer to get included because someone else will have to go in and adapt it for the actual manual).

But either way, the manual gets generated from source in the Manual folder in the SVN sources, and to submit changes to it simply use the same patch tracker. :)

bluebrother:

--- Quote from: Llorean on June 11, 2007, 01:45:59 PM ---If you can't manage latex, write up a text document explaining its use, what section you'd put it in, etc, for the manual, and post that to the patch tracker
--- End quote ---
... and make sure to use some plain text format, no word processor like word or openoffice for that. If you're going to submit a patch against the LaTeX sources check the wiki for requirements for your latex setup. And feel free to look around on irc if you have questions about it.

--- Quote ---But either way, the manual gets generated from source in the Manual folder in the SVN sources, and to submit changes to it simply use the same patch tracker. :)
--- End quote ---
The tracker has the category "manual" which (unsurprisingly ;)) is intended for that.

Navigation

[0] Message Index