[latex3-commits] [git/LaTeX3-latex3-latex2e] develop: some option renames for filecontents; more docu in ltnews (349cdbb2)
Frank Mittelbach
frank.mittelbach at latex-project.org
Wed Sep 11 23:07:11 CEST 2019
Repository : https://github.com/latex3/latex2e
On branch : develop
Link : https://github.com/latex3/latex2e/commit/349cdbb2b3d19c4862e1ac7bb54bd88ee05f3ed6
>---------------------------------------------------------------
commit 349cdbb2b3d19c4862e1ac7bb54bd88ee05f3ed6
Author: Frank Mittelbach <frank.mittelbach at latex-project.org>
Date: Wed Sep 11 23:07:11 2019 +0200
some option renames for filecontents; more docu in ltnews
>---------------------------------------------------------------
349cdbb2b3d19c4862e1ac7bb54bd88ee05f3ed6
base/doc/ltnews30.tex | 122 +++++++++++++++++++++++++++++---
base/ltclass.dtx | 16 +++--
base/testfiles/tlb-filecontents-001.lvt | 2 +-
3 files changed, 122 insertions(+), 18 deletions(-)
diff --git a/base/doc/ltnews30.tex b/base/doc/ltnews30.tex
index 8b72252e..3f3420a5 100644
--- a/base/doc/ltnews30.tex
+++ b/base/doc/ltnews30.tex
@@ -11,7 +11,7 @@
% conditions of the LaTeX Project Public License, either version 1.3c
% of this license or (at your option) any later version.
% The latest version of this license is in
-% http://www.latex-project.org/lppl.txt
+% https://www.latex-project.org/lppl.txt
% and version 1.3c or later is part of all distributions of LaTeX
% version 2008 or later.
%
@@ -46,6 +46,8 @@
\providecommand\XeTeX{\hologo{XeTeX}}
\providecommand\LuaTeX{\hologo{LuaTeX}}
\providecommand\pdfTeX{\hologo{pdfTeX}}
+\providecommand\MiKTeX{\hologo{MiKTeX}}
+\providecommand\TL{\TeX{}Live}
\providecommand\githubissue[2][]{\ifhmode\unskip\fi
\quad\penalty500\strut\nobreak\hfill
@@ -124,7 +126,7 @@
\setlength\rightskip{0pt plus 3em}
-\bigskip
+\newpage
\section{Introduction}
@@ -133,7 +135,84 @@ This document is under construction \ldots
\section{\LaTeX\texttt{-dev} formats now available}
-\emph{describe}
+
+We know that many of you, especially developers and maintainers of
+important packages, have a strong interest in a stable \LaTeX{}
+environment.
+
+In order to keep \LaTeX{} very stable for users whilst allowing for
+further development to continue, we now have a development branch of
+\LaTeX{} on GitHub containing development code for the upcoming
+release. When this code is ready for wider consumption and testing, we
+generate a pre-release of \LaTeX{} from this development branch and make
+it available on CTAN.
+
+For users of the \TL{} and \MiKTeX{} distributions it is therefore now
+straightforward to test their documents and code against the upcoming
+\LaTeX{} release with ease, simply by selecting a different program name
+(when using the command line) or by selecting a menu entry (after
+setting it up, see below).
+
+If you do this then the latest version of the \LaTeX{} development format
+will be used to process your document, allowing you to test the
+upcoming release with your own documents and packages. For example, if
+you run
+\begin{verbatim}
+ pdflatex-dev myfile
+\end{verbatim}
+then you will be greeted on the screen with something like \texttt{LaTeX2e
+ <2019-10-01> pre-release-2} (identifying the pre-release format)
+instead of the normal \texttt{LaTeX2e <2018-12-01>}. In this
+pre-release you will find the latest new features that we have
+developed.
+
+\subsection{Our hopes}
+
+We don’t expect everybody to start using the development formats to
+participate in testing, but we hope that people with a strong interest
+in a stable \LaTeX{} environment (especially developers and maintainers
+of important packages) will use the new facilities and help us to
+ensure that future public releases of \LaTeX{} do not (as has happened in
+the past) require some immediate patches because of issues that were
+not identified by our internal regression test suite or by other
+testing that we do.
+
+Any issue identified when using the development format should
+preferably be logged as an issue on GitHub, following the procedure
+outlined on our website at \url{https://www.latex-project.org/bugs/}
+including the use of the \pkg{latexbug} package as described.
+
+Our bug reporting process normally states that issues involving
+third-party software are out of scope as we can’t correct external
+packages, see~\cite{30:Mittelbach:TB39-1}. However, in the particular
+case of the development format showing an incompatibility with a
+third-party package, it is fine to open an issue with us (in addition,
+please, to informing the maintainer of that package) so that we know
+about the problem and can jointly work on resolving it.
+
+\subsection{Details please \ldots}
+
+More details and some background information about the concepts and
+the process is available in an upcoming TUGboat article: \enquote{The
+ \LaTeX{} release workflow and the \LaTeX{} dev
+ formats}~\cite{devformat}.
+
+\subsection{Setting up menu items}
+
+While the command line call works out of the box if you have a recent
+uptodate \TL{} or \MiKTeX{} installation, the use within an integrated
+editing environment doesn’t at this point in time (maybe the
+developers of these editors will include it in the future). However,
+it is normally fairly simple to enable it as most (or even all?) of
+them provide simple ways to call your own setup. How this works in
+detail depends very much on the environment you use, so we can’t give
+much help here.
+
+But as an example: to provide an additional menu entry for
+\texttt{XeLaTeX-dev} on a MacBook all that was necessary was to copy
+the file \texttt{XeLaTeX.engine} to XeLaTeX-dev.engine and change the
+call from \texttt{xelatex} to \texttt{xelatex-dev} inside.
+
@@ -182,15 +261,16 @@ of missing font support can be used.
The \env{filecontents} environment now supports an optional argument
in which you can specify that it is allowed to \option{overwrite} an
already existing file, by default nothing is written if the file
-exists anywhere in the search tree. The environment will refuse to
-write to \cs{jobname}\texttt{.tex} to avoid clobbering its own input
+exists anywhere in the search tree. An alternative name for this
+option is \texttt{force}. Even then the environment will refuse to write
+to \cs{jobname}\texttt{.tex} to avoid clobbering its own input
file. However, if you use a different extension on your input file you
could still overwrite it (there is no way to test for that).
With the option \option{nosearch} only the current directory is
examined not the \TeX{} tree. This is useful if you want to write a
local copy of an standard system file.
-Finally, \option{nopreamble} prevents writing a preamble to the file
+Finally, \option{noheader} prevents writing a preamble to the file
(which is the same as using the star form of the environment.
The environment ins now allowed anywhere in the document which means
@@ -307,14 +387,24 @@ additional packages.
\subsection{Improve wording of a warning message}
-\emph{write}
+\emph{write} The kernel now says \enquote{Trying to load \ldots}
+instead of \enquote{Try loading \ldots} in one of its informal
+messages to match style of similar messages.
\githubissue{107}
\subsection{Avoid \cs{DeclareErrorFont} side effects}
-\emph{write}
+As a side effect of setting up the error font for NFSS that
+declaration also change the current font back to 10pt size. In most
+circumstances that doesn't matter, because that declaration was meant
+to be used only during the early stages of a \LaTeX{} run.
+
+However, I turned out that it was also used in other places
+(incorrectly actually, e.g., inside some \texttt{.fd} files) and there
+the size reset caused havoc in seemingly random places. The command
+has now change to not produce such side effects.
\gnatsissue{latex}{4399}
@@ -423,11 +513,23 @@ package.
\begin{thebibliography}{9}
-\bibitem{29:site-doc}
+\bibitem{30:Mittelbach:TB39-1} Frank Mittelbach:
+ \emph{New rules for reporting bugs in the \LaTeX{} core software}.
+ In: TUGboat, 39\#1, 2018.
+ \url{https://latex-project.org/publications/}
+
+
+\bibitem{devformat} Frank Mittelbach:
+ \emph{The
+ \LaTeX{} release workflow and the \LaTeX{} dev formats}.
+ In: TUGboat, 40\#2, 2019.
+ \url{https://latex-project.org/publications/}
+
+\bibitem{30:site-doc}
\emph{\LaTeX{} documentation on the \LaTeX{} Project Website}.\\
\url{https://latex-project.org/documentation/}
-\bibitem{29:site-pub}
+\bibitem{30:site-pub}
\emph{\LaTeX{} Project publications on the \LaTeX{} Project Website}.\\
\url{https://latex-project.org/publications/}
diff --git a/base/ltclass.dtx b/base/ltclass.dtx
index 0576acb5..3d199717 100644
--- a/base/ltclass.dtx
+++ b/base/ltclass.dtx
@@ -156,7 +156,7 @@
% some comments about how it was produced.
%
% The package can also be called with an optional argument which is
-% used to alter some of its behavior: option
+% used to alter some of its behavior: option \texttt{force} or
% \texttt{overwrite} will allow for overwriting existing files,
% option \texttt{nosearch} will only check the current directory
% when looking if the file exists. This can be useful if you want to
@@ -1754,20 +1754,21 @@
\csname filec at ntents@\@tempa\endcsname
\else
\@latex at error{Unknown filecontents option #1}%
- {Valid options are overwrite, nosearch, nopreamble}%
+ {Valid options are force (or overwrite), nosearch, noheader}%
\fi}%
\filec at ntents
}
% \end{macrocode}
-% Option \texttt{overwrite} changes the
+% Option \texttt{force}) (or \texttt{overwrite}) changes the
% overwriting switch
% \begin{macrocode}
-\let\filec at ntents@overwrite\@fileswfalse
+\let\filec at ntents@force\@fileswfalse
+\let\filec at ntents@overwrite\@fileswfalse % alternative name
% \end{macrocode}
-% and option \texttt{nopreamble} the preamble switch (which is
+% and option \texttt{noheader} the preamble switch (which is
% equivalent to using the star form of the environment).
% \begin{macrocode}
-\let\filec at ntents@nopreamble\@tempswafalse
+\let\filec at ntents@noheader\@tempswafalse
% \end{macrocode}
% Option \texttt{nosearch} only checks the current directory not
% the how \TeX{} tree for the existence of the file to write.
@@ -1959,8 +1960,9 @@
%<latexrelease> {\filec at ntents}{Spaces in file names + optional arg}%
%<latexrelease>
%<latexrelease>\let\filec at ntents@opt \@undefined
+%<latexrelease>\let\filec at ntents@force \@undefined
%<latexrelease>\let\filec at ntents@overwrite \@undefined
-%<latexrelease>\let\filec at ntents@nopreamble \@undefined
+%<latexrelease>\let\filec at ntents@noheader \@undefined
%<latexrelease>\let\filec at ntents@nosearch \@undefined
%<latexrelease>\let\filec at ntents@checkdir \@undefined
%<latexrelease>\let\filec at ntents@where \@undefined
diff --git a/base/testfiles/tlb-filecontents-001.lvt b/base/testfiles/tlb-filecontents-001.lvt
index b1d7aff7..719472a2 100644
--- a/base/testfiles/tlb-filecontents-001.lvt
+++ b/base/testfiles/tlb-filecontents-001.lvt
@@ -38,7 +38,7 @@
\begin{document}
\TIMO
-\begin{filecontents}[nopreamble,overwrite]{\jobname.txt}
+\begin{filecontents}[noheader,force]{\jobname.txt}
\typeout{4th write: no preamble this time}
\end{filecontents}
More information about the latex3-commits
mailing list