[pkgsrc/trunk]: pkgsrc/doc/guide/files doc/guide: make the pkglint output mor...

[rillig <rillig%pkgsrc.org@localhost>]

details:   https://anonhg.NetBSD.org/pkgsrc/rev/e831186d4e20
branches:  trunk
changeset: 422494:e831186d4e20
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Tue Jan 28 03:33:04 2020 +0000

description:
doc/guide: make the pkglint output more realistic

The bison example package is quite old-fashioned, therefore the modern
pkglint generates quite a few warnings for it. These also serve better in
the example than a mere "looks fine".

diffstat:

 doc/guide/files/examples.xml |  15 +++++++++++----
 1 files changed, 11 insertions(+), 4 deletions(-)

diffs (39 lines):

diff -r 920c16f45755 -r e831186d4e20 doc/guide/files/examples.xml
--- a/doc/guide/files/examples.xml      Tue Jan 28 03:18:14 2020 +0000
+++ b/doc/guide/files/examples.xml      Tue Jan 28 03:33:04 2020 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: examples.xml,v 1.15 2020/01/28 03:15:47 rillig Exp $ -->
+<!-- $NetBSD: examples.xml,v 1.16 2020/01/28 03:33:04 rillig Exp $ -->
 
 <appendix id="examples">
   <title>A simple example package: bison</title>
@@ -21,7 +21,7 @@
 
 DISTNAME=       bison-1.25
 CATEGORIES=     devel
-MASTER_SITES=   ${MASTER_SITE_GNU}
+MASTER_SITES=   ${MASTER_SITE_GNU:=bison/}
 
 MAINTAINER=     pkgsrc-users%NetBSD.org@localhost
 HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
@@ -63,11 +63,18 @@
         <filename role="pkg">pkgtools/pkglint</filename>
        which helps to check the contents of these
        files. After installation it is quite easy to use, just change to the
-       directory of the package you wish to examine and execute
+       directory of the package you wish to examine and run
        <command>pkglint</command>:</para>
 
       <screen>&uprompt; <userinput>pkglint</userinput>
-looks fine.</screen>
+ERROR: Makefile: Each package must define its LICENSE.
+WARN: Makefile:9: HOMEPAGE should migrate from http to https.
+NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
+WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
+1 error, 2 warnings and 1 note found.
+(Run "pkglint -e" to show explanations.)
+(Run "pkglint -fs" to show what can be fixed automatically.)
+(Run "pkglint.exe -F" to automatically fix some issues.)</screen>
 
       <para>Depending on the supplied command line arguments (see pkglint(1)),
        more checks will be performed. Use e.g. <command>pkglint