diff --git a/docs/av-stack-branch-commit.1.md b/docs/av-stack-branch-commit.1.md new file mode 100644 index 0000000..df7612f --- /dev/null +++ b/docs/av-stack-branch-commit.1.md @@ -0,0 +1,27 @@ +# av-stack-branch-commit 1 "" av-cli "Aviator CLI User Manual" + +# NAME + +av-stack-branch-commit - Create a new branch in the stack with the staged changes + +# SYNOPSIS + +`av stack branch-commit [-a | --all] [-b | --branch-name ] +[-m | --message=]` + +# DESCRIPTION + +Create a new branch that is stacked on the current branch and commit all +staged changes with the specified arguments. One of `-b` or `-m` flags are +required to create the branch. + +# OPTIONS + +`-a, --all` +: Automatically stage all modified/deleted files, (same as `git commit --all`) + +`-b , --branch-name ` +: The branch name to create. If empty, automatically generate from the message. + +`-m , --message=` +: Use the given `` as the commit message. diff --git a/docs/av-stack-branch.1.md b/docs/av-stack-branch.1.md new file mode 100644 index 0000000..3ba7599 --- /dev/null +++ b/docs/av-stack-branch.1.md @@ -0,0 +1,28 @@ +# av-stack-branch 1 "" av-cli "Aviator CLI User Manual" + +# NAME + +av-stack-branch - Create or rename a branch in the stack + +# SYNOPSIS + +`av stack branch [-m | --rename] [--parent ] ` + +# DESCRIPTION + +Create a new branch that is stacked on the current branch by default + +If the --rename/-m flag is given, the current branch is renamed to the name +instead of creating a new branch. Branches should only be renamed +with this command (not with git branch -m ...) because av needs to update +internal tracking metadata that defines the order of branches within a stack. + +# OPTIONS + +`--parent ` +: Instead of creating a new branch from current branch, create it from + specified `` + +`-m, --rename` +: Rename the current branch to the provided `` instead of + creating a new one. diff --git a/docs/av-stack-tidy.1.md b/docs/av-stack-tidy.1.md index d104da6..e5fbe54 100644 --- a/docs/av-stack-tidy.1.md +++ b/docs/av-stack-tidy.1.md @@ -2,7 +2,7 @@ # NAME -av-stack-tidy - Record changes to the repository with commits +av-stack-tidy - Tidy stacked branches by removing deleted or merged branches # SYNOPSIS