adding generic Hadoop options to help and doc

Merck · Aug 22, 2018 · d91ede7 · d91ede7
1 parent e20b413
commit d91ede7
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 3 deletions.
diff --git a/docs/tools.md b/docs/tools.md
@@ -60,8 +60,9 @@ exit, quit  Exit the console
 ### Halyard
 ```
 $ ./halyard -h
-usage: halyard [<command> [-h] ... | -h | -v ]
-commands:
+usage: halyard [<genericHadoopOptions>] [ -h | -v | <command> [-h] ...]
+
+commands are:
 ----------------------------------------------------------------------------------------------------
 presplit   Halyard Presplit is a MapReduce application designed to estimate optimal HBase region
            splits for big datasets before the Bulk Load.Halyard PreSplit creates an empty HBase
@@ -104,6 +105,17 @@ bulkexport Halyard Bulk Export is a MapReduce application that executes multiple
            distribute the query evaluation across the executed parallel forks of the same query.
 bulkdelete Halyard Bulk Delete is a MapReduce application that effectively deletes large set of
            triples or whole named graphs, based on specified statement pattern and/or graph context.
+
+genericHadoopOptions are:
+----------------------------------------------------------------------------------------------------
+-conf <configuration file>                   specify an application configuration file
+-D <property=value>                          use value for given property
+-fs <local|namenode:port>                    specify a namenode
+-jt <local|jobtracker:port>                  specify a job tracker
+-files <comma separated list of files>       specify comma separated files to be copied to the map
+                                             reduce cluster
+-archives <comma separated list of archives> specify comma separated archives to be unarchived on
+                                             the compute machines.
 ```
 
 ### Halyard PreSplit

diff --git a/tools/src/main/java/com/msd/gin/halyard/tools/HalyardMain.java b/tools/src/main/java/com/msd/gin/halyard/tools/HalyardMain.java
@@ -59,10 +59,18 @@ public static void main(String args[]) throws Exception {
             } finally {
                 PrintWriter pw = new PrintWriter(System.out);
                 HelpFormatter hf = new HelpFormatter();
-                hf.printWrapped(pw, 100, "usage: halyard [<command> [-h] ... | -h | -v ]\ncommands:\n----------------------------------------------------------------------------------------------------");
+                hf.printWrapped(pw, 100, "usage: halyard [<genericHadoopOptions>] [ -h | -v | <command> [-h] ...]");
+                hf.printWrapped(pw, 100, "\ncommands are:\n----------------------------------------------------------------------------------------------------");
                 for (AbstractHalyardTool tool : tools) {
                     hf.printWrapped(pw, 100, 11, tool.name + "           ".substring(tool.name.length()) + tool.header);
                 }
+                hf.printWrapped(pw, 100, 0, "\ngenericHadoopOptions are:\n----------------------------------------------------------------------------------------------------");
+                hf.printWrapped(pw, 100, 45, "-conf <configuration file>                   specify an application configuration file");
+                hf.printWrapped(pw, 100, 45, "-D <property=value>                          use value for given property");
+                hf.printWrapped(pw, 100, 45, "-fs <local|namenode:port>                    specify a namenode");
+                hf.printWrapped(pw, 100, 45, "-jt <local|jobtracker:port>                  specify a job tracker");
+                hf.printWrapped(pw, 100, 45, "-files <comma separated list of files>       specify comma separated files to be copied to the map reduce cluster");
+                hf.printWrapped(pw, 100, 45, "-archives <comma separated list of archives> specify comma separated archives to be unarchived on the compute machines.");
                 pw.flush();
             }
         }