summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMichael DeHaan <mdehaan@redhat.com>2007-10-26 12:43:00 -0400
committerMichael DeHaan <mdehaan@redhat.com>2007-10-26 12:43:00 -0400
commit8dc285b85fb95acbcaf5beaec9c23fb5db9e25ef (patch)
treeb5f709d98c9e080d730d9d84751a60f0802124ab /docs
parentc90d64659a49179cc06f58ac920542f32125d19b (diff)
downloadthird_party-func-8dc285b85fb95acbcaf5beaec9c23fb5db9e25ef.zip
third_party-func-8dc285b85fb95acbcaf5beaec9c23fb5db9e25ef.tar.gz
third_party-func-8dc285b85fb95acbcaf5beaec9c23fb5db9e25ef.tar.xz
This adds alternative output formats for func-inventory, so that other programs could more easily read
the tree. The default is still pretty print as that makes the git diffs nicest.
Diffstat (limited to 'docs')
-rw-r--r--docs/func-inventory.pod7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/func-inventory.pod b/docs/func-inventory.pod
index ce79691..cfe362d 100644
--- a/docs/func-inventory.pod
+++ b/docs/func-inventory.pod
@@ -49,6 +49,13 @@ be tracked using standard git-tools such as "git log" and "gitk", when run on th
Additional built in hooks to notify changes can be written using git's own trigger mechanism, though something
more specific to func will likely be developed in the future -- also eliminating the need to grok git internals.
+=head1 ALTERNATIVE OUTPUT FORMATS
+
+func-inventory can be passed a --json or --xmlrpc parameter to override the default output format. These
+output formats are much less readable in the git-produced diffs, but are more easily loaded by other programs
+that may want to "mine" the output of a func-inventory tree. Using --json requires that the python-simplejson
+RPM be installed.
+
=head1 ADDITONAL RESOURCES
See https://hosted.fedoraproject.org/projects/func/ for more information.