When installing builds use the real platform name, not the configuration section...
[Rockbox.git] / manual / appendix / appendix.tex
blob6965d26533cd3b0ce612371496c7ba6d580f7d6c
1 % $Id$ %
2 \appendix
4 \input{appendix/file_formats.tex}
6 \input{appendix/wps_tags.tex}
8 \input{appendix/config_file_options.tex}
10 \chapter{User feedback}\label{sec:feedback}
11 \section{Bug reports}
12 If you experience inappropriate performance from any supported feature,
13 please file a bug report on our web page. Do not report missing
14 features as bugs, instead file them as feature requests (see below).
16 For open bug reports refer to
17 \url{http://www.rockbox.org/tracker/index.php?type=2}
19 \subsection{Rules for submitting new bug reports}
21 \begin{enumerate}
22 \item Check that the bug hasn't already been reported
23 \item Always include the following information in your bug report:
24 \end{enumerate}
26 \begin{itemize}
27 \item Which exact \dap{} you have.
28 \item Which exact Rockbox version you are using
29 (Menu{}-{\textgreater}Info {}-{\textgreater} Version)
30 \item A step{}-by{}-step description of what you did and what happened
31 \item Whether the problem is repeatable or a one{}-time occurrence
32 \item All relevant data regarding the problem, such as playlists, MP3
33 files etc. (IMPORTANT!)
34 \end{itemize}
36 \section{Feature requests}
37 For open feature requests refer to
38 \url{http://www.rockbox.org/tracker/index.php?type=1}
40 \subsection{Rules for submitting a new feature request}
42 \begin{enumerate}
43 \item Check that the feature hasn't already been requested.
44 Duplicates are really boring!
45 \item Check that the feature hasn't already been implemented.
46 Download the latest current/daily build and/or search the mail list archive.
47 \item Check that the feature is possible to implement (see \reference{ref:NODO}).
48 \end{enumerate}
50 \subsection{\label{ref:NODO}Features we will not implement}
51 This is a list of Feature Requests we get repeatedly that we simply
52 cannot do. View it as the opposite of a TODO!
54 \begin{itemize}
55 \opt{archos}{
56 \item Record to WAV (uncompressed) or MP3pro format!\\
57 The recording hardware (the MAS) does not allow us to do this
58 \item Crossfade between tracks!\\
59 Crossfading would require two mp3 decoders, and we only have one.
60 This is not possible.
61 \item Support MP3pro, WMA or other sound format playback!\\
62 The mp3{}-decoding hardware can only play MP3. We cannot make it play other
63 sound formats.
64 \item Converting OGG $\rightarrow$ MP3 \\
65 The mp3{}-decoding hardware cannot decode OGG. It can be reprogrammed, but
66 there is too little memory for OGG and we have no documentation on how to
67 program the MAS' DSP. Doing the conversion with the CPU is impossible, since
68 a 12MHz SH1 is far too slow for this daunting task.
69 \item Archos Multimedia support!\\
70 The Archos Multimedia is a completely different beast. It is an entirely
71 different architecture, different CPU and upgrading the software is done
72 a completely different way. We do not wish to venture into this. Others
73 may do so. We won't.
74 \item Multi{}-band (or graphic) equaliser\\
75 We cannot access information for that kind of visualisation from the MP3
76 decoding hardware.
77 \item CBR recording!\\
78 The MP3 encoding hardware does not allow this.
79 \item Change tempo of a song without changing pitch!\\
80 The MP3 decoding hardware does not allow this.
81 \item Graphic frequency (spectrum analyser!)\\
82 We can't access the audio waveform from the MP3 decoder so we can't analyse
83 it. Even if we had access to it, the CPU would probably be too slow to
84 perform the analysis anyway.
85 \item Cool sound effects!\\
86 Adding new sound effects requires reprogramming the MAS chip, and we can't
87 do that. The MAS chip is programmable, but we have no access to the chip
88 documentation.
90 \nopt{h300,x5}{
91 \item Interfacing with other USB devices (like cameras) or 2 player games over USB\\
92 The USB system demands that there is a master that talks to a slave. The
93 \dap{} can only serve as a slave, as most other USB devices such as
94 cameras can. Thus, without a master no communication between the slaves
95 can take place. If that is not enough, we have no ways of actually
96 controlling the communication performed over USB since the USB circuit
97 in the \dap{} is strictly made for disk{}-access and does not allow us
98 to play with it the way we'd need for any good communication to work.
100 \item Support other file systems than FAT32 (like NTFS or ext2 or whatever)!\\
102 \opt{archos}{Rockbox needs to support FAT32 since it can only start off a FAT32
103 partition (since that is the only way the ROM can load it), and adding}%
104 support for more file systems will just take away valuable ram for
105 unnecessary features. You can partition your \dap{} fine, just make sure
106 the first one is FAT32 and then make the other ones whatever file system
107 you want. Just don't expect Rockbox to understand them.
108 \item Add scandisk{}-like features!\\
109 It would be a very slow operation that would drain the batteries and
110 take a lot of useful ram for something that is much better and faster
111 done when connected to a host computer.
112 \end{itemize}
114 \chapter{Changelog}
115 \section{What's new since v2.5?}
116 Changes in version 2.5
118 \chapter{Credits}
119 People that have contributed to the project, one way or another. Friends!
121 \begin{multicols}{2}
122 \noindent\textsc{\small{\input{CREDITS.tex}}}
123 \end{multicols}
125 \chapter{Licenses}
127 \section{GNU Free Documentation License}
128 \input{appendix/fdl.tex}
129 \newpage
130 \section{The GNU General Public License}
131 \input{appendix/gpl-2.0.tex}