client: Document CacheRef syntax in help

Ref: #25
This commit is contained in:
Zhaofeng Li 2023-02-16 14:01:27 -07:00
parent 863f8dcca3
commit 5a23cda073
4 changed files with 12 additions and 0 deletions

View file

@ -33,6 +33,9 @@ enum Command {
#[derive(Debug, Clone, Parser)]
struct Create {
/// Name of the cache to create.
///
/// This can be either `servername:cachename` or `cachename`
/// when using the default server.
cache: CacheRef,
/// Make the cache public.

View file

@ -16,6 +16,9 @@ use attic::nix_store::NixStore;
#[derive(Debug, Parser)]
pub struct Push {
/// The cache to push to.
///
/// This can be either `servername:cachename` or `cachename`
/// when using the default server.
cache: CacheRef,
/// The store paths to push.

View file

@ -13,6 +13,9 @@ use crate::nix_netrc::NixNetrc;
#[derive(Debug, Parser)]
pub struct Use {
/// The cache to configure.
///
/// This can be either `servername:cachename` or `cachename`
/// when using the default server.
cache: CacheRef,
}

View file

@ -17,6 +17,9 @@ use attic::nix_store::{NixStore, StorePath};
#[derive(Debug, Parser)]
pub struct WatchStore {
/// The cache to push to.
///
/// This can be either `servername:cachename` or `cachename`
/// when using the default server.
cache: CacheRef,
/// Push the new paths only and do not compute closures.