Git development
 help / color / mirror / Atom feed
From: Jonathan Nieder <jrnieder@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: Ramkumar Ramachandra <artagnon@gmail.com>,
	Git Mailing List <git@vger.kernel.org>,
	Thomas Ackermann <th.acker@arcor.de>
Subject: [PATCH/RFC] glossary: a revision is just a commit
Date: Sun, 21 Apr 2013 01:17:05 -0700	[thread overview]
Message-ID: <20130421081705.GG10429@elie.Belkin> (raw)
In-Reply-To: <CAPc5daVcovqrHP-YWnkcQWwev5TW5S8ioX-bWyAnNG2PTg_XMw@mail.gmail.com>

The current definition of 'revision' sounds like it is saying that a
revision is a tree object.  In reality it is just a commit.

This should be especially useful for people used to other revision
control systems trying to see how familiar concepts translate into git
terms.

Reported-by: Ramkumar Ramachandra <artagnon@gmail.com>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---
Junio C Hamano wrote:
> On Apr 21, 2013 12:41 AM, "Jonathan Nieder" <jrnieder@gmail.com> wrote:

>>> revision:: A particular state of files and directories which was
>>> stored in the object database. It is referenced by a commit object.
>>
>> So a revision is a tree?
[...]
> That's a historical misnomer. Some places in the documentation use revision
> as if the word were interchangeable with object name, and HEAD:path listed
> in specifying revision section is a prime example of it. What the section
> lists is historically called extended SHA-1 expression, essentially what
> get_sha1() can grok down to a single object name (as opposed to a slice of
> history, which is a revision range).

Thanks.

 Documentation/glossary-content.txt | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
index eb7ba84f..521fceeb 100644
--- a/Documentation/glossary-content.txt
+++ b/Documentation/glossary-content.txt
@@ -430,9 +430,7 @@ should not be combined with other pathspec.
 	<<def_merge,merge>> left behind.
 
 [[def_revision]]revision::
-	A particular state of files and directories which was stored in the
-	<<def_object_database,object database>>. It is referenced by a
-	<<def_commit_object,commit object>>.
+	Synonym for <<def_commit,commit>> (the noun).
 
 [[def_rewind]]rewind::
 	To throw away part of the development, i.e. to assign the
-- 
1.8.2.1

  parent reply	other threads:[~2013-04-21  8:17 UTC|newest]

Thread overview: 35+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-04-20 11:45 [PATCH 0/5] Documentation/shortlog improvements Ramkumar Ramachandra
2013-04-20 11:45 ` [PATCH 1/5] git-shortlog.txt: remove (-h|--help) from OPTIONS Ramkumar Ramachandra
2013-04-20 11:45 ` [PATCH 2/5] builtin/shortlog.c: make usage string consistent with log Ramkumar Ramachandra
2013-04-20 11:45 ` [PATCH 3/5] git-log.txt: fix description of <since>..<until> Ramkumar Ramachandra
2013-04-20 22:25   ` Jonathan Nieder
2013-04-21  7:18     ` Ramkumar Ramachandra
2013-04-21  7:41       ` Jonathan Nieder
     [not found]         ` <CAPc5daVcovqrHP-YWnkcQWwev5TW5S8ioX-bWyAnNG2PTg_XMw@mail.gmail.com>
2013-04-21  8:17           ` Jonathan Nieder [this message]
2013-04-21 19:00             ` [PATCH/RFC] glossary: a revision is just a commit Junio C Hamano
2013-04-21  7:19     ` [PATCH 3/5] git-log.txt: fix description of <since>..<until> Junio C Hamano
2013-04-21  6:40   ` Junio C Hamano
2013-04-20 11:45 ` [PATCH 4/5] git-log.txt: rewrite note on why "--" may be required Ramkumar Ramachandra
2013-04-21  6:51   ` Junio C Hamano
2013-04-21  7:26     ` Ramkumar Ramachandra
2013-04-21  7:33       ` Junio C Hamano
2013-04-21  7:38         ` Ramkumar Ramachandra
2013-04-21  7:46           ` Junio C Hamano
2013-04-21  8:00             ` Ramkumar Ramachandra
2013-04-21  8:09               ` Jonathan Nieder
2013-04-21  8:15                 ` Ramkumar Ramachandra
2013-04-21  8:17                   ` Jonathan Nieder
2013-04-21  8:33                 ` Junio C Hamano
2013-04-21  9:05                   ` Ramkumar Ramachandra
2013-04-21  9:46                     ` Ramkumar Ramachandra
2013-04-21 10:09                     ` Jonathan Nieder
     [not found]               ` <CAPc5daV39HsoRR2pj34Tz1kQKFVRrp+NZpMM2BremocqvToA+A@mail.gmail.com>
2013-04-21  8:13                 ` Ramkumar Ramachandra
2013-04-21  8:23                   ` Ramkumar Ramachandra
2013-04-21  7:39         ` Junio C Hamano
2013-04-21  7:57           ` Ramkumar Ramachandra
2013-04-22  2:40     ` Junio C Hamano
2013-04-22  9:36       ` Thomas Rast
2013-04-22  9:40         ` Thomas Rast
2013-04-22 14:55           ` Junio C Hamano
2013-04-20 11:45 ` [PATCH 5/5] git-shortlog.txt: make SYNOPSIS match log, update OPTIONS Ramkumar Ramachandra
2013-04-21  7:04   ` Junio C Hamano

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

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

  git send-email \
    --in-reply-to=20130421081705.GG10429@elie.Belkin \
    --to=jrnieder@gmail.com \
    --cc=artagnon@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=th.acker@arcor.de \
    /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.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox