summaryrefslogtreecommitdiffstats
path: root/docs/docsite/rst/dev_guide/testing/sanity/no-illegal-filenames.rst
blob: 6e6f565eed899e37c5b02fc6361ef538e2129fcc (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
no-illegal-filenames
====================

Files and directories should not contain illegal characters or names so that
Ansible can be checked out on any Operating System.

Illegal Characters
------------------

The following characters are not allowed to be used in any part of the file or
directory name;

* ``<``
* ``>``
* ``:``
* ``"``
* ``/``
* ``\``
* ``|``
* ``?``
* ``*``
* Any characters whose integer representations are in the range from 0 through to 31 like ``\n``

The following characters are not allowed to be used as the last character of a
file or directory;

* ``.``
* ``" "`` (just the space character)

Illegal Names
-------------

The following names are not allowed to be used as the name of a file or
directory excluding the extension;

* ``CON``
* ``PRN``
* ``AUX``
* ``NUL``
* ``COM1``
* ``COM2``
* ``COM3``
* ``COM4``
* ``COM5``
* ``COM6``
* ``COM7``
* ``COM8``
* ``COM9``
* ``LPT1``
* ``LPT2``
* ``LPT3``
* ``LPT4``
* ``LPT5``
* ``LPT6``
* ``LPT7``
* ``LPT8``
* ``LPT9``

For example, the file ``folder/COM1``, ``folder/COM1.txt`` are illegal but
``folder/COM1-file`` or ``folder/COM1-file.txt`` is allowed.