summaryrefslogtreecommitdiff
path: root/chef/distro
diff options
context:
space:
mode:
authorSteven Danna <steve@opscode.com>2011-08-24 10:58:13 -0700
committerBryan McLellan <btm@opscode.com>2011-09-29 06:17:29 -0700
commit7e123b21f2cfb57e4b6eaa206d59a8ad847429fa (patch)
tree383fcdbf275545ea54f4808a927e4827451e080d /chef/distro
parent0eea5bfee002f3ab269e2257f2b3f8559d43c5e4 (diff)
downloadchef-7e123b21f2cfb57e4b6eaa206d59a8ad847429fa.tar.gz
CHEF-1656 Move descriptions of valid formats to knife man page.
Diffstat (limited to 'chef/distro')
-rw-r--r--chef/distro/common/markdown/man1/knife-node.mkd20
-rw-r--r--chef/distro/common/markdown/man1/knife.mkd25
2 files changed, 25 insertions, 20 deletions
diff --git a/chef/distro/common/markdown/man1/knife-node.mkd b/chef/distro/common/markdown/man1/knife-node.mkd
index 1579052083..71b3ffe143 100644
--- a/chef/distro/common/markdown/man1/knife-node.mkd
+++ b/chef/distro/common/markdown/man1/knife-node.mkd
@@ -100,25 +100,7 @@ __knife node show__ _node name_ _(options)_
Display more, but not all, of the node's data when using the default
_summary_ format
-Displays the node identified by _node name_ on stdout. The amount of
-content displayed and the output format are modified by the --format
-option. If no alternate format is selected, the default is summary.
-Valid formats are:
-
- * summary:
- displays the node in a custom, summarized format (default)
- * text
- displays the node data in its entirety using the colorized tree
-display
- * json:
- displays the node in JSON format
- * yaml:
- displays the node in YAML format
- * pp
- displays the node using Ruby's pretty printer.
-
-For brevity, only the first character of the format is required, for
-example, -Fj will produce JSON format output.
+Displays the node identified by _node name_ on stdout.
## RUN LIST ITEM FORMAT
Run list items may be either roles or recipes. When adding a role to a
diff --git a/chef/distro/common/markdown/man1/knife.mkd b/chef/distro/common/markdown/man1/knife.mkd
index 83641a55b7..2a73fc7c10 100644
--- a/chef/distro/common/markdown/man1/knife.mkd
+++ b/chef/distro/common/markdown/man1/knife.mkd
@@ -45,7 +45,7 @@ documentation using `knife help TOPIC`.
* `-e`, `--editor` EDITOR:
Set the editor to use for interactive commands
* `-F`, `--format` FORMAT:
- Which format to use for output
+ Which format to use for output. See FORMATS for details.
* `-V`, `--verbose`:
More verbose output. Use twice for max verbosity
* `-n`, `--no-editor`:
@@ -132,6 +132,28 @@ _~/.chef/knife.rb_
Ruby DSL configuration file for knife. See __CONFIGURATION__.
+## FORMATS
+
+The amount of content displayed and the output format are
+modified by the `--format` option. If no alternate format is selected,
+the default is summary.
+
+Valid formats are:
+
+ * `summary`:
+ displays the node in a custom, summarized format (default)
+ * `text`:
+ displays the node data in its entirety using the colorized tree display
+ * `json`:
+ displays the node in JSON format
+ * `yaml`:
+ displays the node in YAML format
+ * `pp`:
+ displays the node using Ruby's pretty printer.
+
+For brevity, only the first character of the format is required, for
+example, -Fj will produce JSON format output.
+
## CHEF WORKFLOW
When working with Chef and Knife in the local repository, the recommended workflow outline looks like:
@@ -150,6 +172,7 @@ but it is not required, except in the case of the `cookbook site vendor`
sub-command, as it uses git directly. Version control is strongly
recommended though, and git fits with a lot of the workflow paradigms.
+
## EXAMPLES