Skip to content

Commit

Permalink
doc: Update the style (#140)
Browse files Browse the repository at this point in the history
Try to align with the Git man pages as much as possible.
  • Loading branch information
draftcode authored May 30, 2023
1 parent b28f075 commit b974c29
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 16 deletions.
21 changes: 14 additions & 7 deletions docs/av-commit-amend.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,24 @@

# NAME

av-commit-amend - Amend a commit.
av-commit-amend - Amend a commit

# SYNOPSIS

`av commit amend [-m <msg>| --message=<msg>] [--no-edit]`

# DESCRIPTION

The tip of the current branch can be replaced by creating a new commit. During this process, the recorded tree is prepared as per usual. In cases where no other message is specified via the command-line option -m, the message from the original commit is utilized as the initial point rather than an empty message.
The tip of the current branch can be replaced by creating a new commit. During
this process, the recorded tree is prepared as per usual. In cases where no
other message is specified via the command-line option -m, the message from the
original commit is utilized as the initial point rather than an empty message.

# OPTIONS

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

--no-edit
Amends a commit without changing its commit message. (Same as git commit --amend --no-edit)
`--no-edit`
: Amends a commit without changing its commit message. (Same as git commit
--amend --no-edit)
24 changes: 15 additions & 9 deletions docs/av-commit-create.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,26 @@

# NAME

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

# SYNOPSIS

`av commit create [-m <msg>| --message=<msg>] [-a | --all]`

# 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.
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.
Previous to running **av commit-create**, add changes to the index via
git-add(1) to incrementally "add" changes to the index.

# OPTIONS

-m <msg>
--message=<msg>
Use the given <msg> as the commit message.
`-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)
`-a, --all`
: Automatically stage modified/deleted files, but new files you have not told
Git about are not affected. (Same as git commit --all)

0 comments on commit b974c29

Please sign in to comment.