diff options
author | Karl Berry <karl@freefriends.org> | 2024-05-27 19:30:08 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2024-05-27 19:30:08 +0000 |
commit | ab7200a827c60dd7e1684b60f79c1a60a1c0c5bc (patch) | |
tree | 7400ea9171470a2fb1d94f2ad9d2104addfac060 /Master/texmf-dist/doc | |
parent | 76576e2aa4eae12ccb2c8886d7a7c26091860173 (diff) |
l3build (27may24)
git-svn-id: svn://tug.org/texlive/trunk@71371 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r-- | Master/texmf-dist/doc/latex/l3build/CHANGELOG.md | 12 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/l3build/README.md | 2 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/l3build/l3build.pdf | bin | 750889 -> 750224 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/man/man1/l3build.1 | 154 | ||||
-rw-r--r-- | Master/texmf-dist/doc/man/man1/l3build.man1.pdf | bin | 15764 -> 16007 bytes |
5 files changed, 79 insertions, 89 deletions
diff --git a/Master/texmf-dist/doc/latex/l3build/CHANGELOG.md b/Master/texmf-dist/doc/latex/l3build/CHANGELOG.md index ea466dfcccd..f2231144d8b 100644 --- a/Master/texmf-dist/doc/latex/l3build/CHANGELOG.md +++ b/Master/texmf-dist/doc/latex/l3build/CHANGELOG.md @@ -7,6 +7,15 @@ this project uses date-based 'snapshot' version identifiers. ## [Unreleased] +## [2024-05-27] + +### Changed +- Respect `--rerun` in `doc` target (issue \#112) + +### Fixed +- Skip unknown engines correctly in `l3build save` +- Handling of environment settings in some cases (issue \#353) + ## [2024-02-08] ### Changed @@ -776,7 +785,8 @@ this project uses date-based 'snapshot' version identifiers. - Rationalise short option names: removed `-d`, `-E`, `-r` - Target `cmdcheck`: specific to LaTeX kernel work -[Unreleased]: https://github.com/latex3/l3build/compare/2024-02-08...HEAD +[Unreleased]: https://github.com/latex3/l3build/compare/2024-05-27...HEAD +[2024-05-27]: https://github.com/latex3/l3build/compare/2024-02-08...2024-05-27 [2024-02-08]: https://github.com/latex3/l3build/compare/2024-01-18...2024-02-08 [2024-01-18]: https://github.com/latex3/l3build/compare/2024-01-09...2024-01-18 [2024-01-09]: https://github.com/latex3/l3build/compare/2024-01-04...2024-01-09 diff --git a/Master/texmf-dist/doc/latex/l3build/README.md b/Master/texmf-dist/doc/latex/l3build/README.md index b5172bbf210..1b49dc0b0c2 100644 --- a/Master/texmf-dist/doc/latex/l3build/README.md +++ b/Master/texmf-dist/doc/latex/l3build/README.md @@ -1,7 +1,7 @@ l3build: a testing and building system for LaTeX ================================================= -Release 2024-02-08 +Release 2024-05-27 Overview -------- diff --git a/Master/texmf-dist/doc/latex/l3build/l3build.pdf b/Master/texmf-dist/doc/latex/l3build/l3build.pdf Binary files differindex af2c8688f0b..93f4b8f3abe 100644 --- a/Master/texmf-dist/doc/latex/l3build/l3build.pdf +++ b/Master/texmf-dist/doc/latex/l3build/l3build.pdf diff --git a/Master/texmf-dist/doc/man/man1/l3build.1 b/Master/texmf-dist/doc/man/man1/l3build.1 index b983494b73d..d42e486f3ca 100644 --- a/Master/texmf-dist/doc/man/man1/l3build.1 +++ b/Master/texmf-dist/doc/man/man1/l3build.1 @@ -1,91 +1,71 @@ -.TH l3build 1 "2024-02-08" +.TH L3BUILD 1 "2024-05-27" "LaTeX" + .SH NAME -l3build \- Checking and building packages +l3build + .SH SYNOPSIS -l3build <target> [<options>] [<names>] + Usage l3build <target> [<options>] [<names>] + .SH DESCRIPTION -The l3build system is a Lua script for building TeX packages, with particular -emphasis on regression testing. It is written in cross-platform Lua code, so -can be used by any modern TeX distribution with the texlua interpreter. A -package for building with l3build can be written in any TeX dialect; its -defaults are set up for LaTeX packages written in the DocStrip style. -.PP -The standard l3build targets are: -.IP check -Runs all automated tests -.IP clean -Cleans out directory tree -.IP ctan -Creates CTAN-ready archive -.IP doc -Typesets all documentation files -.IP install -Installs files into the local texmf tree -.IP manifest -Creates a manifest file -.IP save -Saves test validation log -.IP tag -Updates release tags in files -.IP uninstall -Uninstalls files from the local texmf tree -.IP unpack -Unpacks the source files into the build tree -.IP upload -Sends archive to CTAN for public release +------ + +The l3build module is designed to support the development of +high-quality LaTeX code by providing: +* A unit testing system +* Automated typesetting of code sources +* A reliable packaging system for CTAN releases + +The bundle consists of a Lua script to run the tasks and a +.tex file which provides the testing environment. These were +originally developed for supporting LaTeX development but +are designed such that they can be readily used by others. Full +documentation is provided. + +.SH COMMANDS +Valid targets are: + check Runs all automated tests + clean Cleans out directory tree + ctan Creates CTAN-ready archive + doc Typesets all documentation files + install Installs files into the local texmf tree + manifest Creates a manifest file + save Saves test validation log + tag Updates release tags in files + uninstall Uninstalls files from the local texmf tree + unpack Unpacks the source files into the build tree + upload Sends archive to CTAN for public release + .SH OPTIONS -Various options apply -.IP --config|-c -Sets the config(s) used for running tests -.IP --date -Sets the date to insert into sources -.IP --debug -Runs target in debug mode -.IP --dirty -Skips cleaning up the test area -.IP --dry-run -Dry run for install or upload -.IP --email -Email address of CTAN uploader -.IP --engine|-e -Sets the engine(s) to use for running test -.IP --epoch -Sets the epoch for tests and typesetting -.IP --file|-F -Takes the upload announcement from the given file -.IP --first -Name of first test to run -.IP --full -Installs all files -.IP --halt-on-error|-H -Stops running tests after the first failure -.IP --help|-h -Prints help message and exits -.IP --last -Name of last test to run -.IP --message|-m -Text for upload announcement message -.IP --quiet|-q -Suppresses TeX output when unpacking -.IP --rerun -Skips setup: simply reruns tests -.IP --show-log-on-error -Shows the full log of the failure with 'halt-on-error' -.IP --show-saves|-S -Shows the invocation to update failing .tlg files -.IP --shuffle -Shuffles order of tests -.IP --stdengine|-s -Run tests with the std engine (config dependent) -.IP --texmfhome -Location of user texmf tree -.IP --version -Prints version information and exits -.SH BUGS -.SH AUTHOR -The LaTeX Project (latex-team@latex-project.org) -.PP -Please log issues on the GitHub homepage: -https://github.com/latex3/l3build/issues. -.SH SEE ALSO -See l3build.pdf for more details. +Valid options are: + --config|-c Sets the config(s) used for running tests + --date Sets the date to insert into sources + --debug Runs target in debug mode + --dirty Skips cleaning up the test area + --dry-run Dry run for install or upload + --email Email address of CTAN uploader + --engine|-e Sets the engine(s) to use for running test + --epoch Sets the epoch for tests and typesetting + --file|-F Takes the upload announcement from the given file + --first Name of first test to run + --full Installs all files + --halt-on-error|-H Stops running tests after the first failure + --help|-h Prints this message and exits + --last Name of last test to run + --message|-m Text for upload announcement message + --quiet|-q Suppresses TeX output when unpacking + --rerun Skips setup: simply reruns tests + --show-log-on-error Shows the full log of the failure with 'halt-on-error' + --show-saves|-S Shows the invocation to update failing .tlg files + --shuffle Shuffles order of tests + --stdengine|-s Run tests with the std engine (config dependent) + --texmfhome Location of user texmf tree + --version Prints version information and exits + +.SH "SEE ALSO" +Full manual available via 'texdoc l3build'. + +Repository : https://github.com/latex3/l3build + +Bug tracker : https://github.com/latex3/l3build/issues +.SH AUTHORS +Copyright (C) 2014-2024 The LaTeX Project diff --git a/Master/texmf-dist/doc/man/man1/l3build.man1.pdf b/Master/texmf-dist/doc/man/man1/l3build.man1.pdf Binary files differindex 76bd5b2e58c..037e91e199d 100644 --- a/Master/texmf-dist/doc/man/man1/l3build.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/l3build.man1.pdf |