From 5e31a7c571b3717797a02d11e9d57766ec459814 Mon Sep 17 00:00:00 2001 From: wiz Date: Fri, 11 Aug 2006 13:20:04 +0000 Subject: regen --- doc/pkgsrc.html | 124 ++++++++++++++++++++++++++++---------------------------- doc/pkgsrc.txt | 40 ++++++++++-------- 2 files changed, 85 insertions(+), 79 deletions(-) diff --git a/doc/pkgsrc.html b/doc/pkgsrc.html index 725bdc18c84..07f7b51e8e1 100644 --- a/doc/pkgsrc.html +++ b/doc/pkgsrc.html @@ -5,11 +5,7 @@ The pkgsrc guide - +
@@ -464,7 +460,7 @@ packages for himself, which is a time-costly task.

  • www/apache - The Apache web server

  • -
  • www/mozilla - The Mozilla +

  • www/firefox - The Firefox web browser

  • meta-pkgs/gnome - The GNOME Desktop Environment

  • @@ -523,7 +519,7 @@ minutes!

    grown a lot, and now supports the following platforms:

    Table 1.1. Platforms supported by pkgsrc

    - +
    @@ -588,8 +584,9 @@ minutes!

    -
    Nov 2004
    +
+
@@ -1019,7 +1016,7 @@ directory on ftp.NetBSD.org.

Table 3.1. Binary kits and available packages

- +
@@ -1190,9 +1187,9 @@ directory on ftp.NetBSD.org.

-
 
+
-

+

Simply download the binary kit for your platform, and extract it into / e.g.

@@ -2023,7 +2020,7 @@ the online index of packages, or run make readmepkgsrc directory to build local README.html files for all packages, viewable with any web browser such as www/lynx or -www/mozilla.

+www/firefox.

The default prefix for installed packages is /usr/pkg. If you wish to change this, you should do so by setting LOCALBASE in @@ -2062,7 +2059,7 @@ to your mk.conf.

You can overwrite some of the major distribution sites to fit to sites that are close to your own. Have a look at pkgsrc/mk/defaults/mk.conf to find some examples - — in particular, look for the MASTER_SORT, + — in particular, look for the MASTER_SORT, MASTER_SORT_REGEX and INET_COUNTRY definitions. This may save some of your bandwidth and time.

@@ -2323,7 +2320,7 @@ You can now enter: can be NFS-mounted while ${WRKOBJDIR} is local to every architecture. (It should be noted that PKGSRCDIR should not be set by the user - — it is an internal definition which refers to the + — it is an internal definition which refers to the root of the pkgsrc tree. It is possible to have many pkgsrc tree instances.)

  • LOCALPATCHES: @@ -2341,7 +2338,6 @@ You can now enter: settings used by builds in /usr/src.

  • DEPENDS_TARGET: By default, dependencies are only installed, and no binary - package is created for them. You can set this variable to package to automatically create binary packages after installing dependencies.

  • @@ -2797,7 +2793,7 @@ PKG_OPTIONS.apache= suexec
  • /usr/src (system sources, - e. g. for sysutils/aperture):

    + e. g. for sysutils/aperture):

    # ln -s ../disk1/cvs .
     # ln -s cvs/src-2.0 src
  • @@ -4138,7 +4134,7 @@ a security check before building any package. See operate on the words, others operate on the string as a whole. When a string is split into words, it is split as you would expect it from sh(1).

    -

    No rule without exception—the .for +

    No rule without exception—the .for loop does not follow the shell quoting rules but splits at sequences of whitespace.

    There are several types of variables that should be handled @@ -6343,7 +6339,7 @@ of MAKEFILE is “Makefile<

    readme

    This target generates a README.html file, which can be viewed using a browser such as - www/mozilla or + www/firefox or www/links. The generated files contain references to any packages which are in the PACKAGES directory on @@ -7555,10 +7551,24 @@ Changes to the PLIST

    17.5.2. Where to install documentation

    -

    Documentation should be installed into +

    In general, documentation should be installed into ${PREFIX}/share/doc/${PKGBASE} or ${PREFIX}/share/doc/${PKGNAME} (the latter includes the version number of the package).

    +

    Many modern packages using GNU autoconf allow to set the directory + where HTML documentation is installed with the “--with-html-dir” + option.

    +

    An exception to the above is that library API + documentation generated with the textproc/gtk-doc tools, for use by + special browsers (devhelp) should be left at their default + location, which is + ${PREFIX}/share/gtk-doc. Such + documentation can be recognized from files ending in + .devhelp or + .devhelp2. (It is also acceptable to + install such files in + ${PREFIX}/share/doc; no additional + subdirectory level is allowed in this case.)

    @@ -8265,36 +8275,36 @@ place.

    pkgsrc-users mailing list.

    -
    20.1. What is the difference between +
    20.1. What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS?
    -
    20.2. What is the difference between +
    20.2. What is the difference between MAKE, GMAKE and MAKE_PROGRAM?
    -
    20.3. What is the difference between +
    20.3. What is the difference between CC, PKG_CC and PKGSRC_COMPILER?
    -
    20.4. What is the difference between +
    20.4. What is the difference between BUILDLINK_LDFLAGS, BUILDLINK_LDADD and BUILDLINK_LIBS?
    -
    20.5. Why does make show-var +
    20.5. Why does make show-var VARNAME=BUILDLINK_PREFIX.foo say it's empty?
    -
    20.6. What does +
    20.6. What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I don't understand the := inside it.
    -
    20.7. Which mailing lists are there for package +
    20.7. Which mailing lists are there for package developers?
    -
    20.8. Where is the pkgsrc +
    20.8. Where is the pkgsrc documentation?
    @@ -8303,14 +8313,14 @@ place.

    -20.1. +20.1.

    What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS?

    - +

    MAKEFLAGS are the flags passed to the pkgsrc-internal invocations of make(1), while MAKE_FLAGS are the flags that are passed to @@ -8319,14 +8329,14 @@ place.

    -20.2. +20.2.

    What is the difference between MAKE, GMAKE and MAKE_PROGRAM?

    - +

    MAKE is the path to the make(1) program that is used in the pkgsrc infrastructure. GMAKE is the path to GNU @@ -8337,14 +8347,14 @@ place.

    -20.3. +20.3.

    What is the difference between CC, PKG_CC and PKGSRC_COMPILER?

    - +

    CC is the path to the real C compiler, which can be configured by the pkgsrc user. PKG_CC is the path to the compiler wrapper. @@ -8355,7 +8365,7 @@ place.

    -20.4. +20.4.

    What is the difference between BUILDLINK_LDFLAGS, @@ -8363,19 +8373,19 @@ place.

    BUILDLINK_LIBS?

    - +

    [FIXME]

    -20.5. +20.5.

    Why does make show-var VARNAME=BUILDLINK_PREFIX.foo say it's empty?

    - +

    For optimization reasons, some variables are only available in the “wrapper” phase and later. To “simulate” the wrapper phase, append @@ -8384,7 +8394,7 @@ place.

    -20.6. +20.6.

    What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I @@ -8392,7 +8402,7 @@ place.

    it.

    - +

    The := is not really an assignment operator, like you might expect at first sight. Instead, it is a degenerate form of @@ -8408,13 +8418,13 @@ place.

    -20.7. +20.7.

    Which mailing lists are there for package developers?

    - +
    tech-pkg

    This is a list for technical discussions related @@ -8433,13 +8443,13 @@ place.

    -20.8. +20.8.

    Where is the pkgsrc documentation?

    - +

    There are many places where you can find documentation about pkgsrc:

    @@ -8692,8 +8702,8 @@ place.

    21.5.1. Procedures with parameters

    In a traditional imperative programming language some of the .mk files could be described as - procedures. They take some input parameters and—after - inclusion—provide a result in output parameters. Since all + procedures. They take some input parameters and—after + inclusion—provide a result in output parameters. Since all variables in Makefiles have global scope care must be taken not to use parameter names that have already another meaning. For example, PKGNAME is a @@ -9401,7 +9411,7 @@ source packages

    The procedure to edit the pkgsrc guide is:

    1. Make sure you have the packages needed to - re-generate the pkgsrc guide (and other XML-based NetBSD + regenerate the pkgsrc guide (and other XML-based NetBSD documentation) installed. These are meta-pkgs/netbsd-doc for creating the ASCII and HTML versions, and meta-pkgs/netbsd-doc-print for the PostScript and PDF versions. You will need both packages @@ -9422,21 +9432,13 @@ source packages

  • Run bmake clean && bmake to regenerate the output files with the proper RCS Ids.

  • -
  • Run (cd .. && cvs update pkgsrc.*) - && bmake install-doc to put the generated - files into pkgsrc/doc.

  • -
  • Run (cd .. && cvs commit -m - "regenerated." pkgsrc.{html,txt}) to commit the - generated documentation.

  • -
  • Run (cd - ../../../htdocs/Documentation/pkgsrc && cvs update) - && bmake install-htdocs to generate all the - files for the web server.

  • -
  • Run (cd - ../../../htdocs/Documentation/pkgsrc && cvs commit -m - "regenerated.") to update the files on the web server. - If you have added a chapter, don't forget to run cvs - add *.html before you commit the files.

  • +
  • Run bmake regenerate to + regenerate the files in both pkgsrc/doc and + htdocs.

  • +
  • If you have added, removed or renamed some chapters, + you need to synchronize them using cvs add or + cvs delete in the htdocs + directory.

  • diff --git a/doc/pkgsrc.txt b/doc/pkgsrc.txt index 058964a5801..31e655a105f 100644 --- a/doc/pkgsrc.txt +++ b/doc/pkgsrc.txt @@ -433,7 +433,7 @@ pkgsrc currently contains several thousand packages, including: * www/apache - The Apache web server - * www/mozilla - The Mozilla web browser + * www/firefox - The Firefox web browser * meta-pkgs/gnome - The GNOME Desktop Environment @@ -515,6 +515,7 @@ Table 1.1. Platforms supported by pkgsrc |OSF/1 | Nov 2004 | +----------------------------------------------------------------+ + 1.2. Overview This document is divided into three parts. The first, The pkgsrc user's guide, @@ -934,6 +935,7 @@ Table 3.1. Binary kits and available packages |Solaris 9/i386 |20030411 |binary kit| | +------------------------------------------------------------------------------+ + Simply download the binary kit for your platform, and extract it into / e.g. # cd / @@ -1632,7 +1634,7 @@ involved. After obtaining pkgsrc, the pkgsrc directory now contains a set of packages, organized into categories. You can browse the online index of packages, or run make readme from the pkgsrc directory to build local README.html files for all -packages, viewable with any web browser such as www/lynx or www/mozilla. +packages, viewable with any web browser such as www/lynx or www/firefox. The default prefix for installed packages is /usr/pkg. If you wish to change this, you should do so by setting LOCALBASE in mk.conf. You should not try to @@ -5196,7 +5198,7 @@ info readme This target generates a README.html file, which can be viewed using a - browser such as www/mozilla or www/links. The generated files contain + browser such as www/firefox or www/links. 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 @@ -6155,9 +6157,19 @@ will automatically do the right thing. 17.5.2. Where to install documentation -Documentation should be installed into ${PREFIX}/share/doc/${PKGBASE} or $ -{PREFIX}/share/doc/${PKGNAME} (the latter includes the version number of the -package). +In general, documentation should be installed into ${PREFIX}/share/doc/$ +{PKGBASE} or ${PREFIX}/share/doc/${PKGNAME} (the latter includes the version +number of the package). + +Many modern packages using GNU autoconf allow to set the directory where HTML +documentation is installed with the "--with-html-dir" option. + +An exception to the above is that library API documentation generated with the +textproc/gtk-doc tools, for use by special browsers (devhelp) should be left at +their default location, which is ${PREFIX}/share/gtk-doc. Such documentation +can be recognized from files ending in .devhelp or .devhelp2. (It is also +acceptable to install such files in ${PREFIX}/share/doc; no additional +subdirectory level is allowed in this case.) 17.5.3. Installing score files @@ -7590,7 +7602,7 @@ D.2. Procedure The procedure to edit the pkgsrc guide is: - 1. Make sure you have the packages needed to re-generate the pkgsrc guide (and + 1. Make sure you have the packages needed to regenerate the pkgsrc guide (and other XML-based NetBSD documentation) installed. These are meta-pkgs/ netbsd-doc for creating the ASCII and HTML versions, and meta-pkgs/ netbsd-doc-print for the PostScript and PDF versions. You will need both @@ -7612,16 +7624,8 @@ The procedure to edit the pkgsrc guide is: 6. Run bmake clean && bmake to regenerate the output files with the proper RCS Ids. - 7. Run (cd .. && cvs update pkgsrc.*) && bmake install-doc to put the - generated files into pkgsrc/doc. - - 8. Run (cd .. && cvs commit -m "regenerated." pkgsrc.{html,txt}) to commit the - generated documentation. - - 9. Run (cd ../../../htdocs/Documentation/pkgsrc && cvs update) && bmake - install-htdocs to generate all the files for the web server. + 7. Run bmake regenerate to regenerate the files in both pkgsrc/doc and htdocs. -10. Run (cd ../../../htdocs/Documentation/pkgsrc && cvs commit -m - "regenerated.") to update the files on the web server. If you have added a - chapter, don't forget to run cvs add *.html before you commit the files. + 8. If you have added, removed or renamed some chapters, you need to + synchronize them using cvs add or cvs delete in the htdocs directory. -- cgit v1.2.3