summaryrefslogtreecommitdiff
path: root/support/pkgcheck/docs/warningsd.tex
blob: 7b8c676e231b8031b7ce4583ce51352a7775f6cd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
\hypertarget{w0001----archive-as-package-file-detected}{%
\subsection{W0001 -\/- Archive as package file
detected}\label{w0001----archive-as-package-file-detected}}

Usually a CTAN package should not contain archives. An exception are
situations where, for example, the source code of a package is kept in a
separate zip archive.

\hypertarget{w0002----duplicate-files-detected}{%
\subsection{W0002 -\/- Duplicate files
detected}\label{w0002----duplicate-files-detected}}

Duplicate files were detected which are listed right after this message.

The message is a warning message as something like this could not be
seen as an error in general.

\hypertarget{w0003----same-named-files-detected-in-the-package-tree}{%
\subsection{W0003 -\/- Same named files detected in the package
tree}\label{w0003----same-named-files-detected-in-the-package-tree}}

We like to have unique file names over the whole package directory tree.
When we discover same named files we report it as a warning. Common
names like \texttt{README}, \texttt{README.txt}, \texttt{README.md},
\texttt{Makefile}, \texttt{Makefile.in}, \texttt{Makefile.am} and
\texttt{makefile} are ignored when checking.

For more details refer to:
\href{http://mirror.utexas.edu/ctan/help/ctan/CTAN-upload-addendum.html\#uniquefilenames}{http://mirror.utexas.edu/ctan/help/ctan/CTAN-upload-addendum.html\#uniquefilenames}

\hypertarget{w0004-----encoding-with-bom-detected}{%
\subsection{\texorpdfstring{W0004 -\/- encoding with BOM
detected}{W0004 -\/-  encoding with BOM detected}}\label{w0004-----encoding-with-bom-detected}}

A UTF encoded package file contains a BOM (byte order mark). Currently,
we issues a warning.

Nevertheless, the CTAN team discourages uses of BOM. Please be aware,
that in some future time this could be reagarded as an error.