Skip to content

Commit 77f8d99

Browse files
committed
Merge branch 'kh/doc-committer-date-is-author-date'
The "--committer-date-is-author-date" option of "git am/rebase" is a misguided one. The documentation is updated to discourage its use. * kh/doc-committer-date-is-author-date: doc: warn against --committer-date-is-author-date
2 parents 0534b78 + fbf3d06 commit 77f8d99

2 files changed

Lines changed: 14 additions & 0 deletions

File tree

Documentation/git-am.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,13 @@ Valid <action> for the `--whitespace` option are:
162162
commit creation as the committer date. This allows the
163163
user to lie about the committer date by using the same
164164
value as the author date.
165+
+
166+
WARNING: The history walking machinery assumes that commits have
167+
non-decreasing commit timestamps. You should consider if you really need
168+
to use this option. Then you should only use this option to override the
169+
committer date when applying commits on top of a base which commit is
170+
older (in terms of the commit date) than the oldest patch you are
171+
applying.
165172

166173
--ignore-date::
167174
By default the command records the date from the e-mail

Documentation/git-rebase.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -474,6 +474,13 @@ See also INCOMPATIBLE OPTIONS below.
474474
Instead of using the current time as the committer date, use
475475
the author date of the commit being rebased as the committer
476476
date. This option implies `--force-rebase`.
477+
+
478+
WARNING: The history walking machinery assumes that commits have
479+
non-decreasing commit timestamps. You should consider if you really need
480+
to use this option. Then you should only use this option to override the
481+
committer date when rebasing commits on top of a base which commit is
482+
older (in terms of the commit date) than the oldest commit you are
483+
applying (in terms of the author date).
477484

478485
--ignore-date::
479486
--reset-author-date::

0 commit comments

Comments
 (0)