From: kaliko <kaliko@azylum.org>
Date: Wed, 29 Aug 2018 09:29:56 +0000 (+0200)
Subject: Add precision in documentation/manual
X-Git-Tag: 0.15.0~2
X-Git-Url: https://git.kaliko.me/?a=commitdiff_plain;h=84b382f17e4086f5d0765a964db645144cfc5ca5;p=mpd-sima.git

Add precision in documentation/manual
---

diff --git a/data/man/mpd_sima.cfg.5 b/data/man/mpd_sima.cfg.5
index 3b9c376..3f24b61 100644
--- a/data/man/mpd_sima.cfg.5
+++ b/data/man/mpd_sima.cfg.5
@@ -2,12 +2,12 @@
 .\"     Title: mpd_sima.cfg
 .\"    Author: Jack Kaliko <kaliko@azylum.org>
 .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\"      Date: 11/21/2017
+.\"      Date: 08/29/2018
 .\"    Manual: mpd-sima 0.15.0 User Manual
 .\"    Source: mpd-sima
 .\"  Language: English
 .\"
-.TH "MPD_SIMA\&.CFG" "5" "11/21/2017" "mpd-sima" "mpd-sima 0.15.0 User Manual"
+.TH "MPD_SIMA\&.CFG" "5" "08/29/2018" "mpd-sima" "mpd-sima 0.15.0 User Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -116,7 +116,7 @@ Configure logging\&.
 .RS 4
 File to log to, usually in d\(aemon mode\&.
 .br
-Defaut (empty or unset) is to log to stdin/stdout\&.
+Default (empty or unset) is to log to stdin/stdout\&.
 .RE
 .PP
 \fBverbosity=\fR\fIinfo\fR
@@ -315,7 +315,7 @@ for info about queue modes)\&.
 .PP
 \fBmax_art=\fR\fI10\fR
 .RS 4
-Number of similar artist to retrieve from local media library\&.
+Maximum number of similar artist to retrieve from local media library\&.
 .br
 When set to something superior to zero, it tries to get as much similar artists from media library\&.
 .RE
@@ -342,7 +342,10 @@ How many track(s) to add\&. Only relevant in
 \fBtop\fR
 and
 \fBtrack\fR
-queue modes\&.
+queue modes\&. This is actually an upper limit, min(\fBmax_art\fR,
+\fBtrack_to_add\fR) will be used, and
+\fBmax_art\fR
+might be inferior lower than value set in config\&.
 .RE
 .PP
 \fBalbum_to_add=\fR\fI1\fR
diff --git a/data/man/mpd_sima.cfg.5.xml b/data/man/mpd_sima.cfg.5.xml
index fca2263..8481c4c 100644
--- a/data/man/mpd_sima.cfg.5.xml
+++ b/data/man/mpd_sima.cfg.5.xml
@@ -342,7 +342,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                 <varlistentry> <!-- lastfm.max_art -->
                     <term><option>max_art=</option><replaceable>10</replaceable></term>
                     <listitem>
-                        <para>Number of similar artist to retrieve from local
+                        <para>Maximum number of similar artist to retrieve from local
                             media library.<sbr />When set to something superior
                             to zero, it tries to get as much similar artists
                             from media library.</para>
@@ -372,7 +372,11 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
                     <listitem>
                         <para>How many track(s) to add. Only relevant in
                             <option>top</option> and <option>track</option>
-                            queue modes.</para>
+                            queue modes. This is actually an upper limit,
+                            min(<option>max_art</option>,
+                            <option>track_to_add</option>) will be used, and
+                            <option>max_art</option> might be inferior lower
+                            than value set in config.</para>
                     </listitem>
                 </varlistentry>
                 <varlistentry> <!-- lastfm.album_to_add -->