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 de8aeaee383ca4beb038aef16abeea5da6aa64ce..39a935eca7122944c94bf2bd9c958a227b09f632 100644 (file)
--- 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 2e4107a43eee462f5ae61e7d0fc68444b0456ff4..0b24cba32edaff51fbce22e25f9d965e189193ba 100755 (executable)
--- 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 ebab8dafff8562b7a4514e3c24bd93e92d7032fd..aa8a175a66d71732379cd21d5fc5cd275a1205d3 100755 (executable)
--- 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 7f6201eaeb39ec43b99f662fbf8ec8e2fa228d8e..35d9a424be2fcbdfc2b4c24b055b41698adbdbf2 100755 (executable)
--- 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 5f56c432f84145c5e1806f71937016d10f9d4e8e..679eed2e153e4e974b5c107d0e4187b79f481eb6 100755 (executable)
--- 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 fe3d619638f403f864c3891042d9e48dfe7507c0..eebcec1ee55f062a830a587dc2589b93e7473558 100755 (executable)
--- 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 57697a5701f3b0a9eb1855a63f8be0bf3efa738e..b8a2dcb4dd94b042bad60fca23839d9fd12afe2d 100755 (executable)
--- 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 fc6ada8307216ed355174a8b4f9ab22acef377b5..f4a100aefac0b59d21d124c72e29754e7357b46e 100755 (executable)
--- 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 6be441e66ea4dec3ed0a8586bdc2471694eb81cc..e7397f8b12344ee86be56e00991a2ef274a5f1e3 100755 (executable)
--- 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 343bc188fb1e562c2078c4c078edbf6e3eeab81e..74e01a57ea63ece49babfb568f87604b7f2bb6f6 100755 (executable)
--- 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 fb4c01f2d444454452225ffdf770340e547f03e4..a2cdf0160d791e4de0cdef38bef2f1d3b9e4acfb 100755 (executable)
--- 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