Debian Codegraph @

texmf-dist/doc/latex/l3kernel/l3news11.tex

raw
1 % Copyright 2017-2018 The LaTeX3 Project
2
3 \documentclass{ltnews}
4
5 \PassOptionsToPackage{colorlinks}{hyperref}
6
7 \usepackage{csquotes}
8 \usepackage{hologo}
9 \usepackage{ragged2e}
10 \usepackage{underscore}
11
12
13 %%% wrong in ltnews.cls ... so some tmp fix here at the moment:
14 \makeatletter
15 \renewcommand{\subsubsection}{%
16 \@startsection
17 {subsubsection}{2}{\leftmargini}{-1.5ex \@plus -1ex \@minus -.2ex}%
18 {1sp}{\@subheadingfont}%
19 }
20 \makeatother
21
22
23 \AtBeginDocument{%
24 \renewcommand*{\LaTeXNews}{\LaTeX3~News}%
25 \RaggedRight
26 \setlength\parindent{1em}%
27 }
28
29 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
30
31 \publicationmonth{February}
32 \publicationyear{2018}
33 \publicationissue{11}
34
35 % Avoid hyphenation of csnames
36 \makeatletter
37 \protected\edef\cs#1{%
38 \noexpand\path{\@backslashchar#1}%
39 }
40 \makeatother
41 \hyphenpenalty=10000 \exhyphenpenalty=10000
42
43 \begin{document}
44
45 \maketitle
46
47 \tableofcontents
48
49 \section{Move of sources from Subversion to Git}
50
51 The \LaTeX{} team have used a variety of version control systems over the life
52 of the \LaTeX3 sources. For a long time we maintained the \LaTeX3 sources in
53 Subversion (\texttt{svn}) but also provided a read-only clone of them on GitHub using
54 SubGit from TMate Software~\cite{SubGit} to synchronize the two
55 repositories---a solution that worked very well.
56
57 We have now retired the Subversion repository and completely moved over to Git,
58 with the master \LaTeX3 repository hosted on GitHub:
59 \url{https://github.com/latex3/latex3}. This new approach means we are (slowly)
60 adopting some new approaches to development, for example branches and accepting
61 pull requests.
62
63 \subsection{Version identifiers}
64
65 Following this change, we have removed Subversion \verb=$Id= lines from the
66 \LaTeX3 sources. At present, we will be retaining \cs{GetIdInfo} as there are
67 several possible use cases. The \LaTeX3 sources now have only release date
68 strings as identifiers. However, the team recommend that package authors
69 include version information directly in \cs{ProvidesExplPackage} (or similar)
70 lines.
71
72 \section{\pkg{expl3} updates and extensions}
73
74 Work has continued on the codebase over the last year, with both small
75 changes/fixes and more substantial changes taking place. The following sections
76 summarise some of the more notable changes.
77
78 \subsection{\pkg{l3sort} moves to the kernel}
79
80 Sorting is an important ability, and for some time the team have provided a
81 stand-alone \pkg{l3sort} to support this. The functionality has seen wide take
82 up, and so has now been integrated directly into the kernel. This took place in
83 parallel with some interface changes to \enquote{round out} the code.
84
85 \subsection{Boolean functions}
86
87 For some time, the team have been aware that boolean expressions can fail in
88 certain circumstances, leading to low-level errors. This is linked to two
89 features of the long-standing \cs{bool_if:n(TF)} function: expandable operation
90 and short-circuit evaluation.
91
92 Addressing that has meant two changes: altering \cs{bool_if:n(TF)} to
93 \emph{always} evaluate each part of the expression, and introducing new
94 short-circuit functions without the issue. The latter are \verb|lazy| in \pkg{expl3}
95 terms:
96 \begin{itemize}
97 \item \cs{bool_lazy_all:n(TF)}
98 \item \cs{bool_lazy_and:nn(TF)}
99 \item \cs{bool_lazy_any:n(TF)}
100 \item \cs{bool_lazy_or:nn(TF)}
101 \end{itemize}
102 These new, stable functions are now the recommended way of handling boolean
103 evaluations. Package authors are encouraged to employ these new functions as
104 appropriate.
105
106 \subsection{Revision of \pkg{l3file}}
107
108 Large parts of \pkg{l3file} have been revised to give a better separation of
109 path/file/extension. This has resulted in the addition of a number of new support
110 functions and variables.
111
112 At the same time, new experimental functions have been added to utilise a
113 number of useful primitives in \hologo{pdfTeX}{}: \cs{file_get_mdfive_hash:nN},
114 \cs{file_get_size:nN} and \cs{file_get_timestamp:nN}. Currently, \hologo{XeTeX}
115 does not support getting file size/timestamp information: this is available in
116 other engines.
117
118 Paralleling these changes, we have added (experimental) support for shell
119 escape to the \pkg{l3sys} module, most notably \cs{sys_shell_now:n}. A range of
120 test booleans are also available to check whether shell escape is enabled.
121
122 \subsection{Detection of \cs{cs_generate_variant:Nn} errors}
123
124 The ability to generate variants is an important feature of \pkg{expl3}. At
125 the same time, there are crucial aspects of this approach that can be
126 misunderstood by users. In particular, the requirement that variants map
127 correctly to an underlying \verb|N|- or \verb|n|-type base function is sometimes
128 misunderstood.
129
130 To help detect and correct these cases, \cs{cs_generate_variant:Nn} now
131 carries out error checking on its arguments, and raises a warning where
132 it is mis-applied. At present, the team have avoided making this an error
133 as it is likely to be seen by end users rather than directly by package
134 developers. In time, we are likely to revisit this and tighten up
135 further on this key requirement.
136
137 \subsection{Accessing random data}
138
139 To support randomised data selection, we have introduced a family of
140 experimental functions which use under\-lying engine support for random values,
141 and provide one entry at random from the data type.
142
143 At the same time, we have addressed some issues with uniformity stemming from
144 the random number function used by \hologo{pdfTeX}{} and inherited by other
145 engines. This means that \pkg{expl3}'s FPU will generate \emph{pseudo}-random
146 values across the range of possible outputs.
147
148 \subsection{More powerful debugging}
149
150 A new set of debugging functions have been added to the kernel. These allow
151 debug code to be enabled locally using the new option \verb|enable-debug| along
152 with functions \cs{debug_on:n} and \cs{debug_off:n}. Accompanying this change, we
153 have improved the handling of global/local consistency in variable setting.
154
155 \subsection{Mark-up changes in \pkg{l3doc}}
156
157 Since the introduction of the \verb|__| syntax to mark internal functions, the
158 need for explicit markup of internal material in sources has been negated.
159 As such, we have now dropped the requirement to mark internal material with
160 \verb|[aux]| when using \pkg{l3doc}. Instead, the status of functions and
161 variables is auto-detected from the presence of \verb|__|. For cases where
162 non-standard names are used for internal code, the mark-up \verb|[int]| is
163 retained, \emph{e.g.}
164 \begin{verbatim}
165 \begin{macro}[int]{\l@expl@enable@debug@bool}
166 \end{verbatim}
167
168 \newpage
169 \section{\pkg{l3build} updates}
170
171 Work on \pkg{l3build} has continued in parallel with \pkg{expl3} work, in
172 particular continuing to develop features to allow wider use of the tool.
173
174 Paralleling the move of the \LaTeX3 codebase to Git, \pkg{l3build} now has its
175 own separate Git repository: \url{https://github.com/latex3/l3build}. This will
176 enable us to involve other developers in the Lua code required for the build
177 system. At the same time, we have split the code into a number of small source
178 files, again to ease development both for the team ourselves and for potential
179 collaborators.
180
181 Another major change is that \pkg{l3build} can now retain the structure of
182 source repositories when creating a CTAN archive. Whilst the team favor `flat'
183 source setups, other users prefer structured approaches. Most notably, this
184 new \pkg{l3build} functionality means that it is now used to carry out
185 \pkg{beamer} releases.
186
187 The other major new feature is a new approach to multiple test setups, which
188 replaces the older \verb|--testfiledir| option. In the new approach, separate
189 configuration files are listed in the main \verb|build.lua| script, and can be
190 selected manually using a new \verb|--config| switch. This new approach allows
191 complex test setups to be run in a totally automated fashion, which is
192 important for kernel testing.
193
194 Some changes to the normalisation routines have been carried out, some to deal
195 with upcoming \hologo{LuaTeX} changes, others to address aspects which show up
196 only in some tests. This has required \verb|.tlg| updates in some cases: as far
197 as possible, we strive to avoid requiring changes to the reference files.
198
199 \begin{thebibliography}{10}
200 \raggedright
201 \bibitem{SubGit}
202 \emph{SubGit}, TMate Software, \url{https://subgit.com}
203 \bibitem{11:project-publications}
204 Links to various publications by members of the \LaTeX{} Project Team.
205 \newblock \url{https://www.latex-project.org/publications}
206 \end{thebibliography}
207
208 \end{document}