Commit 985b8b2d authored by Max Kellermann's avatar Max Kellermann

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.
parent c97bccad
...@@ -1210,29 +1210,24 @@ OK ...@@ -1210,29 +1210,24 @@ OK
<term> <term>
<cmdsynopsis> <cmdsynopsis>
<command>update</command> <command>update</command>
<arg><replaceable>URI</replaceable></arg> <arg choice="opt"><replaceable>URI</replaceable></arg>
</cmdsynopsis> </cmdsynopsis>
</term> </term>
<listitem> <listitem>
<para> <para>
Updates the music database. Updates the music database: find new files, remove
deleted files, update modified files.
</para> </para>
<para> <para>
<varname>URI</varname> is a particular directory or <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>
<para> <para>
Prints "updating_db: JOBID" where Prints "updating_db: JOBID" where
<varname>JOBID</varname> is the job id requested for <varname>JOBID</varname> is a positive number
your update, and is displayed in status, while the identifying the update job. You can read the current
requested update is happening. job id in the <command>status</command> response.
</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.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment