[latex3-commits] [git/LaTeX3-latex3-l3build] master: docu for --message and --file (e102966)

[Will Robertson]

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

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

commit e10296640670168f81fbdf54c84c17af608b75de
Author: Will Robertson <wspr81 at gmail.com>
Date:   Mon Jan 7 15:26:59 2019 +0800

    docu for --message and --file


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

e10296640670168f81fbdf54c84c17af608b75de
 l3build.dtx |    9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/l3build.dtx b/l3build.dtx
index 93463a3..88f65f8 100644
--- a/l3build.dtx
+++ b/l3build.dtx
@@ -1302,10 +1302,14 @@
 % A description of this metadata is outlined in Table~\ref{tab:upload-setup},
 % and a simple example of an extract from a \texttt{build.lua} file using this is shown
 % in Figure~\ref{fig:uploadconfig}.
-% Note that the \texttt{upload} target will \emph{not} execute the \texttt{ctan} target first.
 %
-% To pass the 
+% Note that the \texttt{upload} target will \emph{not} execute the \texttt{ctan} target first.
 %
+% It can be convenient not to include the announcement text within the |build.lua| file
+% directly. The command line argument |--message| (|-m|) allows the announcement to be
+% included as part of the |l3build| arguments, and |--file| (|-F|) reads the announcement
+% from a specified file. Note that if the announcement text is omitted a `silent update'
+% is performed; this should usually be performed for minor bug or documentation fixes only.
 %
 % \begin{table}[p]
 %   \def\YES{\textbullet}
@@ -1352,7 +1356,6 @@
 %       ctanPath    = "/macros/latex/contrib/vertbars",
 %       repository  = "https://github.com/wspr/herries-press/",
 %       uploader    = "Will Robertson",
-%       email       = [...],
 %       update      = true,
 %     }
 %   \end{lstlisting}