Rockbox

Tasklist

FS#10277 - entry on debug menu missing from manual

Attached to Project: Rockbox
Opened by alex wallis (alexwallis646) - Thursday, 04 June 2009, 23:41 GMT
Last edited by Alex Parker (BigBambi) - Tuesday, 09 June 2009, 20:49 GMT
Task Type Bugs
Category Manual
Status Closed
Assigned To No-one
Operating System All players
Severity Low
Priority Normal
Reported Version Version 3.2
Due in Version Undecided
Due Date Undecided
Percent Complete 100%
Votes 0
Private No

Details

When I was looking for information in the manual regarding the h140 remote, I noticed there does not appear to be an entry on the debug menu. I know this menu says keep out by the side of it, and it is only supposed to be accessed by developers, however the manual does not even contain this basic information telling people to keep out of it and that it is used for development.. I think that should be put in, as well as possibly basic information about what some of the options are for in it in case people decide to go poking around out of curiosity and brick there players by accident.
This task depends upon

Closed by  Alex Parker (BigBambi)
Tuesday, 09 June 2009, 20:49 GMT
Reason for closing:  Invalid
Additional comments about closing:  This is already in the manual. Section 5.12 for the H120/H140 for example...
Comment by Paul Louden (Llorean) - Thursday, 04 June 2009, 23:49 GMT
Why does the manual need to repeat the "keep out" that's readily visible the first time someone sees the menu?

People should not be poking around in it. It's not for users, and the manual contains information for users. You'll notice the manual also doesn't contain instructions for setting up the cross compilers, etc.

And, if they bricked their players somehow nothing in the manual could possibly help them afterward.
Comment by alex wallis (alexwallis646) - Friday, 05 June 2009, 00:00 GMT
Well I simply noticed it was missing from the manual, so I just thought I would point it out. Just a thought, if the debug menu is not meant for the average normal user, why not make it so that if building from source you have to specifically select an option to build it, and remove it all together from the daily and bleeding edge builds? as I doubt a user who needs the menu will be running a daily build anyway. My thinking is simply people like to do things especially if there is a nice big warning saying don't.
Comment by Paul Louden (Llorean) - Friday, 05 June 2009, 00:03 GMT
People using the bleeding edge builds may be asked to enter the debug menu to give us information. This would be a little difficult if the build didn't have it enabled by default. Nobody should ever be using the daily build except under specific circumstances, but the daily build isn't treated any different than a bleeding edge in terms of compiling (it's supposed to be exactly identical to the last bleeding edge before the date changes).

If a person isn't mature enough to be able to resist their impulse to enter it and fiddle with things, I really don't have any sympathy if they manage to cause something bad to happen. But really, it should be almost completely safe anyway.

Ideally the debug menu should be disabled in the release versions, though.
Comment by Alexander Levin (fml2) - Friday, 05 June 2009, 08:13 GMT
I'd say if the menu entry is on the player then it should also be mentioned in the manual -- just so that the user doesn't feel that something has been overseen/forgotten. With a couple of words explaining what it is for ("in case of an error you may be asked to look inside..." etc.).
Comment by Linus Nielsen Feltzing (linusnielsen) - Monday, 08 June 2009, 08:59 GMT
I agree with Alex and Alexander. A tiny explanation in the manual is in order.

Loading...