diff options
| author | Junio C Hamano <gitster@pobox.com> | 2017-12-28 14:08:50 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2017-12-28 14:08:50 -0800 |
| commit | 556de1a8e38ff03d31fd35751582447001f39d0c (patch) | |
| tree | 312f912aa8071e9011bb5ac96657192257dafb88 /Documentation | |
| parent | 0433d533f13671f4313c31e34707f0f5281a18e0 (diff) | |
| parent | 644eb60bd01a15f665b63774fd80e3b6316073a1 (diff) | |
| download | git-556de1a8e38ff03d31fd35751582447001f39d0c.tar.gz git-556de1a8e38ff03d31fd35751582447001f39d0c.tar.xz | |
Merge branch 'sb/describe-blob'
"git describe" was taught to dig trees deeper to find a
<commit-ish>:<path> that refers to a given blob object.
* sb/describe-blob:
builtin/describe.c: describe a blob
builtin/describe.c: factor out describe_commit
builtin/describe.c: print debug statements earlier
builtin/describe.c: rename `oid` to avoid variable shadowing
revision.h: introduce blob/tree walking in order of the commits
list-objects.c: factor out traverse_trees_and_blobs
t6120: fix typo in test name
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/git-describe.txt | 18 | ||||
| -rw-r--r-- | Documentation/rev-list-options.txt | 5 |
2 files changed, 21 insertions, 2 deletions
diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt index c924c945b..e027fb8c4 100644 --- a/Documentation/git-describe.txt +++ b/Documentation/git-describe.txt @@ -3,14 +3,14 @@ git-describe(1) NAME ---- -git-describe - Describe a commit using the most recent tag reachable from it - +git-describe - Give an object a human readable name based on an available ref SYNOPSIS -------- [verse] 'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] [<commit-ish>...] 'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] --dirty[=<mark>] +'git describe' <blob> DESCRIPTION ----------- @@ -24,6 +24,12 @@ By default (without --all or --tags) `git describe` only shows annotated tags. For more information about creating annotated tags see the -a and -s options to linkgit:git-tag[1]. +If the given object refers to a blob, it will be described +as `<commit-ish>:<path>`, such that the blob can be found +at `<path>` in the `<commit-ish>`, which itself describes the +first commit in which this blob occurs in a reverse revision walk +from HEAD. + OPTIONS ------- <commit-ish>...:: @@ -186,6 +192,14 @@ selected and output. Here fewest commits different is defined as the number of commits which would be shown by `git log tag..input` will be the smallest number of commits possible. +BUGS +---- + +Tree objects as well as tag objects not pointing at commits, cannot be described. +When describing blobs, the lightweight tags pointing at blobs are ignored, +but the blob is still described as <committ-ish>:<path> despite the lightweight +tag being favorable. + GIT --- Part of the linkgit:git[1] suite diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt index 8d8b7f492..22f5c9b43 100644 --- a/Documentation/rev-list-options.txt +++ b/Documentation/rev-list-options.txt @@ -686,6 +686,11 @@ ifdef::git-rev-list[] all object IDs which I need to download if I have the commit object _bar_ but not _foo_''. +--in-commit-order:: + Print tree and blob ids in order of the commits. The tree + and blob ids are printed after they are first referenced + by a commit. + --objects-edge:: Similar to `--objects`, but also print the IDs of excluded commits prefixed with a ``-'' character. This is used by |