diff options
Diffstat (limited to 'SYNTAX')
-rw-r--r-- | SYNTAX | 88 |
1 files changed, 55 insertions, 33 deletions
@@ -1,76 +1,98 @@ The *blacklist.txt files consist of lines in the following format: - original-package:[libre-replacement]:[ref]:[id]:short-description + original-package![libre-replacement]![ref]![ref-id]!reason-tag!short-description -where something within [] is optional. +where field values within [] are optional. + + +Fields Semantics: * '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 + 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 one of the keys in the first column in following table: 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= + fsf : http://libreplanet.org/wiki/List_of_software_that_does_not_respect_the_Free_System_Distribution_Guidelines# parabola : https://labs.parabola.nu/issues/ + savannah : https://savannah.nongnu.org/bugs/? 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 + the value of the 'ref-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. -* 'id' refers to a reported bug on the tracker indicated in the 'ref' column + NOTE: An empty 'ref' field is deprecated, and should become an error eventually. + + +* 'ref-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 + the value of this 'ref-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: + NOTE: An empty 'ref-id' field is deprecated, and should become an error eventually. + + +* 'reason-tag' broadly categorizes the reason why the 'original-package' is blacklisted. + The primary use for these, is to identify issues that are relevant to all FSDG distros, + and may deserve discussion on the gnu-linux-libre mailing list. Other tags indicate + subtle problems introduced by Arch (e.g. not including required license text, adding + an avoidable dependency on a non-free package), or just branding or technical issues + which are peculiar to Parabola (e.g. carrying a custom pacman). + The acceptable reason tags are: - [nonfree]·······This package is blatently non-free software. + [nonfree]·······This package is completely non-free software; and can not be + liberated due to licensing, or lack of source code. - [semifree]······This package is mostly free, but contains some non-free - software or documentation. + [semifree]······This package is mostly free, but contains some non-free software, + fonts, artwork, or documentation; and is a candidate for a + liberation recipe. - [uses-nonfree]··This package depends on, recommends, or otherwise - inappropriately integrates with other non-free software - or services. + [uses-nonfree]··This package requires, recommends, or otherwise integrates, indexes, + or actively assists with downloading other non-free software. - [branding]······This package has branding needs adjusted; it refers to - "Arch" instead of "Parabola", or "Linux" instead of - "GNU/Linux", etc. + [branding]······This package has branding items which needs adjusted for some reason + (e.g. it refers to "Arch" instead of "Parabola" in ways that could be + inappropriate for a derivative to present as it's own, refers to the + "Linux" operating system rather than "GNU/Linux", or has conditions + on the use of it's trademarks; which parabola can not meet). [technical]·····This package cannot be imported from Arch because of - technical reasons, rather than freedom reasons; this is - NOT to do with freedom of privacy issues in the + technical reasons, rather than freedom reasons; but + NOT related to freedom of privacy issues in the package. This usually comes down to two things: it must be recompiled against our version of a dependency package, or it must be compiled from source, as we are stricter about that than Arch is. - 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. + If this tag is present, then the 'libre-replacement' + column should always match the 'original-package' column. - [FIXME:package] This package has a free replacement, or could be built + [FIXME-package] This package has a free replacement, or could be built in a way that is acceptable, but no one has done so yet. + NOTE: This tag is deprecated. + All entries should have a libre replacement, if possible. + + [FIXME-description] Someone needs to provide a brief descriptive text. + NOTE: This tag is deprecated. + All entries should have a short-description. + + NOTE: An empty 'reason-tag' field is deprecated, and should become an error eventually. + - [FIXME:description] Someone needs to fix the description in blacklist.txt +* 'short-description' breifly explains why the package is blacklisted. - 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 non-free package), or just - branding, dependency or non-freedom-related issues which don't need - reporting to other distros. + NOTE: An empty 'short-description' field is deprecated, + and should become an error eventually. |