FS#10491 - Add keyclicks to manual

Attached to Project: Rockbox
Opened by Johannes Linke (Jaykay) - Wednesday, 05 August 2009, 18:38 GMT
Last edited by Dominik Riebeling (bluebrother) - Sunday, 05 June 2011, 10:28 GMT
Task Type Patches
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


his is only the first shot of adding the setting keyclicks to the manual. my english is not the best, so the description might need improvements.

things i would like to ask: is it necessary to metnion "this menu relates to keyclicks"? the manual says this for other submenus, but in nearly all cases it's obsolete, of course keyclicks relates to keyclicks...

and is it necessary to say some general things about this setting (this setting controls...) and then explain every option (if set to off....)? leaving the first part out would shorten some descriptions without making them harder to understand.

there some code style corrections in it, i tried to unify this file a bit. the real changes are at the end of the file. you dont need to and i know you wont include the corrections in the commit :)
This task depends upon

Closed by  Dominik Riebeling (bluebrother)
Sunday, 05 June 2011, 10:28 GMT
Reason for closing:  Accepted
Additional comments about closing:  committed with minor modifications.
Comment by Alex Parker (BigBambi) - Monday, 10 August 2009, 09:03 GMT
If you know that we don't like unrelated things in one patch, then why include them? It only makes me not want to look through this as it takes ages to work out what are real changes and what aren't. Please attach a new patch with only the actual changes in it.
Comment by Johannes Linke (Jaykay) - Monday, 10 August 2009, 09:27 GMT
if i attach a separate patch with style corrections, you say i should do that when i'm working on this file. if i'm including style corrections in a patch when i'm working on a file you say i should make a separate patch. wtf?

i'm really sorry that i don't know when wich changes in which patch are appreciated.
Comment by Alex Parker (BigBambi) - Tuesday, 11 August 2009, 08:46 GMT
I know in the past I haven't committed style only changes as it didn't seem worthwhile (for those changes), but I appear to have confused you slightly. I have no objection to two patches here, one style and one "real" - it is just when a patch is full of both, I find it difficult to tell which are which :) Sorry for the confusion, and thanks for working on this.