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