diff options
authorUlrich Müller <ulm@gentoo.org>2017-11-23 09:06:56 +0100
committerUlrich Müller <ulm@gentoo.org>2017-11-24 00:11:47 +0100
commit34642db92f251d027c5fcdb861380fd10b012117 (patch)
treef5e65f88770a3503d5f55cab8244170a3480908f /general-concepts
parentebuild-writing/file-format: Describe syntax of suffixes correctly. (diff)
general-concepts/tree: Document current practice for distfile names.
At the time of writing, all distfiles referenced from the Gentoo repository are using only ASCII alphanumeric plus +-.@[]_~ special characters. If all known overlays are included, characters %&();=? occur in addition. Closes: https://bugs.gentoo.org/638538
Diffstat (limited to 'general-concepts')
1 files changed, 11 insertions, 0 deletions
diff --git a/general-concepts/tree/text.xml b/general-concepts/tree/text.xml
index de452e3..d524861 100644
--- a/general-concepts/tree/text.xml
+++ b/general-concepts/tree/text.xml
@@ -104,6 +104,17 @@ Things that do <b>not</b> belong in the tree:
+Naming rules for distfiles are more lenient, but for interoperability their
+filenames are restricted to the printable ASCII range excluding SPACE, i.e.,
+U+0021 to U+007e (see also
+<uri link="https://www.gentoo.org/glep/glep-0031.html#suitable-characters-for-file-and-directory-names">
+GLEP 31</uri>). Any characters that have a special meaning in Bash or in
+<c>SRC_URI</c> should also be avoided. If necessary, upstream files can be
+renamed using <uri link="::ebuild-writing/variables/#Renaming Sources">
+<c>-&gt;</c> syntax</uri>.
Software-wise, in general all of the following should be met in order for a package to be included in the tree: