devs/foxbox
1
0
Fork 0
forked from len0rd/rockbox
Code Pull requests Activity

Overhaul of the 'system options' chapter in the manual, introducing a few new options in the platform files. These make it possible to in- or exclude parts easier and more obvious based on the features of a target and follow the 'features.txt' that's used for the language files (just the check for flash based vs. hdd based player would be inverted). The idea was to be able to parse the features.txt into these platform files automatically later on.

Browse source 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@15972 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
Marianne Arnold 2007-12-25 19:55:22 +00:00
parent b8bc45ded0
commit d041521e5f
22 changed files with 125 additions and 39 deletions
Download patch file Download diff file Expand all files Collapse all files

92
manual/configure_rockbox/system_options.tex
View file

@ -7,7 +7,9 @@
WPS. Selecting \setting{Previous Screen} will make Rockbox start in the
screen it was when the \dap{} was shut off.
\subsection{Battery}
\nopt{sansa}%will probably be there on Sansas one day - exclude it the simple way without specific option
{
\subsection{Battery}
Options relating to the \opt{archos}{batteries}\nopt{archos}{battery}
in the \dap.
\begin{description}
@ -20,31 +22,42 @@
\opt{ipodmini}{400mAh (1G) or 630mAh (2G)}%
\opt{ipodcolor}{700mAh}%
\opt{ipodnano,ipodvideo,ipod4g,ipod3g}{\fixme{unknown}}%
\opt{x5}{950mAh}%
\opt{m5,x5}{950mAh}%
, which is the capacity value for the standard
\opt{archos}{batteries}\nopt{archos}{battery} shipped with the \dap.
Rockbox uses this value to estimate remaining battery life for the
statusbar and WPS. Changing this setting has no effect whatsoever on
info screen and WPS. Changing this setting has no effect whatsoever on
actual battery life. This setting only affects the accuracy of the
battery life estimation as shown on screen.
\opt{iaudio}{Rockbox does not automatically distinguish between the
``L'' models and the ``simple'' models which determine the default
value. If your dap{} is an \opt{m5}{M5L}\opt{x5}{X5L} set the value
to 2250mAh for more accuracy in the runtime estimation.}
\opt{ipod,sansa}{This value is fairly meaningless in the \playerman{}
family at present, and work is on-going into finding a better way to
determine battery life.}
\opt{ipod}{This value is fairly meaningless in the \playerman{} family at
present, and work is on-going into finding a better way to determine
battery life.}
\opt{ondiosp,ondiofm}{
\opt{BATTERY_TYPES}{%Ondios only (currently), following the lang features.txt
\item [Battery Type: ]This setting tells Rockbox which type of battery
is currently used in the \dap{}. The two supported battery types are
``Alkaline'' or ``NiMH''.
}
\end{description}
``Alkaline'' or ``NiMH''.}
\nopt{ondiosp,ondiofm}{
\opt{HAVE_USB_CHARGING}{
%TODO: check where it is working correctly (except H300) and append the option to the respective platform file
\item [Charge During USB Connection: ]This option lets you control whether
the \dap{} should charge during the USB connection and hence draw the
full 500mA. Turning it \setting{Off} is recommended if the dap{} is
connected through an unpowered USB hub or a laptop port.
}
\end{description}
}
\opt{HAVE_DIRCACHE,HAVE_DISK_STORAGE}{
\subsection{Disk}
Options relating to the hard disk.
\begin{description}
\nopt{ipodnano}{
\opt{HAVE_DISK_STORAGE}{
\item [Disk Spindown: ]Rockbox has a timer that makes it spin down the
hard disk after it is idle for a certain amount of time. This setting
controls the amount of time between the last user activity and the time
@ -54,7 +67,7 @@
afterwards.
}
\opt{SWCODEC}{
\opt{HAVE_DIRCACHE}{
\item [Directory Cache: ]Rockbox has the ability to cache the contents of
your drive in RAM. The \setting{Directory Cache} takes a small amount of
memory away from Rockbox that would otherwise be used to buffer music,
@ -69,7 +82,7 @@
background.}
}
\end{description}
} % \nopt{ondiosp,ondiofm}
} % \opt{HAVE_DIRCACHE,HAVE_DISK_STORAGE}
\opt{CONFIG_RTC}{
\subsection{Time and Date}
@ -93,15 +106,17 @@ available.
% TODO this isn't quite right for all targets, I think
This option turns the \dap{} off and then starts it up again at the
specified time. Use \ActionSettingInc{} and \ActionSettingDec{} to adjust
the minutes setting, \ActionAlarmHoursDec{} and \ActionAlarmHoursInc{} to adjust the hours.
the minutes setting, \ActionAlarmHoursDec{} and \ActionAlarmHoursInc{} to
adjust the hours.
\ActionAlarmSet{} confirms the alarm and shuts the \dap{} down, and
\ActionAlarmCancel{} cancels setting an alarm. If the \dap{} is turned on
again before the alarm occurs, the alarm will be cancelled. Using this
option disables the \setting{Sleep Timer}.
\opt{HAVE_RECORDING,CONFIG_TUNER}{
\subsection{Alarm Wake up Screen}
This option controls what the \dap{} does when it is woken up by the alarm.
}
}
\subsection{Limits}
@ -121,7 +136,18 @@ This sub menu relates to limits in the Rockbox operating system.
have very large playlists.
\end{description}
\opt{player,recorder,recorderv2fm,gigabeat,ipodvideo,iriver,iaudio,e200}{
% TODO: this needs to be rewritten in another style, it lets you mix sound from another source into the music
\opt{player}{
\subsection{Line In} This option activates the line in port on \dap, which is
off by default. This is useful for such applications as:
\begin{itemize}
\item Game boy $\rightarrow$ \dap $\rightarrow$ human
\item laptop $\rightarrow$ \dap $\rightarrow$ human
\item LAN party computer $\rightarrow$ \dap $\rightarrow$ human
\end{itemize}
}
\opt{HAVE_CAR_ADAPTER_MODE}{
\subsection{Car Adapter Mode}
This option turns \setting{On} and \setting{Off} the car ignition
auto stop function.
@ -144,13 +170,25 @@ This sub menu relates to limits in the Rockbox operating system.
playback.
}
% TODO: this needs to be rewritten in another style, but i really don't know what kind of "line in" this describes... isn't it used for recording?
\opt{player}{
\subsection{Line In} This option activates the line in port on \dap, which is
off by default. This is useful for such applications as:
\begin{itemize}
\item Game boy $\rightarrow$ \dap $\rightarrow$ human
\item laptop $\rightarrow$ \dap $\rightarrow$ human
\item LAN party computer $\rightarrow$ \dap $\rightarrow$ human
\end{itemize}
\opt{HAVE_BUTTON_LIGHTS}{
\opt{e200}{
\subsection{Wheel Light Timeout}
This setting controls the amount of time the wheel lights shine after a
button press or wheel turn. If set to \setting{Off}, the LEDs will not
light when a button is pressed. If set to \setting{On}, the lights will
never shut off. If set to a time (1 to 120 seconds), the wheel will stay
lit for that amount of time after a button press or wheel turn.
}
\nopt{e200}{
\subsection{Button Light Timeout}
This setting controls the amount of time the button lights shine after a
button press. If set to \setting{Off}, the LEDs will not light when a
button is pressed. If set to \setting{On}, the lights will never shut off.
If set to a time (1 to 120 seconds), the buttons will stay lit for
that amount of time after a button press.
}
\opt{gigabeatf}{
\subsection{Button Light Brightness}
Changes the brightness of the button lights.
}
}

3
manual/platform/c200.tex
View file

@ -9,6 +9,9 @@
\edef\UseOption{\UseOption,HAVE_LCD_COLOR}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT_BRIGHTNESS}
\edef\UseOption{\UseOption,HAVE_CAR_ADAPTER_MODE}
\edef\UseOption{\UseOption,HAVE_BUTTON_LIGHTS}
\edef\UseOption{\UseOption,HAVE_RECORDING}
\edef\UseOption{\UseOption,sansa}
\newcommand{\playerman}{Sansa}

2
manual/platform/e200.tex
View file

@ -13,6 +13,8 @@
\edef\UseOption{\UseOption,HAVE_LCD_COLOR}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT_BRIGHTNESS}
\edef\UseOption{\UseOption,HAVE_CAR_ADAPTER_MODE}
\edef\UseOption{\UseOption,HAVE_BUTTON_LIGHTS}
\edef\UseOption{\UseOption,sansa}
\newcommand{\playerman}{Sansa}

4
manual/platform/gigabeatf.tex
View file

@ -8,6 +8,10 @@
\edef\UseOption{\UseOption,HAVE_LCD_COLOR}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT_BRIGHTNESS}
\edef\UseOption{\UseOption,HAVE_DIRCACHE}
\edef\UseOption{\UseOption,HAVE_DISK_STORAGE}
\edef\UseOption{\UseOption,HAVE_CAR_ADAPTER_MODE}
\edef\UseOption{\UseOption,HAVE_BUTTON_LIGHTS}
\edef\UseOption{\UseOption,gigabeat}
\newcommand{\playerman}{Toshiba}

3
manual/platform/h10.tex
View file

@ -12,6 +12,9 @@
\edef\UseOption{\UseOption,SWCODEC}
\edef\UseOption{\UseOption,IRIVER_H10_PAD}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
\edef\UseOption{\UseOption,HAVE_DIRCACHE}
\edef\UseOption{\UseOption,HAVE_DISK_STORAGE}
\edef\UseOption{\UseOption,HAVE_CAR_ADAPTER_MODE}
\edef\UseOption{\UseOption,iriver}
\newcommand{\playerman}{Iriver}

3
manual/platform/h10_5gb.tex
View file

@ -9,6 +9,9 @@
\edef\UseOption{\UseOption,SWCODEC}
\edef\UseOption{\UseOption,IRIVER_H10_PAD}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
\edef\UseOption{\UseOption,HAVE_DIRCACHE}
\edef\UseOption{\UseOption,HAVE_DISK_STORAGE}
\edef\UseOption{\UseOption,HAVE_CAR_ADAPTER_MODE}
\edef\UseOption{\UseOption,iriver}
\newcommand{\playerman}{Iriver}

3
manual/platform/h1xx.tex
View file

@ -11,6 +11,9 @@
\edef\UseOption{\UseOption,HAVE_REMOTE_LCD}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT_PWM_FADING}
\edef\UseOption{\UseOption,HAVE_DIRCACHE}
\edef\UseOption{\UseOption,HAVE_DISK_STORAGE}
\edef\UseOption{\UseOption,HAVE_CAR_ADAPTER_MODE}
\edef\UseOption{\UseOption,iriver}
\newcommand{\playerman}{Iriver}

4
manual/platform/h300.tex
View file

@ -12,6 +12,10 @@
\edef\UseOption{\UseOption,HAVE_REMOTE_LCD}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT_BRIGHTNESS}
\edef\UseOption{\UseOption,HAVE_DIRCACHE}
\edef\UseOption{\UseOption,HAVE_CAR_ADAPTER_MODE}
\edef\UseOption{\UseOption,HAVE_DISK_STORAGE}
\edef\UseOption{\UseOption,HAVE_USB_CHARGING}
\edef\UseOption{\UseOption,iriver}
\newcommand{\playerman}{Iriver}

2
manual/platform/ipod1g2g.tex
View file

@ -9,6 +9,8 @@
\edef\UseOption{\UseOption,SWCODEC}
\edef\UseOption{\UseOption,IPOD_3G_PAD}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
\edef\UseOption{\UseOption,HAVE_DIRCACHE}
\edef\UseOption{\UseOption,HAVE_DISK_STORAGE}
\edef\UseOption{\UseOption,ipod}
\newcommand{\playerman}{Ipod}

2
manual/platform/ipod3g.tex
View file

@ -9,6 +9,8 @@
\edef\UseOption{\UseOption,SWCODEC}
\edef\UseOption{\UseOption,IPOD_3G_PAD}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
\edef\UseOption{\UseOption,HAVE_DIRCACHE}
\edef\UseOption{\UseOption,HAVE_DISK_STORAGE}
\edef\UseOption{\UseOption,ipod}
\newcommand{\playerman}{Ipod}

2
manual/platform/ipod4g.tex
View file

@ -9,6 +9,8 @@
\edef\UseOption{\UseOption,SWCODEC}
\edef\UseOption{\UseOption,IPOD_4G_PAD}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
\edef\UseOption{\UseOption,HAVE_DIRCACHE}
\edef\UseOption{\UseOption,HAVE_DISK_STORAGE}
\edef\UseOption{\UseOption,ipod}
\newcommand{\playerman}{Ipod}

2
manual/platform/ipodcolor.tex
View file

@ -8,6 +8,8 @@
\edef\UseOption{\UseOption,IPOD_4G_PAD}
\edef\UseOption{\UseOption,HAVE_LCD_COLOR}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
\edef\UseOption{\UseOption,HAVE_DIRCACHE}
\edef\UseOption{\UseOption,HAVE_DISK_STORAGE}
\edef\UseOption{\UseOption,ipod}
\newcommand{\playerman}{Ipod}

2
manual/platform/ipodmini.tex
View file

@ -10,6 +10,8 @@
\edef\UseOption{\UseOption,IPOD_4G_PAD}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT_PWM_FADING}
\edef\UseOption{\UseOption,HAVE_DIRCACHE}
\edef\UseOption{\UseOption,HAVE_DISK_STORAGE}
\edef\UseOption{\UseOption,ipod}
\newcommand{\playerman}{Ipod}

2
manual/platform/ipodnano.tex
View file

@ -10,6 +10,7 @@
\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT_BRIGHTNESS}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT_PWM_FADING}
\edef\UseOption{\UseOption,HAVE_DIRCACHE}
\edef\UseOption{\UseOption,ipod}
\newcommand{\playerman}{Ipod}
@ -91,7 +92,6 @@
\newcommand{\ActionKbdMorseInput}{Long \ButtonMenu}
\newcommand{\ActionKbdMorseSelect}{\ButtonSelect}
%Button actions, Pitch Screen context
\newcommand{\ActionPsToggleMode}{\ButtonPlay}
\newcommand{\ActionPsIncSmall}{\ButtonScrollFwd}

4
manual/platform/ipodvideo.tex
View file

@ -10,6 +10,9 @@
\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT_BRIGHTNESS}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT_PWM_FADING}
\edef\UseOption{\UseOption,HAVE_DIRCACHE}
\edef\UseOption{\UseOption,HAVE_DISK_STORAGE}
\edef\UseOption{\UseOption,HAVE_CAR_ADAPTER_MODE}
\edef\UseOption{\UseOption,ipod}
\newcommand{\playerman}{Ipod}
@ -91,7 +94,6 @@
\newcommand{\ActionKbdMorseInput}{Long \ButtonMenu}
\newcommand{\ActionKbdMorseSelect}{\ButtonSelect}
%Button actions, Pitch Screen context
\newcommand{\ActionPsToggleMode}{\ButtonPlay}
\newcommand{\ActionPsIncSmall}{\ButtonScrollFwd}

3
manual/platform/m5.tex
View file

@ -10,6 +10,9 @@
\edef\UseOption{\UseOption,IAUDIO_X5_PAD}
\edef\UseOption{\UseOption,HAVE_REMOTE_LCD}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
\edef\UseOption{\UseOption,HAVE_DIRCACHE}
\edef\UseOption{\UseOption,HAVE_DISK_STORAGE}
\edef\UseOption{\UseOption,HAVE_CAR_ADAPTER_MODE}
\edef\UseOption{\UseOption,iaudio}
\newcommand{\playerman}{Iaudio}

1
manual/platform/ondiofm.tex
View file

@ -10,6 +10,7 @@
\edef\UseOption{\UseOption,CONFIG_TUNER}
\edef\UseOption{\UseOption,MASCODEC}
\edef\UseOption{\UseOption,ONDIO_PAD}
\edef\UseOption{\UseOption,BATTERY_TYPES}
\edef\UseOption{\UseOption,archos}
\newcommand{\playerman}{Archos}

1
manual/platform/ondiosp.tex
View file

@ -7,6 +7,7 @@
\edef\UseOption{\UseOption,HAVE_LCD_FLIP}
\edef\UseOption{\UseOption,MASCODEC}
\edef\UseOption{\UseOption,ONDIO_PAD}
\edef\UseOption{\UseOption,BATTERY_TYPES}
\edef\UseOption{\UseOption,archos}
\newcommand{\playerman}{Archos}

2
manual/platform/player.tex
View file

@ -3,6 +3,8 @@
\edef\UseOption{\UseOption,MASCODEC}
\edef\UseOption{\UseOption,PLAYER_PAD}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
\edef\UseOption{\UseOption,HAVE_DISK_STORAGE}
\edef\UseOption{\UseOption,HAVE_CAR_ADAPTER_MODE}
\edef\UseOption{\UseOption,archos}
\newcommand{\playerman}{Archos}

2
manual/platform/recorder.tex
View file

@ -8,6 +8,8 @@
\edef\UseOption{\UseOption,MASCODEC}
\edef\UseOption{\UseOption,RECORDER_PAD}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
\edef\UseOption{\UseOption,HAVE_DISK_STORAGE}
\edef\UseOption{\UseOption,HAVE_CAR_ADAPTER_MODE}
\edef\UseOption{\UseOption,archos}
\newcommand{\playerman}{Archos}

2
manual/platform/recorderv2fm.tex
View file

@ -10,6 +10,8 @@
\edef\UseOption{\UseOption,MASCODEC}
\edef\UseOption{\UseOption,RECORDER_PAD}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
\edef\UseOption{\UseOption,HAVE_DISK_STORAGE}
\edef\UseOption{\UseOption,HAVE_CAR_ADAPTER_MODE}
\edef\UseOption{\UseOption,archos}
\newcommand{\playerman}{Archos}

3
manual/platform/x5.tex
View file

@ -14,6 +14,9 @@
\edef\UseOption{\UseOption,HAVE_REMOTE_LCD}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
\edef\UseOption{\UseOption,HAVE_BACKLIGHT_BRIGHTNESS}
\edef\UseOption{\UseOption,HAVE_DIRCACHE}
\edef\UseOption{\UseOption,HAVE_DISK_STORAGE}
\edef\UseOption{\UseOption,HAVE_CAR_ADAPTER_MODE}
\edef\UseOption{\UseOption,iaudio}
\newcommand{\playerman}{Iaudio}