From 45e72938402aa19c32d12545094bcdaca2f70441 Mon Sep 17 00:00:00 2001 From: Nico Schottelius Date: Sun, 20 Mar 2011 01:08:11 +0100 Subject: [PATCH] document cdist-code-run Signed-off-by: Nico Schottelius --- Makefile | 1 + doc/dev/todo/niconext | 6 ----- doc/man/cdist-code-run.text | 34 +++++++++++++++++++++++++++ doc/man/cdist-object-gencode-all.text | 1 + doc/man/cdist-object-gencode.text | 1 + 5 files changed, 37 insertions(+), 6 deletions(-) create mode 100644 doc/man/cdist-code-run.text diff --git a/Makefile b/Makefile index 9168fc9f..5cc89547 100644 --- a/Makefile +++ b/Makefile @@ -14,6 +14,7 @@ MANGENERATED=$(MANDIR)/cdist-reference.text MANSRC=$(MANDIR)/cdist.text \ $(MANDIR)/cdist-code-run-all.text \ + $(MANDIR)/cdist-code-run.text \ $(MANDIR)/cdist-config.text \ $(MANDIR)/cdist-dir.text \ $(MANDIR)/cdist-env.text \ diff --git a/doc/dev/todo/niconext b/doc/dev/todo/niconext index e299766b..e69de29b 100644 --- a/doc/dev/todo/niconext +++ b/doc/dev/todo/niconext @@ -1,6 +0,0 @@ -Ensure bin/* is documented - -[0:43] kr:bin% for a in *; do test -f ../doc/man/${a}.text || echo $a missing ; done -cdist-code-run missing -[0:44] kr:bin% - diff --git a/doc/man/cdist-code-run.text b/doc/man/cdist-code-run.text new file mode 100644 index 00000000..f412f6da --- /dev/null +++ b/doc/man/cdist-code-run.text @@ -0,0 +1,34 @@ +cdist-code-run(1) +============================ +Nico Schottelius + + +NAME +---- +cdist-code-run - Run explorer remotely + + +SYNOPSIS +-------- +cdist-code-run OBJECT_DIR OBJECT TYPE + + +DESCRIPTION +----------- +cdist-code-run executes generated code from a given OBJECT. +The OBJECT must be located below OBJECT_DIR. +TYPE must be either local or remote and determines which +code part is to be executed. + + +SEE ALSO +-------- +- cdist(7) +- cdist-object-gencode(1) +- cdist-object-gencode-all(1) + + +COPYING +------- +Copyright \(C) 2011 Nico Schottelius. Free use of this software is +granted under the terms of the GNU General Public License version 3 (GPLv3). diff --git a/doc/man/cdist-object-gencode-all.text b/doc/man/cdist-object-gencode-all.text index 40d4335d..b1c96748 100644 --- a/doc/man/cdist-object-gencode-all.text +++ b/doc/man/cdist-object-gencode-all.text @@ -21,6 +21,7 @@ For every object that exists, the cdist-object-gencode is executed. SEE ALSO -------- - cdist(7) +- cdist-code-run(1) - cdist-deploy-to(1) - cdist-object-gencode(1) diff --git a/doc/man/cdist-object-gencode.text b/doc/man/cdist-object-gencode.text index c6fc8b18..83f4b4c1 100644 --- a/doc/man/cdist-object-gencode.text +++ b/doc/man/cdist-object-gencode.text @@ -22,6 +22,7 @@ executable on stdout will be used by cdist-object-gencode-all(1). SEE ALSO -------- - cdist(7) +- cdist-code-run(1) - cdist-deploy-to(1) - cdist-object-gencode-all(1)