Skip to content

Commit

Permalink
Update the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewshadura committed Mar 19, 2022
1 parent 2248dc1 commit 2db12d5
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ split large changes into several smaller changesets.
Installation
------------

git-crecord assumes you have Python 3.6 or later installed as ``/usr/bin/python3``.
git-crecord assumes you have Python 3.9 or later installed as ``/usr/bin/python3``.

git-crecord ships with a setup.py installer based on setuptools.
To install git-crecord, simply type::
Expand Down
5 changes: 3 additions & 2 deletions git-crecord.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,9 @@ OPTIONS
--author=AUTHOR Override the commit author. Specify an explicit author using the standard ``A U Thor <author@example.com>`` format. Otherwise `AUTHOR` is assumed to be a pattern and is used to search for an existing commit by that author (i.e. ``rev-list --all -i --author=AUTHOR``); the commit author is then copied from the first such commit found.
--date=DATE Override the author date used in the commit.
-m MESSAGE, --message=MESSAGE Use the given `MESSAGE` as the commit message. If multiple ``-m`` options are given, their values are concatenated as separate paragraphs.
-C COMMIT, --reuse-message=COMMIT Take an existing commit object, and reuse the log message and the authorship information (including the timestamp) when creating the commit.
-c COMMIT, --reedit-message=COMMIT Like ``-C``, but with ``-c`` the editor is invoked, so that the user can further edit the commit message.
-C COMMIT, --reuse-message=COMMIT Reuse the commit message and the authorship information (including the timestamp) of the given commit.
-c COMMIT, --reedit-message=COMMIT Like ``-C``, but invoke an editor to allow the user to edit the commit message.
--fixup COMMIT Automatically create the commit message by prepending "fixup!" to the commit message of the given commit.
--reset-author When used with ``-C``/``-c``/``--amend`` options, or when committing after a conflicting cherry-pick, declare that the authorship of the resulting commit now belongs to the committer. This also renews the author timestamp.
-s, --signoff Add ``Signed-off-by`` line by the committer at the end of the commit log message.
--amend Amend previous commit. Replace the tip of the current branch by creating a new commit. The message from the original commit is used as the starting point, instead of an empty message, when no other message is specified from the command line via ``-m`` option. The new commit has the same parents and author as the current one.
Expand Down

0 comments on commit 2db12d5

Please # to comment.