From b974c2943aca1233227295ae7a00890d90c8a61f Mon Sep 17 00:00:00 2001 From: Masaya Suzuki Date: Tue, 30 May 2023 15:27:45 -0700 Subject: [PATCH] doc: Update the style (#140) Try to align with the Git man pages as much as possible. --- docs/av-commit-amend.1.md | 21 ++++++++++++++------- docs/av-commit-create.1.md | 24 +++++++++++++++--------- 2 files changed, 29 insertions(+), 16 deletions(-) diff --git a/docs/av-commit-amend.1.md b/docs/av-commit-amend.1.md index 460d1ef4..373e17f8 100644 --- a/docs/av-commit-amend.1.md +++ b/docs/av-commit-amend.1.md @@ -2,17 +2,24 @@ # NAME -av-commit-amend - Amend a commit. +av-commit-amend - Amend a commit + +# SYNOPSIS + +`av commit amend [-m | --message=] [--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 ---message= -Use the given as the commit message. +`-m , --message=` +: Use the given `` 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) diff --git a/docs/av-commit-create.1.md b/docs/av-commit-create.1.md index 0bd6b037..9b29d2e8 100644 --- a/docs/av-commit-create.1.md +++ b/docs/av-commit-create.1.md @@ -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 | --message=] [-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 ---message= -Use the given as the commit message. +`-m , --message=` +: Use the given `` 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)