|author||bill-auger <email@example.com>||2018-01-20 22:49:29 -0500|
|committer||bill-auger <firstname.lastname@example.org>||2018-01-20 23:12:01 -0500|
add 'id' column description and clarify the 'ref' description
Diffstat (limited to 'SYNTAX')
1 files changed, 27 insertions, 27 deletions
@@ -4,41 +4,46 @@ The *blacklist.txt files consist of lines in the following format:
where something within  is optional.
-* original-package is the name of the binary package from Arch
+* 'original-package' is the name of the binary package from Arch
-* libre-replacement is the name of the binary package that provides
+* 'libre-replacement' is the name of the binary package that provides
and replaces the original-package, or empty if there is no
compatible replacement. The replacement must be compatible for use
by humans and scripts, e.g. fastjar is not a replacement for zip
although both solve the same problem. Packages in
your-freedom_emu-blacklist.txt are not meant to have a replacement.
-* ref is described by the following table:
+* 'ref' is one of the keys in the first column in following table:
- debian: &debian http://bugs.debian.org/
- fsf: &fsf http://libreplanet.org/wiki/List_of_software_that_does_not_respect_the_Free_System_Distribution_Guidelines#
- savannah: &sv https://savannah.nongnu.org/bugs/?
- fedora: &fedora https://bugzilla.redhat.com/show_bug.cgi?id=
- parabola: ¶bola https://labs.parabola.nu/issues/
+ debian : http://bugs.debian.org/
+ fsf : http://libreplanet.org/wiki/List_of_software_that_does_not_respect_the_Free_System_Distribution_Guidelines#
+ savannah : https://savannah.nongnu.org/bugs/?
+ fedora : https://bugzilla.redhat.com/show_bug.cgi?id=
+ parabola : https://labs.parabola.nu/issues/
- Use the value after & as the ref column value, the URL pointed by it and
- concatenated with the id field should point to an issue
+ The URL in the second column in above table, when concatenated with
+ the value of the 'id' field should form a valid URL pointing to an issue
reporting/describing the reason for the package being blacklisted.
We should prefer FSF refs, since they are easily available for other
distros. Hopefully some lines will move from parabola:X to fsf:Y with
the LibrePlanet wiki linking to the X issue on labs.parabola.nu.
-* short-description categorizes original-package with some tags,
+* 'id' refers to a reported bug on the tracker indicated in the 'ref' column
+ The URL in the second column in 'ref' table, when concatenated with
+ the value of this 'id' field should form a valid URL pointing to an issue
+ reporting/describing the reason for the package being blacklisted.
+* 'short-description' categorizes original-package with some tags,
followed by a short verbal explanation. Popular tags are:
- [nonfree]·······This package is blatently nonfree software.
+ [nonfree]·······This package is blatently non-free software.
- [semifree]······This package is mostly free, but contains some nonfree
+ [semifree]······This package is mostly free, but contains some non-free
+ software or documentation.
[uses-nonfree]··This package depends on, recommends, or otherwise
- inappropriately integrates with other nonfree software
+ inappropriately integrates with other non-free software
[branding]······This package has branding needs adjusted; it refers to
@@ -53,24 +58,19 @@ where something within  is optional.
package, or it must be compiled from source, as we are
stricter about that than Arch is.
- Either the original-package and the
- libre-replacement should match; or the
- libre-replacement should be empty, and it also have
- [FIXME:package] on it. If neither of those are true,
- then you are using this tag wrong. If this is the only
- tag, and "nonfree" appears in the description, you are
- using this tag wrong.
+ If this tag is present, then either the libre-replacement
+ column should match the the original-package column;
+ or the [FIXME:package] tag should also be present and
+ the libre-replacement column should be empty.
[FIXME:package] This package has a free replacement, or could be built
- in a way that is acceptable, but no one has done so
+ in a way that is acceptable, but no one has done so yet.
- [FIXME:description] Someone needs to fix the description in
+ [FIXME:description] Someone needs to fix the description in blacklist.txt
To make reporting issues to gnu-linux-libre easier, we should explain
in the description if the package is blacklisted due to an upstream FSDG
issue, problem introduced by Arch (e.g. not including required license
- text, adding optional dependency on a nonfree package), or just
+ text, adding optional dependency on a non-free package), or just
branding, dependency or non-freedom-related issues which don't need
reporting to other distros.