summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/l3build/l3build.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/l3build/l3build.dtx')
-rw-r--r--macros/latex/contrib/l3build/l3build.dtx16
1 files changed, 12 insertions, 4 deletions
diff --git a/macros/latex/contrib/l3build/l3build.dtx b/macros/latex/contrib/l3build/l3build.dtx
index 88cb82e0d4..cf3ebd8cd5 100644
--- a/macros/latex/contrib/l3build/l3build.dtx
+++ b/macros/latex/contrib/l3build/l3build.dtx
@@ -236,7 +236,7 @@
% }^^A
% }
%
-% \date{Released 2021-11-24}
+% \date{Released 2021-11-29}
%
% \maketitle
% \tableofcontents
@@ -1525,7 +1525,8 @@
% \meta{package}|-ctan.curlopt|. This is then passed to curl using its
% |--config| commandline option. (Using an intermediate file helps
% keep \pkg{l3build} portable between systems using different
-% commandline quoting conventions.)
+% commandline quoting conventions. Any backslashes are doubled when writing
+% to this file, so they do not need to be doubled in announcement and note texts.)
%
% By default the file is written into the current directory alongside
% the zip file to be uploaded. You may wish to specify that this file
@@ -1858,7 +1859,7 @@
%
% \subsection{Typesetting functions}
%
-% All typetting functions return $0$ on a successful completion.
+% All typesetting functions return $0$ on a successful completion.
%
% \begin{function}{biber()}
% \begin{syntax}
@@ -1905,7 +1906,7 @@
% when creating non-standard typesetting steps.
% \end{function}
%
-% \subsection{Customising the target list}
+% \subsection{Customising the target and option lists}
%
% The targets known to \pkg{l3build} are stored in the global table
% |target_list|. Each entry should have at least a |func|, pointing to the
@@ -1924,6 +1925,13 @@
% \end{itemize}
% The functions |func|, |bundle_func| and |pre| must return 0 on success.
%
+% The list of options (switches) is controlled by the |option_list| table.
+% The name of each entry in the table is the \enquote{long} version of the
+% option. Each entry requires a |type|, one of |boolean|, |string| or
+% |table|. As for targets, each entry should have a |desc| to construct
+% the |help()|. It is also possible to provide a |short| name for the option:
+% this should be a single letter.
+%
% \subsection{Customising the manifest file}
% \label{sec:manifest}
%