From 4d2402831ac7bce4c0bd7cd60c0e77e8e4cca80d Mon Sep 17 00:00:00 2001 From: Martin von Zweigbergk Date: Mon, 9 Oct 2023 07:37:36 -0700 Subject: [PATCH] cli: describe what workspaces are in `jj workspace` help --- cli/src/commands/mod.rs | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/cli/src/commands/mod.rs b/cli/src/commands/mod.rs index 64efba6c6..774647ba6 100644 --- a/cli/src/commands/mod.rs +++ b/cli/src/commands/mod.rs @@ -1023,6 +1023,14 @@ struct BackoutArgs { } /// Commands for working with workspaces +/// +/// Workspaces let you add additional working copies attached to the same repo. +/// A common use case is so you can run a slow build or test in one workspace +/// while you're continuing to write code in another workspace. +/// +/// Each workspace has its own working-copy commit. When you have more than one +/// workspace attached to a repo, they are indicated by `@` in +/// `jj log`. #[derive(Subcommand, Clone, Debug)] enum WorkspaceCommands { Add(WorkspaceAddArgs),