summaryrefslogtreecommitdiff
path: root/support/pkgcheck/src/messages/warningsd.rs
blob: cea814c8cef23ddcf98132a9b7ab7f51621a6b21 (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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
// This file is generated by a Perl script. The source is
// in the docs/ directory of the repository.

pub fn w0001d() {
    println!(
        r#"
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.
"#
    )
}

pub fn w0002d() {
    println!(
        r#"
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.
"#
    )
}

pub fn w0003d() {
    println!(
        r#"
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 README, README.txt, README.md, Makefile, Makefile.in,
Makefile.am and makefile are ignored when checking.

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

pub fn w0004d() {
    println!(
        r#"
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.
"#
    )
}

pub fn w0005d() {
    println!(
        r#"
W0005 -- Very large file  with size <size> detected in package

(Experimental) We issue the message if there is a file is larger than
40MiB in the package directory tree.
"#
    )
}

pub fn w0006d() {
    println!(
        r#"
W0006 -- Very large file with size <size> detected in TDS zip archive

(Experimental) We issue the message if there is a file larger than 40MiB
in the TDS zip archive.
"#
    )
}

pub fn w0007d() {
    println!(
        r#"
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.
"#
    )
}

pub fn w0008d() {
    println!(
        r#"
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:

-   .bat
-   .cmd
-   .nsh, or
-   .reg
"#
    )
}