[latex3-commits] [git/LaTeX3-latex3-l3build] master: docu for new update behaviour (088696a)

[Will Robertson]

Repository : https://github.com/latex3/l3build
On branch  : master
Link       : https://github.com/latex3/l3build/commit/088696a2271e731cf5dcadff978fd2fdc0b58cf0

>---------------------------------------------------------------

commit 088696a2271e731cf5dcadff978fd2fdc0b58cf0
Author: Will Robertson <wspr81 at gmail.com>
Date:   Mon Jan 7 21:50:09 2019 +0800

    docu for new update behaviour


>---------------------------------------------------------------

088696a2271e731cf5dcadff978fd2fdc0b58cf0
 l3build.dtx |   16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

diff --git a/l3build.dtx b/l3build.dtx
index 7674b3d..1607c64 100644
--- a/l3build.dtx
+++ b/l3build.dtx
@@ -1313,10 +1313,20 @@
 % is performed; this should usually be performed for minor bug or documentation fixes only.
 %
 % \paragraph{Uploader details}
-% The CTAN team use the uploader details (name and email) as a form of low-security sanity
+% The CTAN team use the uploader email address as a form of low-security sanity
 % check that the upload is coming from a reputable source. Therefore, it is advisable not
-% to store this information within a public |build.lua| file and instead use a private
-% configuration file to add this information at upload time.
+% to store this information within a public |build.lua| file. It can be set on the command
+% line with the |--email| option to \texttt{l3build}; alternatively, a private
+% configuration file could be used to add this information at upload time.
+%
+% \paragraph{The \texttt{update} field}
+% In most scenarios the |update| field does not need to be explicitly set. By default
+% \pkg{l3build} assumes that the package being uploaded already exists on CTAN
+% (|update=true|). If it does not, this is caught in the validation process before
+% uploading and automatically corrected. If you set |update| explicitly this will be passed
+% directly to CTAN in all circumstances, leading to errors if you attempt to update a
+% non-existing package or if you attempt to upload a new package with the same name as a
+% pre-existing one.
 %
 % \begin{table}[p]
 %   \def\YES{\textbullet}