[latex3-commits] [git/LaTeX3-latex3-latex2e] firstaid: more documentation updates (6aa10312)

[Frank Mittelbach]

Repository : https://github.com/latex3/latex2e
On branch  : firstaid
Link       : https://github.com/latex3/latex2e/commit/6aa103129d9418387997c8136988c300dbbd916e

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

commit 6aa103129d9418387997c8136988c300dbbd916e
Author: Frank Mittelbach <frank.mittelbach at latex-project.org>
Date:   Sun Sep 27 21:55:15 2020 +0200

    more documentation updates


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

6aa103129d9418387997c8136988c300dbbd916e
 required/firstaid/README.md                         | 11 ++++++++---
 required/firstaid/changes.txt                       |  7 +++++++
 .../latex2e-first-aid-for-external-files.dtx        | 21 ++++++++++++++++++---
 3 files changed, 33 insertions(+), 6 deletions(-)

diff --git a/required/firstaid/README.md b/required/firstaid/README.md
index 0374aeed..a9a762e4 100644
--- a/required/firstaid/README.md
+++ b/required/firstaid/README.md
@@ -1,4 +1,9 @@
-# LaTeX2e-temporary-external-fixes
-LaTeX2e kernel code that temporarily adjusts packages that are not yet updated and therefore fail.
+# LaTeX2e temporary first aid for external packages and classes during transition periods
 
-This is stored in a separate file external to the base bundle, so that it can be easily updated when fixes become available without the need to upload a full new LaTeX2e release to CTAN.
+LaTeX2e kernel code that temporarily adjusts packages that are not yet
+updated and therefore fail if a new LaTeX release updates internal
+commands (which have been used in the external packages)
+
+This is stored in a separate file external to the base bundle, so that
+it can be easily updated when fixes become available without the need
+to upload a full new LaTeX2e release to CTAN.
diff --git a/required/firstaid/changes.txt b/required/firstaid/changes.txt
index e69de29b..472f752e 100644
--- a/required/firstaid/changes.txt
+++ b/required/firstaid/changes.txt
@@ -0,0 +1,7 @@
+2020-09-27  Frank Mittelbach  <Frank.Mittelbach at latex-project.org>
+
+	* latex2e-first-aid-for-external-files.dtx:
+	Initial version for 2020-10-01 release containing first aid
+	for packages bidi, filehook and class dinbrief.
+
+
diff --git a/required/firstaid/latex2e-first-aid-for-external-files.dtx b/required/firstaid/latex2e-first-aid-for-external-files.dtx
index dcdda090..d7d3d7b4 100644
--- a/required/firstaid/latex2e-first-aid-for-external-files.dtx
+++ b/required/firstaid/latex2e-first-aid-for-external-files.dtx
@@ -37,9 +37,9 @@
 %
 %
 % \begin{abstract}
-%    The file provided contains some first aid for packages that
-%    requiring updates because of internal changes to \LaTeX{} that
-%    aren't yet reflected in the package code.
+%    This file contains some first aid for packages or classes that
+%    require updates because of internal changes to \LaTeX{} but that
+%    aren't yet reflected in the package/class code.
 % \end{abstract}
 %
 % \tableofcontents
@@ -71,6 +71,21 @@
 %    empty. In practice it will probably always contain one or the
 %    other fix while we are waiting for the package to get updated.
 %
+%    \begin{quote} \textbf{Important notice:} The fixes provided here
+%    are not meant to be a permanent solution, but are only provided
+%    to support the transition period. They are (usually) neither
+%    complete nor necessarily the best solution! Furthermore, as they
+%    are done from the ``outside'', they usually add some burden and
+%    slow down \LaTeX{} processing, even if the package/class is not
+%    used in the document.
+
+%    We will therefore remove such code as soon as possible
+%    again. In practice this means that if some package never gets
+%    updated/corrected, then it will eventually fail to work, because
+%    after one or at most two \LaTeX{} releases we will take out the
+%    transition code to ensure that this ``first aid patching''
+%    doesn't get out of bounds.
+%    \end{quote}
 %
 % \StopEventually{\setlength\IndexMin{200pt}  \PrintIndex  }
 %