From: blundellc <blundellc@edb9625f-4e0d-4859-8d74-9fd3b1da38cb>
Date: Sat, 13 Sep 2008 13:25:13 +0000 (+0000)
Subject: doc: document the commands better
X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=63aaa21d331fd298b186ab44ab933853d61d333a;p=cran2deb.git

doc: document the commands better

git-svn-id: svn://svn.r-forge.r-project.org/svnroot/cran2deb@113 edb9625f-4e0d-4859-8d74-9fd3b1da38cb
---

diff --git a/pkg/trunk/R/zzz.R b/pkg/trunk/R/zzz.R
index de8aeae..39a935e 100644
--- a/pkg/trunk/R/zzz.R
+++ b/pkg/trunk/R/zzz.R
@@ -10,7 +10,7 @@
     global("dinstall_archive", file.path(root,'var/archive'))
     global("r_depend_fields", c('Depends','Imports')) # Suggests, Enhances
     # git_revision {
-    global("git_revision","bc0b57d181288d67ce7829455c9e11fcfc9faa1a")
+    global("git_revision","0a42c69323bbf485eb18fc4345253bee2efd7aff")
     # git_revision }
     global("changesfile", function(srcname,version='*') {
         return(file.path(pbuilder_results
diff --git a/pkg/trunk/exec/autobuild b/pkg/trunk/exec/autobuild
index 2e4107a..0b24cba 100755
--- a/pkg/trunk/exec/autobuild
+++ b/pkg/trunk/exec/autobuild
@@ -1,4 +1,7 @@
 #!/usr/bin/env r
+## DOC: cran2deb autobuild
+## DOC:     automatically builds all out of date packages.
+## DOC:
 suppressMessages(library(cran2deb))
 
 if (exists('argv')) { # check for littler
diff --git a/pkg/trunk/exec/build b/pkg/trunk/exec/build
index ebab8da..aa8a175 100755
--- a/pkg/trunk/exec/build
+++ b/pkg/trunk/exec/build
@@ -1,4 +1,7 @@
 #!/usr/bin/env r
+## DOC: cran2deb build [-D extra_dep1,extra_dep2,...] package1 package2 ...
+## DOC:     builds a particular package.
+## DOC:
 suppressMessages(library(cran2deb))
 
 if (exists('argv')) { # check for littler
diff --git a/pkg/trunk/exec/build_ctv b/pkg/trunk/exec/build_ctv
index 7f6201e..35d9a42 100755
--- a/pkg/trunk/exec/build_ctv
+++ b/pkg/trunk/exec/build_ctv
@@ -1,4 +1,7 @@
 #!/usr/bin/env rc
+## DOC: cran2deb build_ctv
+## DOC:     build all CRAN TaskViews. warning and error logs in ./ctv/
+## DOC:
 
 for (ctv in `{cran2deb cran_pkgs query}) {
     echo task view $ctv...
diff --git a/pkg/trunk/exec/build_some b/pkg/trunk/exec/build_some
index 5f56c43..679eed2 100755
--- a/pkg/trunk/exec/build_some
+++ b/pkg/trunk/exec/build_some
@@ -1,4 +1,10 @@
 #!/usr/bin/rc
+## DOC: cran2deb build_some [taskview1 taskview2 ...]
+## DOC:     build some packages, logging warnings into ./warn/$package
+## DOC:     and failures into ./fail/$package. with no arguments a random
+## DOC:     sample of packages is built.  the file ./all_pkgs overrides this
+## DOC:     behaviour and is expected to be a list of packages to build.
+## DOC:
 
 mkdir -p warn fail
 shift
diff --git a/pkg/trunk/exec/copy_find b/pkg/trunk/exec/copy_find
index fe3d619..eebcec1 100755
--- a/pkg/trunk/exec/copy_find
+++ b/pkg/trunk/exec/copy_find
@@ -1,4 +1,7 @@
 #!/usr/bin/rc
+## DOC: cran2deb copy_find path
+## DOC:     a tool for finding (heuristically) some copyright notices.
+## DOC:
 kwords='copyright|warranty|redistribution|modification|patent|trademark|licen[cs]e|permission'
 nl=`` () {printf '\n'}
 ifs=$nl {
diff --git a/pkg/trunk/exec/cran_pkgs b/pkg/trunk/exec/cran_pkgs
index 57697a5..b8a2dcb 100755
--- a/pkg/trunk/exec/cran_pkgs
+++ b/pkg/trunk/exec/cran_pkgs
@@ -1,10 +1,16 @@
 #!/usr/bin/env r
+## DOC: cran2deb cran_pkgs
+## DOC:     print a list of 800 packages picked at random
+## DOC: cran2deb cran_pkgs query
+## DOC:     print the names of all CRAN TaskViews
+## DOC: cran2deb cran_pkgs taskview1 taskview2 ...
+## DOC:     print the names of all packages in a particular CRAN TaskView
+## DOC:
 
 library(cran2deb)
 
 if (length(argv) == 1) {
     writeLines(sample(dimnames(available)[[1]],800))
-    #writeLines(dimnames(available)[[1]])
 } else {
     argv = argv[2:length(argv)]
     if (argv[1] == 'query') {
diff --git a/pkg/trunk/exec/depend b/pkg/trunk/exec/depend
index fc6ada8..f4a100a 100755
--- a/pkg/trunk/exec/depend
+++ b/pkg/trunk/exec/depend
@@ -1,4 +1,7 @@
 #!/usr/bin/env r
+## DOC: cran2deb depend
+## DOC:     add dependency aliases, system requirements and forced dependencies
+## DOC:
 
 suppressPackageStartupMessages(library(cran2deb))
 suppressPackageStartupMessages(library(digest))
diff --git a/pkg/trunk/exec/help b/pkg/trunk/exec/help
index 6be441e..e7397f8 100755
--- a/pkg/trunk/exec/help
+++ b/pkg/trunk/exec/help
@@ -1,6 +1,6 @@
 #!/usr/bin/rc
 echo usage: cran2deb '<cmd> [args ...]'
 echo where '<cmd>' is one of
-ls $1/exec
+grep '## [D]OC:' $1/exec/* | sed -e 's/.*[D]OC://'
 echo
 echo installation root is: $1
diff --git a/pkg/trunk/exec/license b/pkg/trunk/exec/license
index 343bc18..74e01a5 100755
--- a/pkg/trunk/exec/license
+++ b/pkg/trunk/exec/license
@@ -1,4 +1,7 @@
 #!/usr/bin/env r
+## DOC: cran2deb license
+## DOC:     add licenses and change acceptance/rejection of licenses
+## DOC:
 
 suppressPackageStartupMessages(library(cran2deb))
 suppressPackageStartupMessages(library(digest))
diff --git a/pkg/trunk/exec/update b/pkg/trunk/exec/update
index fb4c01f..a2cdf01 100755
--- a/pkg/trunk/exec/update
+++ b/pkg/trunk/exec/update
@@ -1,4 +1,10 @@
 #!/usr/bin/rc
+## DOC: cran2deb update
+## DOC:     update the cran2deb cache and database
+## DOC: cran2deb update full
+## DOC:     force a full update of the cran2deb cache and database
+## DOC:
+
 umask 022
 root=$1
 shift