Rename internal h10_5gb.ums name and add some comments.

- When trying to retrieve the human readable device name on target mismatch
  detection it is not possible to figure the "extra" variant internally used
  from the information in rockbox-info.txt. Since the h10_5gb didn't have a
  non-extra version resolving the name would fail. Remove the extra part for
  the UMS version so that will get used. It's better to display a slightly
  wrong name instead of none.
- Add some comments describing the sections and their values.

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@30887 a1c6a512-1295-4272-9138-f99709370657

1 files changed, 33 insertions, 2 deletions

diff --git a/rbutil/rbutilqt/rbutil.ini b/rbutil/rbutilqt/rbutil.ini
index d7eed64434..bdc9bd13d9 100644
--- a/rbutil/rbutilqt/rbutil.ini
+++ b/rbutil/rbutilqt/rbutil.ini
@@ -30,6 +30,8 @@ manual_url=http://download.rockbox.org/daily/manual/%MANUALBASENAME%.%EXTENSION%
 doom_url=http://download.rockbox.org/useful/rockdoom.zip
 rbutil_url=http://download.rockbox.org/rbutil/
 
+; [platforms] is used to determine the order in the device tree.
+; Only devices present in this section will get displayed!
 [platforms]
 platform01=archosplayer
 platform02=archosrecorder
@@ -42,7 +44,7 @@ platform08=archosondiofm
 platform10=iriverh100
 platform11=iriverh120
 platform12=iriverh300
-platform13=iriverh10_5gb.ums
+platform13=iriverh10_5gb
 platform14=iriverh10_5gb.mtp
 platform15=iriverh10
 platform20=ipod1g2g
@@ -86,6 +88,28 @@ platform101=gogearhdd1630
 platform102=gogearhdd6330
 platform103=gogearsa9200
 
+; devices sections
+;
+; Each device has a section here that corresponds to an entry in the
+; [platforms] section.  The section is using the same string configure uses. It
+; might add a postfix (separated with a .) to distinguish variants like
+; recorder vs. recorder8mb
+;
+; name: the human readable name that is displayed to the user
+; bootloadermethod: the installation method for the bootloader. See
+;                   base/bootloader* classes
+; bootloadername: name of the bootloader file on the server
+; bootloaderfile: name of the bootloader file on the device
+; buildserver_modelname: target string used by the build server. Not
+;                        necessarily identical to configure string.
+; manualname: different target name to use for manual. See Iriver H100 series fe.
+; brand: the manufacturer of the device. Used to group in device tree
+; encoder: encoder to use for talk clips and voice files
+; usbid: VID / PID value for detecting the player
+; usberror: VID / PID value for detecting the player in an incompatible mode
+;           (MTP vs MSC)
+; status: allows hiding the target from the list of devices.
+;
 [archosplayer]
 name="Jukebox Player 6000 / Jukebox Studio 5 / 10 / 20"
 buildserver_modelname=archosplayer
@@ -202,7 +226,7 @@ usbid=0x10063003
 configure_modelname=iriverh300
 encoder=rbspeex
 
-[iriverh10_5gb.ums]
+[iriverh10_5gb]
 name="H10 (5 / 6GB) UMS"
 buildserver_modelname=iriverh10_5gb
 bootloadermethod=mi4
@@ -732,6 +756,9 @@ configure_modelname=gogearsa9200
 encoder=rbspeex
 status=disabled
 
+; incompatible devices sections
+; each section uses a USB VID / PID string as section name.
+; name: human readable string to show the user when this device is detected.
 [05ac1240]
 name="Apple Ipod Nano (Second Generation, DFU Mode)"
 
@@ -801,6 +828,10 @@ name="Sansa View"
 [066f3780]
 name="Sansa Fuze+ (Recovery Mode)"
 
+; languages to be shown for voicefile creation.
+; The language string is sent to the server when retrieving the list of
+; strings. Each entry name is the code for the language and used for storing in
+; the configuration.
 [languages]
 af=afrikaans
 bg=bulgarian