Skip to content

Commit

Permalink
feat: Add av commit create man page (#127)
Browse files Browse the repository at this point in the history
per title, adding to #124
  • Loading branch information
ohcnivek authored May 25, 2023
1 parent 255c55f commit 6528c2d
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 13 deletions.
21 changes: 21 additions & 0 deletions docs/av-commit-create.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# av-commit-create 1 "" av-cli "Aviator CLI User Manual"

# NAME

av-commit-create - Record changes to the repository with commits.

# DESCRIPTION

Create a new commit containing the current contents of the index and the given log message describing the changes, then run **av stack sync** on all subsequent child branches with the new commit.

Previous to running **av-commit-create**, add changes to the index via **git-add** to incrementally "add" changes to the index.

# OPTIONS

-m <msg>
--message=<msg>
Use the given <msg> as the commit message.

-a
--all
Automatically stage modified/ deleted files, but new files you have not told Git about are not affected. (Same as git commit --all)
27 changes: 14 additions & 13 deletions docs/av.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,21 @@ av - Aviator CLI

# SUBCOMMANDS

* av-commit-split(1): Split a commit into multiple commits.
* av-fetch(1): Fetch latest state from GitHub.
* av-init(1): Initialize the Git repository for Aviator CLI.
* av-pr-create(1): Create a pull request for the current branch.
* av-stack-branch(1): Create a new stacked branch.
* av-stack-branch-commit(1): Create a new stacked branch and commit staged
- av-commit-create(1): Create a new commit.
- av-commit-split(1): Split a commit into multiple commits.
- av-fetch(1): Fetch latest state from GitHub.
- av-init(1): Initialize the Git repository for Aviator CLI.
- av-pr-create(1): Create a pull request for the current branch.
- av-stack-branch(1): Create a new stacked branch.
- av-stack-branch-commit(1): Create a new stacked branch and commit staged
changes to it.
* av-stack-diff(1): Generate diff between working tree and the parent branch.
* av-stack-next(1): Checkout the next branch in the stack.
* av-stack-prev(1): Checkout the previous branch in the stack.
* av-stack-submit(1): Create/synchronize pull requests for the current stack.
* av-stack-sync(1): Synchronize stacked branches.
* av-stack-tidy(1): Tidy up the branch metadata.
* av-stack-tree(1): Show the tree of stacked branches.
- av-stack-diff(1): Generate diff between working tree and the parent branch.
- av-stack-next(1): Checkout the next branch in the stack.
- av-stack-prev(1): Checkout the previous branch in the stack.
- av-stack-submit(1): Create/synchronize pull requests for the current stack.
- av-stack-sync(1): Synchronize stacked branches.
- av-stack-tidy(1): Tidy up the branch metadata.
- av-stack-tree(1): Show the tree of stacked branches.

# FURTHER DOCUMENTATION

Expand Down

0 comments on commit 6528c2d

Please sign in to comment.