summaryrefslogtreecommitdiff
path: root/support/pkgcheck/docs/informationd.tex
diff options
context:
space:
mode:
Diffstat (limited to 'support/pkgcheck/docs/informationd.tex')
-rw-r--r--support/pkgcheck/docs/informationd.tex44
1 files changed, 41 insertions, 3 deletions
diff --git a/support/pkgcheck/docs/informationd.tex b/support/pkgcheck/docs/informationd.tex
index cc53641fc7..80e68f0255 100644
--- a/support/pkgcheck/docs/informationd.tex
+++ b/support/pkgcheck/docs/informationd.tex
@@ -29,9 +29,9 @@ like) line endings.
For more details refer to:
\url{http://mirror.ctan.org/help/ctan/CTAN-upload-addendum.html\#crlf}
-\hypertarget{i0005----corrections-permissions-for-file-or-directory}{%
-\subsection{I0005 -\/- Corrections permissions for file or
-directory}\label{i0005----corrections-permissions-for-file-or-directory}}
+\hypertarget{i0005----correcting-permissions-for-file-or-directory}{%
+\subsection{I0005 -\/- Correcting permissions for file or
+directory}\label{i0005----correcting-permissions-for-file-or-directory}}
\texttt{pkgcheck} corrects wrong permsissions for package files and
directories. It runs the \texttt{chmod} command in verbose mode.
@@ -59,3 +59,41 @@ CRLF}\label{i0007----successfully-corrected-wrong-line-endings-to-lf-resp-crlf}}
endings or to CRLF line endings if it the file was a Windows text file.
Wrong line endings could be CR, CRLF or a mixture of line endings.
+
+\hypertarget{i0008----using-config-file-}{%
+\subsection{\texorpdfstring{I0008 -\/- Using config file
+}{I0008 -\/- Using config file }}\label{i0008----using-config-file-}}
+
+Tells the user which config file is used.
+
+\hypertarget{i0009----updating-entry-pkgname---tpkg-with-pkgname---new-tpkg-from-config-file}{%
+\subsection{\texorpdfstring{I0009 -\/- Updating entry
+\texttt{\textless{}pkgname\textgreater{}} -\textgreater{}
+\texttt{\textless{}tpkg\textgreater{}} with
+\texttt{\textless{}pkgname\textgreater{}} -\textgreater{}
+\texttt{\textless{}new\ tpkg\textgreater{}} from config
+file",}{I0009 -\/- Updating entry \textless pkgname\textgreater{} -\textgreater{} \textless tpkg\textgreater{} with \textless pkgname\textgreater{} -\textgreater{} \textless new tpkg\textgreater{} from config file",}}\label{i0009----updating-entry-pkgname---tpkg-with-pkgname---new-tpkg-from-config-file}}
+
+This message can only show up if \texttt{pkgcheck} got called with
+\texttt{-\/-config}. It is required that the path names in the TDS zip
+archive contain the package name. There are exceptions however, and if
+such an exception is defined in the config file \texttt{pkgcheck}
+reports the usage of an exception.
+
+Example: \texttt{tex/latex/microtype/microtype-luatex.de} in the TDS zip
+archive \texttt{microtype.tds.zip} contains the package name
+\texttt{microtype}
+
+There are exceptions, however.
+
+Example: The file names in \texttt{latex-amsmath.tds.zip} do not contain
+\texttt{latex-amsmath} but just \texttt{latex}
+
+These exceptions are hard-coded in pkgcheck but can be overridden in the
+\texttt{pkgcheck.yml} config file like in the following example
+
+\begin{verbatim}
+tds_path_exceptions:
+ - pkg: latex-amsmath
+ tpkg: latexnew
+\end{verbatim}