Re: HEADS-UP: Upcoming move of WWW definitions in all ports

Am 06.09.22 um 21:08 schrieb Shawn Webb:
> On Tue, Sep 06, 2022 at 08:09:24PM +0200, Stefan Esser wrote:
>> PortMgr has just accepted a change that has been in the making for some time:
>>
>> The move of the "WWW:" entries at the end of the ports' pkg-descr files into
>> the ports' Makefiles in the form of "WWW=" definitions.
>>
>> The WWW lines will be put into the maintainer block, immediately following
>> the MAINTAINER and COMMENT lines.
>>
>> If there is more than one WWW: line a pkg-descr file, one URL will be
>> selected to be moved into the Makefile, the other URLs will get a label
>> "See also:" instead of "WWW:".
>>
>> The following are examples taken from some port before and after the planned
>> conversion:
>>
>> ------------------------------------------------------------------------------
>> libmspack is a portable library for some loosely related Microsoft compression
>> formats.
>>
>> WWW: https://www.cabextract.org.uk/libmspack/
>> WWW: https://github.com/kyz/libmspack
>> ------------------------------------------------------------------------------
>>
>> This pkg-descr file would be converted to:
>>
>> ------------------------------------------------------------------------------
>> libmspack is a portable library for some loosely related Microsoft compression
>> formats.
>>
>> See also: https://github.com/kyz/libmspack
>> ------------------------------------------------------------------------------
>>
>> The WWW: entry that is deleted from pkg-descr will be moved into the Makefile:
>>
>> MAINTAINER=	sunpoet@FreeBSD.org
>> COMMENT=	Library for Microsoft compression formats
>> WWW=		https://www.cabextract.org.uk/libmspack/
[...]
> 
> Hey Stefan,
> 
> How would this impact downstream forks of the FreeBSD ports tree (if
> at all)? Will there be some transition time whereby the WWW line in
> pkg-descr is still respected? If a port hasn't made the switch to the
> Makefile-based format, would the port fail to build?

Hi Shawn,

see the patch in review D36434, specifically the chunk that is added to the
Mk/Scripts/create-manifest.sh script:

-- a/Mk/Scripts/create-manifest.sh
+++ b/Mk/Scripts/create-manifest.sh
@@ -87,6 +87,10 @@

  # Copy the pkg-descr file
  cp ${dp_DESCR} ${dp_METADIR}/+DESC
+if [ -n "${dp_WWW}" ] && ! grep -q '^WWW: ' ${dp_DESCR}; then
+	echo >> ${dp_METADIR}/+DESC
+	echo "WWW: ${dp_WWW}" >> ${dp_METADIR}/+DESC
+fi

If there is a WWW= line in the Makefile and no WWW: in the pkg-descr file,
then a WWW: line will be appended to the "desc" element that is included
in the package manifest ("+MANIFEST").

There will be one difference, though, see for example the www/py-uvicorn
port, whose pkg-descr file ends in:

---------------------------------------
[...]
Uvicorn currently supports HTTP/1.1 and WebSockets. Support for HTTP/2 is
planned.

WWW: https://www.uvicorn.org/
WWW: https://github.com/encode/uvicorn
---------------------------------------

This will become:

---------------------------------------
[...]
Uvicorn currently supports HTTP/1.1 and WebSockets. Support for HTTP/2 is
planned.

See also: https://github.com/encode/uvicorn

WWW: https://www.uvicorn.org/
---------------------------------------

There are ports with multiple WWW: lines where the first or where the last
line is the one leading to relevant documentation.

With the planned update an attempt is made to move the URL that actually
provides information about the software (instead of just pointing at the
source repository on Github) into the Makefile, whether it is the first or
second line in such a pkg-descr file.

I'll deal with any (unexpected) fall-out from this change ...

Regards, STefan