diff options
author | Norbert Preining <norbert@preining.info> | 2020-01-18 03:01:23 +0000 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2020-01-18 03:01:23 +0000 |
commit | 22d3a7ddeb2b2637308cf883f9bd3590e649aa20 (patch) | |
tree | e5887f868c532734a8cac1c7833f5492370effb5 /support/pkgcheck/docs | |
parent | e71ffee2103e3f137bbc9ee526858bc277e95908 (diff) |
CTAN sync 202001180301
Diffstat (limited to 'support/pkgcheck/docs')
-rw-r--r-- | support/pkgcheck/docs/errorsd.tex | 67 | ||||
-rw-r--r-- | support/pkgcheck/docs/fatald.tex | 8 | ||||
-rw-r--r-- | support/pkgcheck/docs/informationd.tex | 10 | ||||
-rw-r--r-- | support/pkgcheck/docs/pkgcheck.pdf | bin | 66749 -> 70100 bytes | |||
-rw-r--r-- | support/pkgcheck/docs/title.tex | 2 | ||||
-rw-r--r-- | support/pkgcheck/docs/warningsd.tex | 27 |
6 files changed, 82 insertions, 32 deletions
diff --git a/support/pkgcheck/docs/errorsd.tex b/support/pkgcheck/docs/errorsd.tex index 25a68c1d79..e3e9cc9b5f 100644 --- a/support/pkgcheck/docs/errorsd.tex +++ b/support/pkgcheck/docs/errorsd.tex @@ -33,7 +33,8 @@ file but it isn't. allowed}\label{e0004----empty-directory-not-allowed}} Empty directories are considered as rubbish, and are usually not -accepted as part of a package. +accepted as part of a package, neither in the package tree nor in the +TDS zip archive. For more details refer to: \href{http://mirror.ctan.org/help/ctan/CTAN-upload-addendum.html\#noemptyfiles}{http://mirror.ctan.org/help/ctan/CTAN-upload-addendum.html\#noemptyfiles} @@ -52,7 +53,8 @@ For more details refer to: \subsection{E0006 -\/- Hidden directories not allowed}\label{e0006----hidden-directories-not-allowed}} -A package should not contain hidden directories. +A package should not contain hidden directories, neither in the package +tree nor in the TDS zip archive. For more details refer to: \href{http://mirror.ctan.org/help/ctan/CTAN-upload-addendum.html\#noauxfiles}{http://mirror.ctan.org/help/ctan/CTAN-upload-addendum.html\#noauxfiles} @@ -61,7 +63,8 @@ For more details refer to: \subsection{E0007 -\/- Hidden files not allowed}\label{e0007----hidden-files-not-allowed}} -A package should not contain hidden files. +A package should not contain hidden files, neither in the package tree +nor in the TDS zip archive. For more details refer to: \href{http://mirror.ctan.org/help/ctan/CTAN-upload-addendum.html\#noauxfiles}{http://mirror.ctan.org/help/ctan/CTAN-upload-addendum.html\#noauxfiles} @@ -188,34 +191,6 @@ files if they are in a different directory in the package. For more details refer to: \href{http://mirror.ctan.org/help/ctan/CTAN-upload-addendum.html\#nogeneratedfiles}{http://mirror.ctan.org/help/ctan/CTAN-upload-addendum.html\#nogeneratedfiles} -\hypertarget{e0020----unwanted-directory-detected-in-the-top-level-directory-in-tds-zip-archive}{% -\subsection{E0020 -\/- Unwanted directory detected in the top level -directory in TDS zip -archive}\label{e0020----unwanted-directory-detected-in-the-top-level-directory-in-tds-zip-archive}} - -A top level directory of a TDS archive should only contain all or some -of the following directories: - -\begin{itemize} -\tightlist -\item - \texttt{tex} -\item - \texttt{fonts} -\item - \texttt{metafont} -\item - \texttt{metapost} -\item - \texttt{bibtex} -\item - \texttt{scripts} -\item - \texttt{doc} -\item - \texttt{source} -\end{itemize} - \hypertarget{e0021----error-when-reading-a-file}{% \subsection{E0021 -\/- Error when reading a file}\label{e0021----error-when-reading-a-file}} @@ -337,3 +312,33 @@ directory tree}\label{e0035----unwanted-tds-archive-detected-in-package-directory-tree}} A package directory should not contain a TDS zip archive. + +\hypertarget{e0036----dtxins-files-found-in-wrong-directory-in-tds-zip-archive}{% +\subsection{E0036 -\/- .dtx/.ins files found in wrong directory in TDS +zip +archive}\label{e0036----dtxins-files-found-in-wrong-directory-in-tds-zip-archive}} + +In a TDS zip archive a \texttt{.dtx} resp. \texttt{.ins} file must be in +a subdirectory of either of \texttt{source/} or \texttt{doc/} top level +directories. + +\hypertarget{e0037----cr-line-endings-detected}{% +\subsection{E0037 -\/- CR line endings +detected}\label{e0037----cr-line-endings-detected}} + +The file specified in the error message contains CR line endings. Text +files should have UNIX style line endings. + +For more details refer to: +\href{http://mirror.ctan.org/help/ctan/CTAN-upload-addendum.html\#crlf}{http://mirror.ctan.org/help/ctan/CTAN-upload-addendum.html\#crlf} + +\hypertarget{e0038----file-has-inconsistent-line-endings-cr-x-lf-y-crlf-z}{% +\subsection{E0038 -\/- File has inconsistent line endings: CR: x, LF: y, +CRLF: +z}\label{e0038----file-has-inconsistent-line-endings-cr-x-lf-y-crlf-z}} + +The file specified in the error message contains CR line endings. Text +files should have UNIX style line endings. + +For more details refer to: +\href{http://mirror.ctan.org/help/ctan/CTAN-upload-addendum.html\#crlf}{http://mirror.ctan.org/help/ctan/CTAN-upload-addendum.html\#crlf} diff --git a/support/pkgcheck/docs/fatald.tex b/support/pkgcheck/docs/fatald.tex index b4c175a7c0..ef26ff30cf 100644 --- a/support/pkgcheck/docs/fatald.tex +++ b/support/pkgcheck/docs/fatald.tex @@ -37,3 +37,11 @@ Exiting...}\label{f0006----unknown-error-code-specified-with-option--e-resp----e \texttt{pkgcheck} was called with option \texttt{-e} resp. \texttt{-\/-explain}, and an unknown error code was specified. + +\hypertarget{f0007----could-not-create-temporary-directory-for-unzipping-the-tds-zip-archive}{% +\subsection{F0007 -\/- Could not create temporary directory for +unzipping the TDS zip +archive}\label{f0007----could-not-create-temporary-directory-for-unzipping-the-tds-zip-archive}} + +Make sure the temp directory is writable and/or the temp directory has +enough space. diff --git a/support/pkgcheck/docs/informationd.tex b/support/pkgcheck/docs/informationd.tex index 88a2305f48..b1a870ebba 100644 --- a/support/pkgcheck/docs/informationd.tex +++ b/support/pkgcheck/docs/informationd.tex @@ -49,3 +49,13 @@ temporary file endings and their meanings. For more details refer to: \href{http://mirror.ctan.org/help/ctan/CTAN-upload-addendum.html\#noauxfiles}{http://mirror.ctan.org/help/ctan/CTAN-upload-addendum.html\#noauxfiles} + +\hypertarget{i0007----successfully-corrected-wrong-line-endings-to-lf-resp-crlf}{% +\subsection{I0007 -\/- Successfully corrected wrong line endings to LF +resp. +CRLF}\label{i0007----successfully-corrected-wrong-line-endings-to-lf-resp-crlf}} + +\texttt{pkgcheck} successfully converted wrong line endings to LF line +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. diff --git a/support/pkgcheck/docs/pkgcheck.pdf b/support/pkgcheck/docs/pkgcheck.pdf Binary files differindex 87d258b13d..5949a88fed 100644 --- a/support/pkgcheck/docs/pkgcheck.pdf +++ b/support/pkgcheck/docs/pkgcheck.pdf diff --git a/support/pkgcheck/docs/title.tex b/support/pkgcheck/docs/title.tex index 9961a041b9..1b5df7c036 100644 --- a/support/pkgcheck/docs/title.tex +++ b/support/pkgcheck/docs/title.tex @@ -1 +1 @@ -\title{pkgcheck Utility, v1.9.0} +\title{pkgcheck Utility, v2.0.0} diff --git a/support/pkgcheck/docs/warningsd.tex b/support/pkgcheck/docs/warningsd.tex index 7189f196e1..416661ff00 100644 --- a/support/pkgcheck/docs/warningsd.tex +++ b/support/pkgcheck/docs/warningsd.tex @@ -53,3 +53,30 @@ archive}{W0006 -\/- Very large file with size \textless size\textgreater{} detec (Experimental) We issue the message if there is a file larger than 40MiB in the TDS zip archive. + +\hypertarget{w0007----empty-directory-detected-in-the-tds-zip-archive}{% +\subsection{W0007 -\/- Empty directory detected in the TDS zip +archive}\label{w0007----empty-directory-detected-in-the-tds-zip-archive}} + +Empty directories in a TDS zip archive are discouraged. As they usually +don't create errors in the distribution we issue a warning only. + +\hypertarget{w0008----windows-file-has-unix-line-endings}{% +\subsection{W0008 -\/- Windows file has Unix line +endings}\label{w0008----windows-file-has-unix-line-endings}} + +A Windows file with Unix line endings was detected. + +We regard a file as a Windows file if its name ends with: + +\begin{itemize} +\tightlist +\item + \texttt{.bat} +\item + \texttt{.cmd} +\item + \texttt{.nsh}, or +\item + \texttt{.reg} +\end{itemize} |