chiark / gitweb /
docs: more work
authorIan Jackson <ijackson@chiark.greenend.org.uk>
Thu, 28 Mar 2013 19:20:18 +0000 (19:20 +0000)
committerIan Jackson <ijackson@chiark.greenend.org.uk>
Thu, 28 Mar 2013 19:20:18 +0000 (19:20 +0000)
caf.pod

diff --git a/caf.pod b/caf.pod
index dad4736..7fefd16 100644 (file)
--- a/caf.pod
+++ b/caf.pod
@@ -520,8 +520,8 @@ string which will be mentioned in the log.
 
 C<$script> is a shell script fragment which must output a
 nul-separated list of filenames (e.g. the output of C<find -print0>).
-
-xxx blah blah
+It is textually surrounded by C<( )> and will be executed with C<set -e>
+in force.  Its cwd will be C<$dir>.
 
 =item C<< $verifier_or_authreq->($data) | CGI::Auth::Flexible-> >>
 
@@ -1027,11 +1027,34 @@ C<$vcs> is derived from the entry of C<srcump_vcs_dirs> which was
 used: it's the first sequence of word characters, lowercased.
 
 The default implementation is the module function C<srcdump_byvcs>.
-It simply calls C<srcdump_dir_cpio> with the script from the setting
-C<srcdump_vcsscript_$vcs>.
+It simply calls C<srcdump_dir_cpio> with a script from the setting
+C<srcdump_vcsscript>.
+
+=item C<srcdump_vcs_dirs>
+
+Array ref of leaf names of vcs metadata directories.  Used by the
+default implementation of C<srcdump_process_item>.  The default value
+is C<['.git','.hg','.bzr','.svn']>.
+
+=item C<srcdump_vcs_script>
+
+Hash ref of scripts for generating vcs metadata.  Used by the default
+implementation of C<srcdump_byvcs>.  The keys are values of C<$vcs>
+(see C<srcdump_byvcs>); the values are scripts as for
+C<srcdump_dir_cpio>.
+
+The default has an entry only for C<git>:
+  git ls-files -z
+  git ls-files -z --others --exclude-from=.gitignore
+  find .git -print0
+
+=item C<srcdump_excludes>
+
+Array ref of exclude glob patterns, used by the default implementation
+of C<srcdump_novcs>.  The default value is C<['*~','*.bak','*.tmp','#*#']>.
 
+Entries must not contain C<'> or C<\>.
 
- which is defined
 
 xxx conditions on listitems implied by srcdump_dirscan_prepare
 xxx listitems enoent behaviour