FS#8819 - Broken Manuals are Poorly Handled

Attached to Project: Rockbox
Opened by Marc Guay (Marc_Guay) - Friday, 28 March 2008, 18:49 GMT
Last edited by Dominik Riebeling (bluebrother) - Sunday, 23 September 2012, 19:41 GMT
Task Type Bugs
Category Manual
Status Closed
Assigned To No-one
Operating System All players
Severity Low
Priority Normal
Reported Version Daily build (which?)
Due in Version Undecided
Due Date Undecided
Percent Complete 100%
Votes 0
Private No


Currently if the manuals are broken, the HTML versions simply stop building at the break point and present half-finished manuals on the site, whereas the PDF versions simply don't update. It would be wise to implement a better way of dealing with this, and possibly implementing a notification system as suggested by Nils below. Given the emphasis placed on the having new users read the manual, it's somewaht important from an integrity standpoint that it's available in it's entirety at all times.
This task depends upon

Closed by  Dominik Riebeling (bluebrother)
Sunday, 23 September 2012, 19:41 GMT
Reason for closing:  Out of Date
Additional comments about closing:  We now have the manual in the build system (only one is built though) so this shouldn't be a problem anymore.
Comment by Dominik Riebeling (bluebrother) - Friday, 28 March 2008, 19:17 GMT
I just checked it: this only applies to the html manual, the pdf is fine. Will investigate ...
Comment by Nils Wallménius (nls) - Friday, 28 March 2008, 22:24 GMT
The pdfs are not fine, they were just not deleted, the ones for the various ipods supporting recording are dated March 23.
It seems to be further missing Action commands, \ActionSettingsInc and \ActionSettingsDec.
However there are already \ActionSettingInc and \ActionSettingDec which seems to be a typo, this should probably be cleaned up (as everything in the code is called *Settings*.
Also the build system should probably handle broken manuals better (keep the old ones if new ones didn't build and maybe tell someone about it :)
Comment by Dominik Riebeling (bluebrother) - Friday, 28 March 2008, 23:48 GMT
D'oh -- I forgot to commit a file when fixing it yesterday, so they built fine for me. But as there is a naming issue and pixelma is currently working on it I won't commit right now.
Comment by Jonas Häggqvist (rasher) - Thursday, 11 December 2008, 17:51 GMT
Has this been fixed?