summaryrefslogtreecommitdiff
path: root/SYNTAX
blob: 20b38550d8aa7abca22f33fe6532778e2bb57701 (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
The *blacklist.txt files consist of lines in the following format:

    original-package:[libre-replacement]:[ref]:[id]:short-description

where something within [] is optional.

* 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#
    savannah: &sv https://savannah.nongnu.org/bugs/?
    fedora: &fedora https://bugzilla.redhat.com/show_bug.cgi?id=
    parabola: &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
  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:

    [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.