Skip to content

Commit

Permalink
doc: Add manpage for av stack branch-commit (#156)
Browse files Browse the repository at this point in the history
  • Loading branch information
jainankit committed Jun 5, 2023
1 parent 5e61a09 commit 8470649
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 1 deletion.
27 changes: 27 additions & 0 deletions docs/av-stack-branch-commit.1.md
Original file line number Diff line number Diff line change
@@ -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.
28 changes: 28 additions & 0 deletions docs/av-stack-branch.1.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion docs/av-stack-tidy.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 8470649

Please sign in to comment.