[latex3-commits] [latex3/l3build] main: Stick to third-person singular form in target and option docs (6963b00)
github at latex-project.org
github at latex-project.org
Thu Jan 11 13:48:54 CET 2024
Repository : https://github.com/latex3/l3build
On branch : main
Link : https://github.com/latex3/l3build/commit/6963b00356aa02dd55ce3f2224624eb7bdf7e90e
>---------------------------------------------------------------
commit 6963b00356aa02dd55ce3f2224624eb7bdf7e90e
Author: Yukai Chou <muzimuzhi at gmail.com>
Date: Fri Jan 5 22:23:29 2024 +0800
Stick to third-person singular form in target and option docs
>---------------------------------------------------------------
6963b00356aa02dd55ce3f2224624eb7bdf7e90e
l3build-arguments.lua | 20 ++++++++++----------
l3build-stdmain.lua | 8 ++++----
l3build.1 | 26 +++++++++++++-------------
l3build.dtx | 14 +++++++-------
4 files changed, 34 insertions(+), 34 deletions(-)
diff --git a/l3build-arguments.lua b/l3build-arguments.lua
index a1755d6..25f731b 100644
--- a/l3build-arguments.lua
+++ b/l3build-arguments.lua
@@ -54,7 +54,7 @@ option_list =
},
dirty =
{
- desc = "Skip cleaning up the test area",
+ desc = "Skips cleaning up the test area",
type = "boolean"
},
["dry-run"] =
@@ -80,7 +80,7 @@ option_list =
},
file =
{
- desc = "Take the upload announcement from the given file",
+ desc = "Takes the upload announcement from the given file",
short = "F",
type = "string"
},
@@ -91,13 +91,13 @@ option_list =
},
force =
{
- desc = "Force tests to run if engine is not set up",
+ desc = "Forces tests to run if engine is not set up",
short = "f",
type = "boolean"
},
full =
{
- desc = "Install all files",
+ desc = "Installs all files",
type = "boolean"
},
["halt-on-error"] =
@@ -108,7 +108,7 @@ option_list =
},
help =
{
- desc = "Print this message and exit",
+ desc = "Prints this message and exit",
short = "h",
type = "boolean"
},
@@ -131,23 +131,23 @@ option_list =
},
rerun =
{
- desc = "Skip setup: simply rerun tests",
+ desc = "Skips setup: simply rerun tests",
type = "boolean"
},
["show-log-on-error"] =
{
- desc = "Show the full log of the failure with 'halt-on-error'",
+ desc = "Shows the full log of the failure with 'halt-on-error'",
type = "boolean"
},
["show-saves"] =
{
- desc = "Show the invocation to update failing .tlg files",
+ desc = "Shows the invocation to update failing .tlg files",
short = "S",
type = "boolean"
},
shuffle =
{
- desc = "Shuffle order of tests",
+ desc = "Shuffles order of tests",
type = "boolean"
},
texmfhome =
@@ -157,7 +157,7 @@ option_list =
},
version =
{
- desc = "Print version information and exit",
+ desc = "Prints version information and exit",
type = "boolean"
}
}
diff --git a/l3build-stdmain.lua b/l3build-stdmain.lua
index d264a78..70d7560 100644
--- a/l3build-stdmain.lua
+++ b/l3build-stdmain.lua
@@ -73,19 +73,19 @@ target_list =
check =
{
bundle_target = true,
- desc = "Run all automated tests",
+ desc = "Runs all automated tests",
func = check,
},
clean =
{
bundle_func = bundleclean,
- desc = "Clean out directory tree",
+ desc = "Cleans out directory tree",
func = clean
},
ctan =
{
bundle_func = ctan,
- desc = "Create CTAN-ready archive",
+ desc = "Creates CTAN-ready archive",
func = ctan
},
doc =
@@ -142,7 +142,7 @@ target_list =
},
upload =
{
- desc = "Send archive to CTAN for public release",
+ desc = "Sends archive to CTAN for public release",
func = upload
},
}
diff --git a/l3build.1 b/l3build.1
index 47462ae..85e4154 100644
--- a/l3build.1
+++ b/l3build.1
@@ -12,11 +12,11 @@ defaults are set up for LaTeX packages written in the DocStrip style.
.PP
The standard l3build targets are:
.IP check
-Run all automated tests
+Runs all automated tests
.IP clean
-Clean out directory tree
+Cleans out directory tree
.IP ctan
-Create CTAN-ready archive
+Creates CTAN-ready archive
.IP doc
Typesets all documentation files
.IP install
@@ -32,7 +32,7 @@ Uninstalls files from the local texmf tree
.IP unpack
Unpacks the source files into the build tree
.IP upload
-Send archive to CTAN for public release
+Sends archive to CTAN for public release
.SH OPTIONS
Various options apply
.IP --config|-c
@@ -42,7 +42,7 @@ Sets the date to insert into sources
.IP --debug
Runs target in debug mode
.IP --dirty
-Skip cleaning up the test area
+Skips cleaning up the test area
.IP --dry-run
Dry run for install or upload
.IP --email
@@ -52,17 +52,17 @@ Sets the engine(s) to use for running test
.IP --epoch
Sets the epoch for tests and typesetting
.IP --file|-F
-Take the upload announcement from the given file
+Takes the upload announcement from the given file
.IP --first
Name of first test to run
.IP --force|-f
Force tests to run if engine is not set up
.IP --full
-Install all files
+Installs all files
.IP --halt-on-error|-H
Stops running tests after the first failure
.IP --help|-h
-Print help message and exit
+Prints help message and exit
.IP --last
Name of last test to run
.IP --message|-m
@@ -70,17 +70,17 @@ Text for upload announcement message
.IP --quiet|-q
Suppresses TeX output when unpacking
.IP --rerun
-Skip setup: simply rerun tests
+Skips setup: simply rerun tests
.IP --show-log-on-error
-Show the full log of the failure with 'halt-on-error'
+Shows the full log of the failure with 'halt-on-error'
.IP --show-saves|-S
-Show the invocation to update failing .tlg files
+Shows the invocation to update failing .tlg files
.IP --shuffle
-Shuffle order of tests
+Shuffles order of tests
.IP --texmfhome
Location of user texmf tree
.IP --version
-Print version information and exit
+Prints version information and exit
.SH BUGS
.SH AUTHOR
The LaTeX Project (latex-team at latex-project.org)
diff --git a/l3build.dtx b/l3build.dtx
index e02dfd6..1aa432a 100644
--- a/l3build.dtx
+++ b/l3build.dtx
@@ -371,15 +371,15 @@
% \item |--config| (|-c|) Configuration(s) to use for testing
% \item |--date| Date to use when tagging data
% \item |--debug| Runs the target in debug mode (not supported by all targets)
-% \item |--dirty| Skip cleaning up of the test area
+% \item |--dirty| Skips cleaning up of the test area
% \item |--dry-run| Runs the \texttt{install} target but does not copy
% any files: simply lists those that would be installed
% \item |--email| Sets the email address for CTAN upload
% \item |--engine| (|-e|) Sets the engine to use for testing
% \item |--epoch| Sets the epoch for typesetting and testing
-% \item |--file| (|-F|) Take the upload announcement from the given file
+% \item |--file| (|-F|) Takes the upload announcement from the given file
% \item |--first| Name of the first test to run
-% \item |--force| (|-f|) Force checks to run even if sanity
+% \item |--force| (|-f|) Forces checks to run even if sanity
% checks fail, \emph{e.g.}~when |--engine| is not given in
% \var{checkengines}
% \item |--full| Instructs the \texttt{install} target to include the
@@ -390,12 +390,12 @@
% \item |--last| Name of the last test to run
% \item |--message| (|-m|) Text for upload announcement
% \item |--quiet| (|-q|) Suppresses output from unpacking
-% \item |--rerun| Run tests without unpacking/set up
+% \item |--rerun| Runs tests without unpacking/set up
% \item |--show-log-on-error| To be used in addition to \texttt{--halt-on-error} and results
% in the full \texttt{.log} file of a failed test to be shown on the console
-% \item |--show-saves| (|-S|) When tests fail, print the \texttt{l3build save} commands needed
+% \item |--show-saves| (|-S|) When tests fail, prints the \texttt{l3build save} commands needed
% to regenerate the tests assuming that the failures were false negatives.
-% \item |--shuffle| Shuffle the order in which tests run
+% \item |--shuffle| Shuffles the order in which tests run
% \item |--texmfhome| Sets the location of the user tree for installing
% \end{itemize}
%
@@ -591,7 +591,7 @@
% \end{buildcmd}
%
% \begin{buildcmd}{tag [\meta{tag name}]}
-% Apply the Lua |update_tag()| function to modify the contents of files specified by |tagfiles| to update the `release tag' (or package version) and date.
+% Applies the Lua |update_tag()| function to modify the contents of files specified by |tagfiles| to update the `release tag' (or package version) and date.
% The tag is given as the optional command line argument \meta{tag name} and the date using
% |--date| (or |-d|). If not given, the date will default to the current date in
% ISO format (YYYY-MM-DD). If no \meta{tag name} is given, the tag will default to |nil|.
More information about the latex3-commits
mailing list.