[pkgsrc/trunk]: pkgsrc/mk/fetch Document the targets in fetch-list.mk.

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

details:   https://anonhg.NetBSD.org/pkgsrc/rev/966323688c43
branches:  trunk
changeset: 516779:966323688c43
user:      jlam <jlam%pkgsrc.org@localhost>
date:      Thu Jul 27 17:29:57 2006 +0000

description:
Document the targets in fetch-list.mk.

diffstat:

 mk/fetch/fetch-list.mk |  32 ++++++++++++++++++++++++++++++--
 1 files changed, 30 insertions(+), 2 deletions(-)

diffs (57 lines):

diff -r 5e179f1b5994 -r 966323688c43 mk/fetch/fetch-list.mk
--- a/mk/fetch/fetch-list.mk    Thu Jul 27 17:28:38 2006 +0000
+++ b/mk/fetch/fetch-list.mk    Thu Jul 27 17:29:57 2006 +0000
@@ -1,9 +1,23 @@
-# $NetBSD: fetch-list.mk,v 1.7 2006/07/27 17:23:16 jlam Exp $
+# $NetBSD: fetch-list.mk,v 1.8 2006/07/27 17:29:57 jlam Exp $
 
-# Prints out a script to fetch all needed files (no checksumming).
+######################################################################
+### fetch-list (PUBLIC)
+######################################################################
+### fetch-list is a public target to print out a standalone shell
+### script to fetch all distfiles needed to build the package,
+### including distfiles needed by dependencies.  This script does not
+### perform any checksumming of the distfiles and does not resume
+### interrupted file transfers.
+###
 .PHONY: fetch-list
 fetch-list: fetch-list-header fetch-list-recursive
 
+######################################################################
+### fetch-list-header (PRIVATE)
+######################################################################
+### fetch-list-header prints out the preamble comments for the
+### fetch-list shell script.
+###
 .PHONY: fetch-list-header
 fetch-list-header:
        @${ECHO} '#!/bin/sh'
@@ -13,6 +27,14 @@
        @${ECHO} '# on host "'"`${UNAME} -n`"'" on "'"`date`"'".'
        @${ECHO} '#'
 
+######################################################################
+### fetch-list-recursive (PRIVATE)
+######################################################################
+### fetch-list-recursive outputs the heart of the shell script by
+### looping over all package directories for dependencies and
+### outputting the shell script to fetch the distfiles for that
+### dependency.
+###
 .PHONY: fetch-list-recursive
 fetch-list-recursive:
        @${_DEPENDS_WALK_CMD} -r ${PKGPATH} |                           \
@@ -29,6 +51,12 @@
            );                                                          \
        done
 
+######################################################################
+### fetch-list-one-pkg (PRIVATE)
+######################################################################
+### fetch-list-one-pkg outputs the standalone shell script code to
+### fetch the distfiles for the package.
+###
 .PHONY: fetch-list-one-pkg
 fetch-list-one-pkg:
 .if !empty(_ALLFILES)