From c97bccad0194e8cb0806316ae4979aefa36d2b66 Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@duempel.org>
Date: Thu, 10 Sep 2009 23:10:23 +0200
Subject: doc/mpdconf.example: additional comment signs for some parameters

Add a second column of comment signs on some parameters which users
shouldn't usually set, unless they know what they're doing.
---
 doc/mpdconf.example | 36 ++++++++++++++++++------------------
 1 file changed, 18 insertions(+), 18 deletions(-)

(limited to 'doc')

diff --git a/doc/mpdconf.example b/doc/mpdconf.example
index 919326236..11b14bd93 100644
--- a/doc/mpdconf.example
+++ b/doc/mpdconf.example
@@ -177,11 +177,11 @@ input {
 #audio_output {
 #	type		"alsa"
 #	name		"My ALSA Device"
-#	device		"hw:0,0"	# optional
-#	format		"44100:16:2"	# optional
-#	mixer_device	"default"	# optional
-#	mixer_control	"PCM"		# optional
-#	mixer_index	"0"		# optional
+##	device		"hw:0,0"	# optional
+##	format		"44100:16:2"	# optional
+##	mixer_device	"default"	# optional
+##	mixer_control	"PCM"		# optional
+##	mixer_index	"0"		# optional
 #}
 #
 # An example of an OSS output:
@@ -189,10 +189,10 @@ input {
 #audio_output {
 #	type		"oss"
 #	name		"My OSS Device"
-#	device		"/dev/dsp"	# optional
-#	format		"44100:16:2"	# optional
-#	mixer_device	"/dev/mixer"	# optional
-#	mixer_control	"PCM"		# optional
+##	device		"/dev/dsp"	# optional
+##	format		"44100:16:2"	# optional
+##	mixer_device	"/dev/mixer"	# optional
+##	mixer_control	"PCM"		# optional
 #}
 #
 # An example of a shout output (for streaming to Icecast):
@@ -208,12 +208,12 @@ input {
 #	quality		"5.0"
 #	bitrate		"128"
 #	format		"44100:16:1"
-#	protocol	"icecast2"		# optional
-#	user		"source"		# optional
-#	description	"My Stream Description"	# optional
-#	genre		"jazz"			# optional
-#	public		"no"			# optional
-#	timeout		"2"			# optional
+##	protocol	"icecast2"		# optional
+##	user		"source"		# optional
+##	description	"My Stream Description"	# optional
+##	genre		"jazz"			# optional
+##	public		"no"			# optional
+##	timeout		"2"			# optional
 #}
 #
 # An example of a httpd output (built-in HTTP streaming server):
@@ -223,7 +223,7 @@ input {
 #	name		"My HTTP Stream"
 #	encoder		"vorbis"		# optional, vorbis or lame
 #	port		"8000"
-#	quality		"5.0"			# do not define if bitrate is defined
+##	quality		"5.0"			# do not define if bitrate is defined
 #	bitrate		"128"			# do not define if quality is defined
 #	format		"44100:16:1"
 #}
@@ -233,8 +233,8 @@ input {
 #audio_output {
 #	type		"pulse"
 #	name		"My Pulse Output"
-#	server		"remote_server"		# optional
-#	sink		"remote_server_sink"	# optional
+##	server		"remote_server"		# optional
+##	sink		"remote_server_sink"	# optional
 #}
 #
 ## Example "pipe" output:
-- 
cgit v1.2.3


From 985b8b2d7159a47d1dd1d3604d6b8f6edc94d2e7 Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@duempel.org>
Date: Thu, 10 Sep 2009 19:54:15 +0200
Subject: doc/protocol: clarify "update"

The update job id is positive.  When used in a command list, MPD
prints one job id for each "update" command.
---
 doc/protocol.xml | 21 ++++++++-------------
 1 file changed, 8 insertions(+), 13 deletions(-)

(limited to 'doc')

diff --git a/doc/protocol.xml b/doc/protocol.xml
index 5418ea8f8..2bc7d55ae 100644
--- a/doc/protocol.xml
+++ b/doc/protocol.xml
@@ -1210,29 +1210,24 @@ OK
           <term>
             <cmdsynopsis>
               <command>update</command>
-              <arg><replaceable>URI</replaceable></arg>
+              <arg choice="opt"><replaceable>URI</replaceable></arg>
             </cmdsynopsis>
           </term>
           <listitem>
             <para>
-              Updates the music database.
+              Updates the music database: find new files, remove
+              deleted files, update modified files.
             </para>
             <para>
               <varname>URI</varname> is a particular directory or
-              song/file to update.
+              song/file to update.  If you do not specify it,
+              everything is updated.
             </para>
             <para>
               Prints "updating_db: JOBID" where
-              <varname>JOBID</varname> is the job id requested for
-              your update, and is displayed in status, while the
-              requested update is happening.
-            </para>
-            <para>
-              To update a number of paths/songs at once, use
-              command_list, it will be much more faster/efficient.
-              Also, if you use a command_list for updating, only one
-              <command>update</command> job id will be returned per
-              sequence of updates.
+              <varname>JOBID</varname> is a positive number
+              identifying the update job.  You can read the current
+              job id in the <command>status</command> response.
             </para>
           </listitem>
         </varlistentry>
-- 
cgit v1.2.3