Skip to content

Commit

Permalink
README_DOCS.rst: wordsmith some of the commentary
Browse files Browse the repository at this point in the history
It's not relevent _why_ Git fails (and, in this case, the analysis
either was wrong or later became wrong); what's relevant is that
Git has a major FAIL when dealing with reflogs of annotated/signed
tags.

It appears that the current excuse is that `git reflog show` being
just an alias for `git log -g --abbrev-commit --pretty=oneline` --
according to `git help reflog` -- means that anything other than a
commit cannot be handled since `git log` only deals with commits.

In any case the *WHY* is not important here, just the *FAIL* bit.
Take out the analysis (which might become incorrect in the future)
and just leave the relevant stuff.  Do add a mention of
`git reflog show` though as not everyone may be aware that it's
just an alias for `git log -g`.

Signed-off-by: Kyle J. McKay <[email protected]>
  • Loading branch information
mackyle committed Sep 9, 2021
1 parent 54c563f commit 78ed5a4
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README_DOCS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2062,13 +2062,12 @@ tg tag

TopGit tags are created with a reflog if core.logallrefupdates is
enabled (the default for non-bare repositories). Unfortunately Git
is incapable of showing an annotated/signed tag's reflog
(using git log -g) as it will first resolve the tag before checking to
see if it has a reflog. Git can, however, show reflogs for lightweight
tags (using git log -g) just fine but that's not helpful here. Use
``tg tag`` with the ``-g`` or ``--reflog`` option to see the reflog for
an actual tag object. This also works on non-TopGit annotated/signed
tags as well provided they have a reflog.
is incapable of showing an annotated/signed tag's reflog (using either
``git log -g`` or ``git reflog show``). Git can, however, show
reflogs for lightweight tags just fine but that's not helpful here.
Use ``tg tag`` with the ``-g`` or ``--reflog`` option to see the
reflog for an actual tag object. This also works on non-TopGit
annotated/signed tags as well provided they have a reflog.

Note that the time and date shown for reflog entries by ``tg tag -g``
is the actual time and date recorded in that reflog entry itself which
Expand Down

0 comments on commit 78ed5a4

Please sign in to comment.