Changeset View
Standalone View
documentation/content/en/books/porters-handbook/makefiles/_index.adoc
Show First 20 Lines • Show All 1,139 Lines • ▼ Show 20 Lines | |||||
PORTVERSION= ${ISCVERSION:S/-P/P/:S/b/.b/:S/a/.a/:S/rc/.rc/} | PORTVERSION= ${ISCVERSION:S/-P/P/:S/b/.b/:S/a/.a/:S/rc/.rc/} | ||||
CATEGORIES= dns net | CATEGORIES= dns net | ||||
MASTER_SITES= ISC/bind9/${ISCVERSION} | MASTER_SITES= ISC/bind9/${ISCVERSION} | ||||
PKGNAMESUFFIX= 99 | PKGNAMESUFFIX= 99 | ||||
DISTNAME= ${PORTNAME}-${ISCVERSION} | DISTNAME= ${PORTNAME}-${ISCVERSION} | ||||
MAINTAINER= mat@FreeBSD.org | MAINTAINER= mat@FreeBSD.org | ||||
COMMENT= BIND DNS suite with updated DNSSEC and DNS64 | COMMENT= BIND DNS suite with updated DNSSEC and DNS64 | ||||
WWW= https://www.isc.org/bind/ | |||||
LICENSE= ISCL | LICENSE= ISCL | ||||
# ISC releases things like 9.8.0-P1 or 9.8.1rc1, which our versioning does not like | # ISC releases things like 9.8.0-P1 or 9.8.1rc1, which our versioning does not like | ||||
ISCVERSION= 9.9.9-P6 | ISCVERSION= 9.9.9-P6 | ||||
.... | .... | ||||
Define upstream version in `ISCVERSION`, with a comment saying _why_ it is needed. | Define upstream version in `ISCVERSION`, with a comment saying _why_ it is needed. | ||||
▲ Show 20 Lines • Show All 1,353 Lines • ▼ Show 20 Lines | |||||
Here is an example: | Here is an example: | ||||
[.programlisting] | [.programlisting] | ||||
.... | .... | ||||
COMMENT= Cat chasing a mouse all over the screen | COMMENT= Cat chasing a mouse all over the screen | ||||
.... | .... | ||||
The COMMENT variable immediately follows the MAINTAINER variable in the [.filename]#Makefile#. | The COMMENT variable immediately follows the MAINTAINER variable in the [.filename]#Makefile#. | ||||
[[makefile-www]] | |||||
== Project website | |||||
Each port should point to a website that provides more information about the software. | |||||
Whenever possible, this should be the official project website maintained by the developers of the software. | |||||
[.programlisting] | |||||
.... | |||||
WWW= https://ffmpeg.org/ | |||||
pauamma_gundo.com: Tangent: when https works, as is the case for this port, should the porter's handbook encourage… | |||||
Done Inline ActionsYes, I'll update the patch to suggest to use https URLs, where possible. I have tested the ~6500 distinct http:// URLs currently present in pkg-descr files, some 3000 can be replaced by https URLs that return identical information. I'm currently thinking about whether the URLs should be patched into the pkg-descr files before moving the WWW data into the Makefile, or whether that should be a follow-up commit. Applying such a change to the pkg-descr files first, is a bit more effort (since not all are well-formed), but that would allow to merge them to 2022Q3, for example, if the port is touched for other reasons. But I tend to keeping the URLs unchanged in the initial commit (i.e. move them unchanged, except for malformed URLs).
se: Yes, I'll update the patch to suggest to use https URLs, where possible.
I have tested the… | |||||
.... | |||||
But it can also be a directory or resource in the source code repository: | |||||
[.programlisting] | |||||
.... | |||||
WWW= https://sourceforge.net/projects/mpd/ | |||||
.... | |||||
The WWW variable immediately follows the COMMENT variable in the [.filename]#Makefile#. | |||||
If the same content can be accessed via HTTP and HTTPS, the URL starting with `https://` shall be used. | |||||
If the URI is the root of the website or directory, it must be terminated with a slash. | |||||
This information used to be placed into the last line of the [.filename]#pkg-descr# file. | |||||
It has been moved into the Makefile for easier maintenance and processing. | |||||
Having a `WWW:` line at the end of the [.filename]#pkg-descr# file is deprecated. | |||||
[[licenses]] | [[licenses]] | ||||
== Licenses | == Licenses | ||||
Each port must document the license under which it is available. | Each port must document the license under which it is available. | ||||
If it is not an OSI approved license it must also document any restrictions on redistribution. | If it is not an OSI approved license it must also document any restrictions on redistribution. | ||||
[[licenses-license]] | [[licenses-license]] | ||||
▲ Show 20 Lines • Show All 2,812 Lines • Show Last 20 Lines |
Tangent: when https works, as is the case for this port, should the porter's handbook encourage using it instead?