diff options
| author | Florian Klink <flokli@flokli.de> | 2024-08-12T13·24+0300 |
|---|---|---|
| committer | clbot <clbot@tvl.fyi> | 2024-08-12T13·41+0000 |
| commit | fd64df05114ef9dfac6fe46ce990f178c6d207c5 (patch) | |
| tree | 9fafb8bd8dc733ca8f9d8994386003061290fd21 /tvix | |
| parent | 1f5a85740e2066f5fb8b7ab487805da5f7da413a (diff) | |
fix(tvix/cli): add toplevel docstring to Args struct r/8481
Otherwise the flattened `ServiceUrlsMemory` docstring becomes the main binary description, which doesn't make an awful lot of sense. The help now describes what this CLI does currently (an interface to use the different Tvix component. Also, describe what it does not, so people running it without looking too much other documentation might not get confused about why this doesn't do anything in `/nix/store`, or doesn't provide the same CLI surface as Nix. Change-Id: Ia4838b444f03a10821801a6171d3e956b3cdfdaf Reviewed-on: https://cl.tvl.fyi/c/depot/+/12194 Autosubmit: flokli <flokli@flokli.de> Reviewed-by: Connor Brewster <cbrewster@hey.com> Tested-by: BuildkiteCI
Diffstat (limited to 'tvix')
| -rw-r--r-- | tvix/cli/src/args.rs | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/tvix/cli/src/args.rs b/tvix/cli/src/args.rs index a4d1bcae157e..5b8f6b48b134 100644 --- a/tvix/cli/src/args.rs +++ b/tvix/cli/src/args.rs @@ -4,6 +4,14 @@ use clap::Parser; use tracing::Level; use tvix_store::utils::ServiceUrlsMemory; +/// Provides a CLI interface to trigger evaluation using tvix-eval. +/// +/// Uses configured tvix-[ca]store and tvix-build components, +/// and by default a set of builtins similar to these present in Nix. +/// +/// None of the stores available add to the local `/nix/store` location. +/// +/// The CLI interface is not stable and subject to change. #[derive(Parser, Clone)] pub struct Args { /// A global log level to use when printing logs. |