diff options
| author | Peter Stephenson <pws@users.sourceforge.net> | 2007-12-03 19:04:08 +0000 |
|---|---|---|
| committer | Peter Stephenson <pws@users.sourceforge.net> | 2007-12-03 19:04:08 +0000 |
| commit | 9794b454777867201e242c425b4fd9629c669fee (patch) | |
| tree | 275dc24ebc26a094f64c516ef16ab2c70afbdb4e | |
| parent | 943cdc72f891f16fc572a4da5b7b1156a066ee35 (diff) | |
| download | zsh-9794b454777867201e242c425b4fd9629c669fee.tar.gz zsh-9794b454777867201e242c425b4fd9629c669fee.tar.xz zsh-9794b454777867201e242c425b4fd9629c669fee.zip | |
document the distfiles business
| -rw-r--r-- | ChangeLog | 7 | ||||
| -rw-r--r-- | Etc/zsh-development-guide | 30 | ||||
| -rw-r--r-- | Util/.distfiles | 8 |
3 files changed, 44 insertions, 1 deletions
diff --git a/ChangeLog b/ChangeLog index 167012032..725b4be92 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,10 @@ +2007-12-03 Peter Stephenson <pws@csr.com> + + * 24143: Etc/zsh-development-guide, Util/.distfiles: Remove + difflog.pl from the distribution owing to security worries + in usage (but leave it in the archive); also document the + distfiles business. + 2007-12-03 Clint Adams <clint@zsh.org> * 24140: Completion/Unix/Command/_git: spelling fix and diff --git a/Etc/zsh-development-guide b/Etc/zsh-development-guide index 299fd0a18..793e2d255 100644 --- a/Etc/zsh-development-guide +++ b/Etc/zsh-development-guide @@ -826,3 +826,33 @@ x_* reserved for private experimental use zsh The Zsh Development Group (contact: <coordinator@zsh.org>) Below the top level, naming authority is delegated. + + +Distribution of files +--------------------- + +zsh is distributed in two parts: a "src" distribution containing all +the source files (roughly, but not exactly, corresponding to the CVS +tree), and a "doc" distribution containing some pre-built files from +the documentation directory. All the files in the "doc" distribution +may be generated from files in the "src" distribution with appropriate +freely available tools. + +To indicate which files should be distributed, each directory in the CVS +tree includes a file .distfiles that sets any number of a set of Bourne +shell (scalar) parameters. The value of the parameter is expanded as a +set of standard command line arguments. Basic globbing is allowed in the +values. + +The following parameters are currently used: + +- DISTFILES_SRC is a list of files from the directory for the "src" + distribution. + +- DISTFILES_DOC is a list of files from the directory for the "doc" + distribution. + +- DISTFILES_NOT is a list of files that will not be included in a + distribution, but that need to be present in the CVS tree. This + variable is not used by the zsh build process and is present for + the convenience of external checks. diff --git a/Util/.distfiles b/Util/.distfiles index 133e1911d..162ace386 100644 --- a/Util/.distfiles +++ b/Util/.distfiles @@ -1,5 +1,11 @@ DISTFILES_SRC=' .distfiles - check_exports difflog.pl helpfiles mkdisttree.sh reporter + check_exports + helpfiles + mkdisttree.sh preconfig + reporter +' +DISTFILES_NOT=' + difflog.pl ' |