summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAidan MacDonald <amachronic@protonmail.com>2023-01-02 20:45:14 +0000
committerAidan MacDonald <amachronic@protonmail.com>2023-01-02 20:55:02 +0000
commit9d6f9441ae32c895a24653f95c080929c00da732 (patch)
tree0e9ec6d5dbe71cca8f21b2e522658ef8629fa011
parente8e781b00655fb18e8c1dc1378b9deeaea1c31ba (diff)
downloadrockbox-9d6f9441ae32c895a24653f95c080929c00da732.tar.gz
rockbox-9d6f9441ae32c895a24653f95c080929c00da732.zip
manuals: Update warning on max entries in file browser / playlist
These settings have a warning that increasing them will shorten the audio buffer. This is not very useful, because users might not know what "shortening the music buffer" implies. Since the size of the audio buffer is probably irrelevant for flash based storage, display the warning only for HDD-based targets, and explain what the drawbacks may be if the settings are set too high. Change-Id: Ie9eb4907c67e20695bfa083e1c2a29385e66afcf
-rwxr-xr-xmanual/configure_rockbox/system_options.tex14
1 files changed, 8 insertions, 6 deletions
diff --git a/manual/configure_rockbox/system_options.tex b/manual/configure_rockbox/system_options.tex
index 85e6a6b7d6..336b0dd84d 100755
--- a/manual/configure_rockbox/system_options.tex
+++ b/manual/configure_rockbox/system_options.tex
@@ -103,15 +103,17 @@ This sub menu relates to limits in the Rockbox operating system.
103 \item [Max Entries in File Browser.] This setting controls the limit on 103 \item [Max Entries in File Browser.] This setting controls the limit on
104 the number of files that you can see in any particular directory in the 104 the number of files that you can see in any particular directory in the
105 file browser. You can configure the size to be between 50 and 105 file browser. You can configure the size to be between 50 and
106 10,000 files in steps of 50. The default is 400. Higher values will shorten 106 10,000 files in steps of 50. The default is 400. \opt{HAVE_DISK_STORAGE}{
107 the music buffer, so you should increase this setting \emph{only} if you have 107 Higher values will shorten the music buffer, which can negatively affect
108 directories with a large number of files. 108 battery life by forcing the disk to spin up more often. Increase this
109 setting \emph{only} if you need to.}
109 110
110 \item [Max Playlist Size.] This setting controls the maximum size of 111 \item [Max Playlist Size.] This setting controls the maximum size of
111 a playlist. The playlist size can be between 1,000 and 32,000 files, 112 a playlist. The playlist size can be between 1,000 and 32,000 files,
112 in steps of 1,000 (default is 10,000). Higher values will shorten the 113 in steps of 1,000 (default is 10,000). \opt{HAVE_DISK_STORAGE}{Higher
113 music buffer, so you should increase this setting \emph{only} if you 114 values will shorten the music buffer, which can negatively affect battery
114 have very large playlists. 115 life by forcing the disk to spin up more often. Increase this setting
116 \emph{only} if you use very large playlists.}
115 117
116 \item [Glyphs To Cache.] This sets the default memory allocation size 118 \item [Glyphs To Cache.] This sets the default memory allocation size
117 for fonts in unique glyphs. This should be set to the number of unique 119 for fonts in unique glyphs. This should be set to the number of unique