[incubator-pinot] branch fixing_admin_cmd_exit_code updated: Adding comments for pinot-admin cmd

[xi...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

xiangfu pushed a commit to branch fixing_admin_cmd_exit_code
in repository https://gitbox.apache.org/repos/asf/incubator-pinot.git


The following commit(s) were added to refs/heads/fixing_admin_cmd_exit_code by this push:
     new aa3ca47  Adding comments for pinot-admin cmd
aa3ca47 is described below

commit aa3ca47492ff5041c3af29303ba9319cec2133d5
Author: Xiang Fu <xi...@traceable.ai>
AuthorDate: Mon Apr 15 14:05:23 2019 -0700

    Adding comments for pinot-admin cmd
---
 .../java/org/apache/pinot/tools/admin/PinotAdministrator.java  | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/pinot-tools/src/main/java/org/apache/pinot/tools/admin/PinotAdministrator.java b/pinot-tools/src/main/java/org/apache/pinot/tools/admin/PinotAdministrator.java
index df4ab08..f56b96b 100644
--- a/pinot-tools/src/main/java/org/apache/pinot/tools/admin/PinotAdministrator.java
+++ b/pinot-tools/src/main/java/org/apache/pinot/tools/admin/PinotAdministrator.java
@@ -63,6 +63,16 @@ import org.slf4j.LoggerFactory;
 /**
  * Class to implement Pinot Administrator, that provides the following commands:
  *
+ * System property: `pinot.admin.system.exit`(default to false) is used to decide if System.exit(...) will be called with exit code.
+ *
+ * Sample Usage in Commandline:
+ *  JAVA_OPTS="-Xms4G -Xmx4G -Dpinot.admin.system.exit=true" \
+ *  bin/pinot-admin.sh AddSchema \
+ *    -schemaFile /my/path/to/schema/schema.json \
+ *    -controllerHost localhost \
+ *    -controllerPort 9000 \
+ *    -exec
+ *
  */
 public class PinotAdministrator {
   private static final Logger LOGGER = LoggerFactory.getLogger(PinotAdministrator.class);


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pinot.apache.org
For additional commands, e-mail: commits-help@pinot.apache.org