git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Frederick Eaton <frederik@ofb.net>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org, Frederick Eaton <frederik@ofb.net>
Subject: [PATCH 3/3] git-describe.1: clarify that "human readable" is also git-readable
Date: Wed, 19 Sep 2018 13:12:31 -0700	[thread overview]
Message-ID: <20180919201231.609-4-frederik@ofb.net> (raw)
In-Reply-To: <20180919201231.609-1-frederik@ofb.net>

The caption uses the term "human readable", but the DESCRIPTION did
not explain this in context.

Signed-off-by: Frederick Eaton <frederik@ofb.net>
---
 Documentation/git-describe.txt | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
index e027fb8c4..ccdc5f83d 100644
--- a/Documentation/git-describe.txt
+++ b/Documentation/git-describe.txt
@@ -18,7 +18,9 @@ The command finds the most recent tag that is reachable from a
 commit.  If the tag points to the commit, then only the tag is
 shown.  Otherwise, it suffixes the tag name with the number of
 additional commits on top of the tagged object and the
-abbreviated object name of the most recent commit.
+abbreviated object name of the most recent commit. The result
+is a "human-readable" object name which can also be used to
+identify the commit to other git commands.
 
 By default (without --all or --tags) `git describe` only shows
 annotated tags.  For more information about creating annotated tags
-- 
2.19.0


  parent reply	other threads:[~2018-09-19 20:53 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-09-19 20:12 [PATCH 0/3] some documentation changes from the beginning of the alphabet Frederick Eaton
2018-09-19 20:12 ` [PATCH 1/3] git-archimport.1: specify what kind of Arch we're talking about Frederick Eaton
2018-09-19 22:59   ` Junio C Hamano
2018-09-19 23:13     ` frederik
2018-09-19 20:12 ` [PATCH 2/3] git-column.1: clarify initial description, provide examples Frederick Eaton
2018-09-19 22:59   ` Junio C Hamano
2018-09-20 16:23     ` Duy Nguyen
2018-09-20 17:47       ` frederik
2018-09-21  5:32         ` Eric Sunshine
2018-09-21 16:32         ` Junio C Hamano
2018-09-21 16:48           ` frederik
2018-09-19 20:12 ` Frederick Eaton [this message]
2018-09-19 22:49 ` [PATCH 0/3] some documentation changes from the beginning of the alphabet Junio C Hamano
2018-09-21  5:18   ` Eric Sunshine
2018-09-21  5:45     ` frederik

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180919201231.609-4-frederik@ofb.net \
    --to=frederik@ofb.net \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).