From 84706491df1ea648f62225997df2be3535e0fa6d Mon Sep 17 00:00:00 2001
From: Ankit Jain <ankit.dce@gmail.com>
Date: Mon, 5 Jun 2023 11:39:10 -0700
Subject: [PATCH] doc: Add manpage for av stack branch-commit (#156)

---
 docs/av-stack-branch-commit.1.md | 27 +++++++++++++++++++++++++++
 docs/av-stack-branch.1.md        | 28 ++++++++++++++++++++++++++++
 docs/av-stack-tidy.1.md          |  2 +-
 3 files changed, 56 insertions(+), 1 deletion(-)
 create mode 100644 docs/av-stack-branch-commit.1.md
 create mode 100644 docs/av-stack-branch.1.md

diff --git a/docs/av-stack-branch-commit.1.md b/docs/av-stack-branch-commit.1.md
new file mode 100644
index 00000000..df7612f6
--- /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> | --branch-name <branch_name>]
+[-m <msg>| --message=<msg>]`
+
+# 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>, --branch-name <branch_name>`
+: The branch name to create. If empty, automatically generate from the message.
+
+`-m <msg>, --message=<msg>`
+: Use the given `<msg>` 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 00000000..3ba75997
--- /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 <parent_branch>] <branch-name>`
+
+# 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 <parent_branch>`
+: Instead of creating a new branch from current branch, create it from
+  specified `<parent_branch>`
+
+`-m, --rename`
+: Rename the current branch to the provided `<branch_name>` instead of
+  creating a new one.
diff --git a/docs/av-stack-tidy.1.md b/docs/av-stack-tidy.1.md
index d104da68..e5fbe54e 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