[latex3-commits] [git/LaTeX3-latex3-l3build] main: Document option_list (fixes #153) (b1f03bc)

[Joseph Wright]

Repository : https://github.com/latex3/l3build
On branch  : main
Link       : https://github.com/latex3/l3build/commit/b1f03bcb18610804edd9a0c4f8c263f76849a1ca

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

commit b1f03bcb18610804edd9a0c4f8c263f76849a1ca
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date:   Wed Nov 24 09:17:30 2021 +0000

    Document option_list (fixes #153)


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

b1f03bcb18610804edd9a0c4f8c263f76849a1ca
 CHANGELOG.md | 1 +
 l3build.dtx  | 9 ++++++++-
 2 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 4cd8353..a4aa732 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -8,6 +8,7 @@ this project uses date-based 'snapshot' version identifiers.
 ## [Unreleased]
 
 ### Changed
+- Documentation improvements
 - Use `checkengines[1]` as the default for `stdengine`
 
 ### Fixed
diff --git a/l3build.dtx b/l3build.dtx
index 88cb82e..3dcea3f 100644
--- a/l3build.dtx
+++ b/l3build.dtx
@@ -1905,7 +1905,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 +1924,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}
 %