Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 12 May 2014 19:39:11 +0100
From:      Matthew Seaman <matthew@FreeBSD.org>
To:        freebsd-ports@freebsd.org
Subject:   Re: make check-plist ok, but portlint complains: %%PORTDOCS%%@dirrm %%DOCSDIR%% missing
Message-ID:  <5371154F.2060600@FreeBSD.org>
In-Reply-To: <201405121736.s4CHaCPe087201@mech-cluster241.men.bris.ac.uk>
References:  <201405121736.s4CHaCPe087201@mech-cluster241.men.bris.ac.uk>

next in thread | previous in thread | raw e-mail | index | archive | help
This is an OpenPGP/MIME signed message (RFC 4880 and 3156)
--sm17dbPCJmB1lJ7HJ3BRG1OQq6ivN025u
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: quoted-printable

On 12/05/2014 18:36, Anton Shterenlikht wrote:
> I'm updating devel/robodoc to staging.
> As suggested on the wiki page,
> env DEVELOPER=3Dyes make stage && make check-plist && make package
> runs fine, no issues.
> However, portlint -A reports:
>=20
> # portlint -A
> WARN: /usr/ports/devel/robodoc/pkg-plist: Both ``%%PORTDOCS%%@dirrm %%D=
OCSDIR%%'' and ``%%PORTDOCS%%@unexec %D/%%DOCSDIR%% 2>/dev/null || true''=
 are missing.  At least one should be used.
>=20
> I have in pkg-plist:
>=20
> bin/robodoc
> bin/robohdrs
> man/man1/robodoc.1.gz
> man/man1/robohdrs.1.gz
> %%DOCSDIR%%/AUTHORS
> %%DOCSDIR%%/ChangeLog
> %%DOCSDIR%%/NEWS
> %%DOCSDIR%%/README
> %%DOCSDIR%%/manual.css
> %%DOCSDIR%%/manual.html
> %%DOCSDIR%%/robodoc_example.rc
> %%EXAMPLESDIR%%/PerlExample/Source/Box.pm
> %%EXAMPLESDIR%%/PerlExample/Source/Box/RectangularBox.pm
> %%EXAMPLESDIR%%/PerlExample/Source/Box/SquareBox.pm
> %%EXAMPLESDIR%%/PerlExample/Source/Cargo.txt
> %%EXAMPLESDIR%%/PerlExample/Source/Loader.txt
> %%EXAMPLESDIR%%/PerlExample/Source/SmartLoader.pm
> %%EXAMPLESDIR%%/PerlExample/Source/TruckPacker.pl
> %%EXAMPLESDIR%%/PerlExample/robodoc.rc
> @dirrmtry %%DOCSDIR%%
> @dirrmtry %%EXAMPLESDIR%%/PerlExample/Source/Box
> @dirrmtry %%EXAMPLESDIR%%/PerlExample/Source
> @dirrmtry %%EXAMPLESDIR%%/PerlExample
> @dirrmtry %%EXAMPLESDIR%%
>=20
> What's the problem?
>=20
> As recommended on the wiki page I made
> the docs and examples non-optional, because
> they are very small.

portlint results are guidelines: if there's a good reason to do things
in a way that portlint complains about, then go right ahead.  However,
you may have to justify your choices and persuade a committer to commit
as is.

Given you're installing some docs and examples, I'd add support for
making them optional, even if they are pretty neglible in size.  It's
probably better for your port to behave in-line with other ports even if
not doing that is a reasonable choice.

Enabling DOCS and EXAMPLES in your port is pretty simple.  You need to
add %%PORTDOCS%% and %%PORTEXAMPLES%% to the appropriate lines in
pkg-plist and add

OPTIONS_DEFINE+=3D DOCS EXAMPLES

to the Makefile if you want them to show up in an options dialogue.

	Cheers,

	Matthew

--=20
Dr Matthew J Seaman MA, D.Phil.
PGP: http://www.infracaninophile.co.uk/pgpkey



--sm17dbPCJmB1lJ7HJ3BRG1OQq6ivN025u
Content-Type: application/pgp-signature; name="signature.asc"
Content-Description: OpenPGP digital signature
Content-Disposition: attachment; filename="signature.asc"

-----BEGIN PGP SIGNATURE-----
Version: GnuPG/MacGPG2 v2.0.20 (Darwin)
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iQJ8BAEBCgBmBQJTcRVZXxSAAAAAAC4AKGlzc3Vlci1mcHJAbm90YXRpb25zLm9w
ZW5wZ3AuZmlmdGhob3JzZW1hbi5uZXQ2NTNBNjhCOTEzQTRFNkNGM0UxRTEzMjZC
QjIzQUY1MThFMUE0MDEzAAoJELsjr1GOGkATIUkQAIhY2sNfyIvfskMmG2IzqUAc
DqWz/JDdVqwNw5QZI69KlGtUDX54vqcgNb7F5KNiDtXo1ZzpfIxqO6a1TRcxWfet
y9FPLc7UyKCMGh04O+aMvS7/JTP1ZDm64KGX6fqq3DhkFFPHuCzJHZlMa1ReyW+o
u2qlvEiz9C2kEq7S+zbkDwpwM4y/hXEYgpIxMfPt4QxaFdhWUfrOYnOThZWBcRN/
Sc+x/c06tCBYTUchqP3GzL2jJGbQuf3P36/TGy2qpMFpomFUpvnl+o2yPKDogt39
DoOC377dmS5HS7zyqZt6cwqDYl7SfTkqu8jo2tKUbRyvgCvvYG4O6STPXe9qikQi
GMSmeYRB2ZFER56drOsVMjQEN5hRB9Saz3JCrAbCc4JuPnqzXSeu5D7HoJNfrRA9
dAIVBZEVi2WJ93V0Ro/0aLfZfQ8NBlS4uQ00bz5OJLDHfmTDdCFVKlKg9WNn878/
XqgEFdEM8TDua7PwBmpmHCXmDgFMqm6LmAxIV2nVU5CXTnhFtEnnXREl03LpRmWf
HpQCOzU7knf2tDln7ciXl0eJ12qFtNsgJB1tbU6ZRYuT87mffxnVoDcUooX3JUls
t3OHD35DL3lKsqfVbS9JKmIDv03RxFxKH6bM6jtAlWGRptYJDyVEjqHcuwhgGchj
HaYgb2mo7ietRfjhAeRS
=0cFi
-----END PGP SIGNATURE-----

--sm17dbPCJmB1lJ7HJ3BRG1OQq6ivN025u--



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?5371154F.2060600>