document garage crate

This commit is contained in:
Trinity Pointard 2021-03-26 22:36:23 +01:00
parent a74eccfd6e
commit 653d3d588f

View File

@ -1,4 +1,6 @@
#![deny(missing_crate_level_docs, missing_docs)]
#![recursion_limit = "1024"] #![recursion_limit = "1024"]
//! Garage CLI, used to interact with a running Garage instance, and to launch a Garage
#[macro_use] #[macro_use]
extern crate log; extern crate log;
@ -25,7 +27,7 @@ use cli::*;
#[derive(StructOpt, Debug)] #[derive(StructOpt, Debug)]
#[structopt(name = "garage")] #[structopt(name = "garage")]
pub struct Opt { struct Opt {
/// RPC connect to this host to execute client operations /// RPC connect to this host to execute client operations
#[structopt(short = "h", long = "rpc-host", default_value = "127.0.0.1:3901")] #[structopt(short = "h", long = "rpc-host", default_value = "127.0.0.1:3901")]
pub rpc_host: SocketAddr, pub rpc_host: SocketAddr,