>Number:         11156
>Category:       pkg
>Synopsis:       packages(7) doesn't say much about "make readme"
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    pkg-manager
>State:          open
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Fri Oct 06 16:42:00 PDT 2000
>Closed-Date:
>Last-Modified:
>Originator:     Jeremy C. Reed
>Release:        <NetBSD-current source date>
>Organization:
	
>Environment:
	
System: NetBSD rainier 1.4.2 NetBSD 1.4.2 (JCR1) #3: Wed Mar 29 00:24:33 PST 2000 reed@rainier:/home/src/sys/arch/i386/compile/JCR1 i386


>Description:
The Packages.txt file and packages(7) manual page don't say much about
making README.html files.
>How-To-Repeat:
>Fix:
Below is to diffs that 1) tell a regular user that "make readme" is
usually not needed; 2) tells the manpage reader to read the Packages.txt
file.


--- /usr/pkgsrc/Packages.txt.orig	Fri Oct  6 15:41:11 2000
+++ /usr/pkgsrc/Packages.txt	Fri Oct  6 16:35:18 2000
@@ -1297,15 +1297,17 @@
 
  * readme:
    This target generates a README.html file, which can be viewed using a
-   browser such as netscape (pkgsrc/www/mozilla) or lynx (pkgsrc/www/lynx).
-   The generated files contain references to any packages which are in the
-   ${PACKAGES} directory on the local host.  The generated files can
-   be made to refer to URLs based on FTP_PKG_URL_HOST and
-   FTP_PKG_URL_DIR.  (For example, if I wanted to generate README.html
-   files which pointed to binary packages on the local machine, in the
-   directory /usr/packages, set FTP_PKG_URL_HOST=file://localhost and
-   FTP_PKG_URL_DIR=/usr/packages. The ${PACKAGES} directory and its
-   subdirectories will be searched for all the binary packages.)
+   browser such as navigator (pkgsrc/www/navigator) or lynx (pkgsrc/www/lynx).
+   Usually this target is not used for regular users, because the README.html
+   files already contain the common information.  The generated files contain
+   references to any packages which are in the ${PACKAGES} directory on the
+   local host.  The generated files can be made to refer to URLs based on
+   FTP_PKG_URL_HOST and FTP_PKG_URL_DIR.  (For example, if I wanted to
+   generate README.html files which pointed to binary packages on the local
+   machine, in the directory /usr/packages, set
+   FTP_PKG_URL_HOST=file://localhost and FTP_PKG_URL_DIR=/usr/packages.  The
+   ${PACKAGES} directory and its subdirectories will be searched for all the
+   binary packages.)
 
  * readme-all: 
    Use this target to create a file README-all.html which contains a



--- packages.7.orig	Fri Oct  6 16:15:28 2000
+++ packages.7	Fri Oct  6 16:30:14 2000
@@ -683,7 +683,12 @@
 .Pa files/md5
 (only do this for your own packages!).
 .It readme	
-Create a README.html file describing the category or package
+Create a README.html file describing the category or package. (Regular
+users usually don't need to do this, unless they want to regenerate
+README.html files that contain different information, such as
+different download locations.) See
+.Pa ${PKGSRCDIR}/Packages.txt
+for more details.
 .It mirror-distfiles
 Mirror the distfile(s) if they are freely redistributable.  Setting
 .Dv MIRROR_DISTFILE
@@ -708,6 +713,11 @@
 .Sh SEE ALSO
 .Xr make 1 ,
 .Xr mk.conf 5
+and
+.Rs
+.%T "Documentation on the NetBSD Package System"
+.Re
+.Pa ${PKGSRCDIR}/Packages.txt
 .Sh HISTORY
 This manual page is based upon the comments in the
 .Pa bsd.pkg.mk
>Release-Note:
>Audit-Trail:
>Unformatted: