[latex3-commits] [git/LaTeX3-latex3-l3build] master: Use |...| for option docs [ci skip] (fixes #57) (64d8a91)

[Joseph Wright]

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

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

commit 64d8a91bd67e8ef54f502119d15e59474182163d
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date:   Tue Feb 27 14:57:22 2018 +0000

    Use |...| for option docs [ci skip] (fixes #57)


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

64d8a91bd67e8ef54f502119d15e59474182163d
 l3build.dtx |   38 +++++++++++++++++++-------------------
 1 file changed, 19 insertions(+), 19 deletions(-)

diff --git a/l3build.dtx b/l3build.dtx
index 1100cf8..cfafee0 100644
--- a/l3build.dtx
+++ b/l3build.dtx
@@ -312,29 +312,29 @@
 %
 % As well as these commands, the system recognises the options
 % \begin{itemize}
-%   \item \texttt{--config} (\texttt{-c}) Configuration(s) to use for testing
-% \item \texttt{--date} Date to use when setting version
+%   \item |--config| (|-c|) Configuration(s) to use for testing
+% \item |--date| Date to use when setting version
 %   data
-% \item \texttt{--dry-run} Runs the \texttt{install} target but does not copy
+% \item |--dry-run| Runs the \texttt{install} target but does not copy
 %   any files: simply lists those that would be installed
-% \item \texttt{--engine} (\texttt{-e}) Sets the engine to use for
+% \item |--engine| (|-e|) Sets the engine to use for
 %   testing
-% \item \texttt{--epoch} Sets the epoch for typesetting and testing
-% \item \texttt{--first} Name of the first test to run
-% \item \texttt{--force} (\texttt{-f}) Force checks to run even if sanity
-%   checks fail, \emph{e.g.}~when \texttt{--engine} is not given in
+% \item |--epoch| Sets the epoch for typesetting and testing
+% \item |--first| Name of the first test to run
+% \item |--force| (|-f|) Force checks to run even if sanity
+%   checks fail, \emph{e.g.}~when |--engine| is not given in
 %   \luavar{checkengines}
-% \item \texttt{--halt-on-error} (\texttt{-H}) Specifies that checks
+% \item \texttt{--halt-on-error} (|-H|) Specifies that checks
 %   should stop as soon as possible, rather than running all requested
 %   tests; the difference file is printed in the terminal directly in the case of failure
-%  \item \texttt{--last} Name of the last test to run
-% \item \texttt{--pdf} (\texttt{-p}) Test PDF file against a reference
+%  \item |--last| Name of the last test to run
+% \item |--pdf| (|-p|) Test PDF file against a reference
 %   version rather than using a log comparison
-% \item \texttt{--quiet} (\texttt{-q}) Suppresses output from unpacking
-% \item \texttt{--rerun} Run tests without unpacking/set up
-% \item \texttt{--shuffle} Shuffle the order in whichs tests run
-% \item \texttt{--texmfhome} Sets the location of the user tree for installing
-% \item \texttt{--version} (\texttt{-v}) Version string to use when setting
+% \item |--quiet| (|-q|) Suppresses output from unpacking
+% \item |--rerun| Run tests without unpacking/set up
+% \item |--shuffle| Shuffle the order in whichs tests run
+% \item |--texmfhome| Sets the location of the user tree for installing
+% \item |--version| (|-v|) Version string to use when setting
 %   version data
 % \end{itemize}
 %
@@ -378,10 +378,10 @@
 % \begin{buildcmd}{check \meta{name(s)}}
 % Checks only the test \texttt{\meta{name(s)}.lvt}.
 % All engines specified by \var{checkengines} are tested unless the command
-% line option \texttt{--engine} (or \texttt{-e}) has been given to limit
+% line option |--engine| (or |-e|) has been given to limit
 % testing to a single engine. Normally testing is preceded by unpacking
 % source files and copying the result plus any additional support to the
-% test directory: this may be skipped using the \texttt{-s} option.
+% test directory: this may be skipped using the |-s| option.
 % \end{buildcmd}
 %
 % \begin{buildcmd}{check -p}
@@ -488,7 +488,7 @@
 % This command saves the output of the test to a |.tlg| file.
 % This file is then used in all subsequent checks against the \texttt{\meta{name}.lvt} test.
 %
-% If the \texttt{--engine} (or \texttt{-e}) is specified (one of |pdftex|, |xetex|, or |luatex|), the saved output is stored in \texttt{\meta{name}.\meta{engine}.tlg}. This is necessary if running the test through a different engine produces a different output.
+% If the |--engine| (or |-e|) is specified (one of |pdftex|, |xetex|, or |luatex|), the saved output is stored in \texttt{\meta{name}.\meta{engine}.tlg}. This is necessary if running the test through a different engine produces a different output.
 % A normalisation process is performed when checking to avoid common differences such as register allocation; full details are listed in section~\ref{sec:norm}.
 %
 % If the \var{recordstatus} variable is set \var{true}, additional information