From 5f6d837c21061dfee533ecf4fe13580bd727b339 Mon Sep 17 00:00:00 2001 From: Samuel Leung Date: Mon, 25 Jun 2012 17:10:48 -0400 Subject: [PATCH] minor update to documentation --- doc/command.rst | 22 ++++++++++++++++------ doc/index.rst | 1 + doc/keyset.rst | 2 ++ doc/settings.rst | 4 +++- 4 files changed, 22 insertions(+), 7 deletions(-) diff --git a/doc/command.rst b/doc/command.rst index e91246e..49babe2 100644 --- a/doc/command.rst +++ b/doc/command.rst @@ -5,13 +5,14 @@ Inferno Command Line Interface diana@ubuntu:~$ inferno --help usage: inferno [-h] [-v] [-s SERVER] [-e SETTINGS_FILE] [-i IMMEDIATE_RULE] - [-y RULES_DIRECTORY] [-f] [-x] [-D] [-d] [-p] [-t SOURCE_TAGS] - [-r RESULT_TAG] [-S DAY_START] [-R DAY_RANGE] [-O DAY_OFFSET] - [-P PARAMETERS] [-l PARAMETER_FILE] - [--example_rules EXAMPLE_RULES] - + [-y RULES_DIRECTORY] [-q] [-f] [-x] [-D] [-d] [-p] + [-t SOURCE_TAGS] [-r RESULT_TAG] [-S DAY_START] [-R DAY_RANGE] + [-O DAY_OFFSET] [-P PARAMETERS] [-l PARAMETER_FILE] + [-M MAP_RESULTS] [--data-file DATA_FILE] + [--example_rules EXAMPLE_RULES] + Inferno: a python map/reduce library powered by disco. - + optional arguments: -h, --help show this help message and exit -v, --version show program's version number and exit @@ -23,6 +24,9 @@ Inferno Command Line Interface execute . immediately and exit -y RULES_DIRECTORY, --rules-directory RULES_DIRECTORY directory to search for Inferno rules + -q, --just-query print out the blobs of the source query and generated + SQL, but don't execute the rule (only useful for + debugging rules in immediate mode) -f, --force force processing of blobs -x, --start-paused start Inferno without starting any automatic rules (pause mode) @@ -43,5 +47,11 @@ Inferno Command Line Interface additional rule parameters (in yaml) -l PARAMETER_FILE, --parameter-file PARAMETER_FILE additional rule parameters (in a yaml file) + -M MAP_RESULTS, --map-results MAP_RESULTS + skip map phase - use the supplied job id to get map + results to send to reduce for this rule + --data-file DATA_FILE + arbitrary data file made available to job --example_rules EXAMPLE_RULES create example rules + diff --git a/doc/index.rst b/doc/index.rst index 9610364..534287b 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -44,6 +44,7 @@ Table of Contents counting election daemon + workflow keyset rule command diff --git a/doc/keyset.rst b/doc/keyset.rst index 7adc4d4..dee5621 100644 --- a/doc/keyset.rst +++ b/doc/keyset.rst @@ -122,6 +122,8 @@ Example field_transforms: parts_postprocess ----------------- +The **parts_postprocess** happen after the **map_function** is called. + key_parts --------- diff --git a/doc/settings.rst b/doc/settings.rst index f0446e8..221bba1 100644 --- a/doc/settings.rst +++ b/doc/settings.rst @@ -22,7 +22,7 @@ put those rules so that we can test your Inferno install. Settings File ------------- -On a development machine, the recommended place to put Inferno settings is: +On a development machine, the recommended place to put Inferno settings is: **~/.inferno** 1. Create a file called ``.inferno`` in your home directory. @@ -36,3 +36,5 @@ When you're done, it should look something like the following. diana@ubuntu:~$ cat /home/diana/.inferno server: localhost rules_directory: /home/diana/example_rules + +Note: The other place inferno looks for these settings is inside **/etc/inferno/settings.yaml** \ No newline at end of file