From bcf22b4265b30a780d0a5218385bc7412adadbe4 Mon Sep 17 00:00:00 2001 From: Ian O'Connell Date: Thu, 15 Oct 2020 19:07:49 -0600 Subject: [PATCH] Add docs onto command --- src/jvm_indexer/jvm_indexer_app.rs | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/jvm_indexer/jvm_indexer_app.rs b/src/jvm_indexer/jvm_indexer_app.rs index f37011e..c49d853 100644 --- a/src/jvm_indexer/jvm_indexer_app.rs +++ b/src/jvm_indexer/jvm_indexer_app.rs @@ -30,21 +30,31 @@ use tokio::sync::{broadcast, Mutex}; #[derive(Clap, Debug)] #[clap(name = "basic")] struct Opt { + /// Optional if you have some restrictions/needs where the server bazel will connect to should bind + /// default to a random port on 127.0.0.1 #[clap(long, env = "BIND_ADDRESS")] bind_address: Option, + /// Where to find the bazel to invoke, if its just on your path `which bazel` could be passed here. #[clap(long, parse(from_os_str))] bazel_binary_path: PathBuf, + /// Where the output index should be stored #[clap(long, env = "INDEX_OUTPUT_LOCATION", parse(from_os_str))] index_output_location: PathBuf, + /// Paths to ignore for dependencies, a good value here when working with scala code is `io_bazel_rules_scala` #[clap(long)] blacklist_remote_roots: Vec, + /// Extra rules other than the default java,scala,java proto, scala proto rules to allow jars from #[clap(long)] extra_allowed_rule_kinds: Option>, + /// An optional bazel deps root, something like `@third_party_jvm` + /// when present we will use this root to try calculate the mapping of a bazel deps + /// to underlying raw jar. Then apply that reverse mapping so missing dependencies/the index built + /// will use the bazel deps entry rather than the raw jar. #[clap(long)] bazel_deps_root: Option, }