From 46f7be9869f669e408f37f165df813d46008a3f4 Mon Sep 17 00:00:00 2001 From: Isaac David Date: Fri, 17 Mar 2017 16:00:47 -0600 Subject: update README and SYNTAX according to current practices --- SYNTAX | 50 +++++++++++++++++++++++++++++++++----------------- 1 file changed, 33 insertions(+), 17 deletions(-) (limited to 'SYNTAX') diff --git a/SYNTAX b/SYNTAX index 45c36a8..20b3855 100644 --- a/SYNTAX +++ b/SYNTAX @@ -1,12 +1,19 @@ The *blacklist.txt files consist of lines in the following format: - original-package:libre-replacement:ref:id:description + original-package:[libre-replacement]:[ref]:[id]:short-description -original-package is Arch binary package name, libre-replacement is the --libre package that provides and replaces the original-package or -empty if there is no compatible replacement. +where something within [] is optional. -ref is described by the following table: +* original-package is the name of the binary package from Arch + +* 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: debian: &debian http://bugs.debian.org/ fsf: &fsf http://libreplanet.org/wiki/List_of_software_that_does_not_respect_the_Free_System_Distribution_Guidelines# @@ -14,17 +21,26 @@ ref is described by the following table: fedora: &fedora https://bugzilla.redhat.com/show_bug.cgi?id= parabola: ¶bola 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 -reporting/describing the reason for the package being blacklisted. + 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 + 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, + followed by a short verbal explanation. Popular tags are: -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. + [nonfree] for blatantly nonfree packages + [semifree] mostly free packages with some nonfree additions + [uses-nonfree] for depending upon, or recommending nonfree software + [branding] Arch instead of Parabola, Linux instead of GNU/Linux, etc. + [technical] patched to build from sources. various innocent circumstances -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 -branding, dependency or non-freedom-related issues which don't need -reporting to other distros. + 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 + branding, dependency or non-freedom-related issues which don't need + reporting to other distros. -- cgit v1.2.2