use <> in options/arguments section This closes #903 PR.
Project: http://git-wip-us.apache.org/repos/asf/incubator-hawq/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-hawq/commit/b37f1876 Tree: http://git-wip-us.apache.org/repos/asf/incubator-hawq/tree/b37f1876 Diff: http://git-wip-us.apache.org/repos/asf/incubator-hawq/diff/b37f1876 Branch: refs/heads/master Commit: b37f18768dceec5600f8a90f6f8b17045954629c Parents: c0d086d Author: Lisa Owen <[email protected]> Authored: Wed Feb 22 09:52:58 2017 -0800 Committer: Ed Espino <[email protected]> Committed: Wed Feb 22 11:02:41 2017 -0800 ---------------------------------------------------------------------- tools/doc/gpcheck_help | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-hawq/blob/b37f1876/tools/doc/gpcheck_help ---------------------------------------------------------------------- diff --git a/tools/doc/gpcheck_help b/tools/doc/gpcheck_help index 3ff35b5..1e35b95 100644 --- a/tools/doc/gpcheck_help +++ b/tools/doc/gpcheck_help @@ -58,23 +58,23 @@ An example is shown below: OPTIONS ***************************************************** ---config config_file +--config <config_file> The name of a configuration file to use instead of the default file $GPHOME/etc/hawq_check.cnf. --f hostfile_hawq_check +-f <hostfile_hawq_check> The name of a file that contains a list of hosts that hawq check uses to validate platform-specific settings. This file should contain a single host name for all hosts in your HAWQ system (master, standby master, and segments). --h/--host hostname +-h/--host <hostname> Specifies a single host on which platform-specific settings will be validated. ---hadoop/--hadoop-home hadoop_home +--hadoop/--hadoop-home <hadoop_home> Use this option to specify the full path to your hadoop installation location so that hawq check can validate HDFS settings. This option @@ -121,7 +121,7 @@ OPTIONS performed. ---zipin hawq_check_zipfile +--zipin <hawq_check_zipfile> Use this option to decompress and check a .zip file created with the --zipout option. hawq check performs validation tasks against @@ -142,7 +142,7 @@ OPTIONS EXAMPLES ***************************************************** -Verify and validate the HAWQ platform settings by specifying +Verify and validate the HAWQ platform settings by specifying a host file and identifying the full hadoop install path: # hawq check -f hostfile_hawq_check --hadoop /usr/local/hadoop-<version>/
