Skip to content

Commit

Permalink
amend: Update docs
Browse files Browse the repository at this point in the history
Update the doc to reflect the new conflict behavior
and settings for cleanup/comment char.
  • Loading branch information
jerry-skydio committed Mar 12, 2024
1 parent 9ea9f6a commit df29593
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions docs/amend.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,15 @@ When rewording commits, abort if the resulting message is empty.
If there are no changes to either the tree or the commit message,
no commit hashes will change.

When rewording commits, this command will respect the values for
`git config commit.cleanup` and `git config core.commentChar`.

Currently, conflicts between the cache and target commit or between
the new commit and later commits aren't handled. If any conflict arises,
the conflicting file paths will be printed and the program will exit
without making any changes.
the new commit and later commits are only handled by printing the
conflicting paths, nature of the conflict, and the conflict markers
if applicable.

In the future `revup amend` will be able to show conflict markers
and provide the user a way to resolve conflicts.
In the future `revup amend` will provide the user a way to resolve conflicts.

# OPTIONS

Expand Down

0 comments on commit df29593

Please sign in to comment.