Files
git/Documentation
Jean Privat 9f67d2e827 Teach "git describe" --dirty option
With the --dirty option, git describe works on HEAD but append s"-dirty"
iff the contents of the work tree differs from HEAD.  E.g.

  $ git describe --dirty
  v1.6.5-15-gc274db7
  $ echo >> Makefile
  $ git describe --dirty
  v1.6.5-15-gc274db7-dirty

The --dirty option can also be used to specify what is appended, instead
of the default string "-dirty".

  $ git describe --dirty=.mod
  v1.6.5-15-gc274db7.mod

Many build scripts use `git describe` to produce a version number based on
the description of HEAD (on which the work tree is based) + saying that if
the build contains uncommitted changes.  This patch helps the writing of
such scripts since `git describe --dirty` does directly the intended thing.

Three possiblities were considered while discussing this new feature:

1. Describe the work tree by default and describe HEAD only if "HEAD" is
   explicitly specified

     Pro: does the right thing by default (both for users and for scripts)
     Pro: other git commands that works on the work tree by default
     Con: breaks existing scripts used by the Linux kernel and other projects

2. Use --worktree instead of --dirty

     Pro: does what it says: "git describe --worktree" describes the work tree
     Con: other commands do not require a --worktree option when working
          on the work tree (it often is the default mode for them)
     Con: unusable with an optional value: "git describe --worktree=.mod"
	  is quite unintuitive.

3. Use --dirty as in this patch

     Pro: makes sense to specify an optional value (what the dirty mark is)
     Pro: does not have any of the big cons of previous alternatives
	  * does not break scripts
	  * is not inconsistent with other git commands

This patch takes the third approach.

Signed-off-by: Jean Privat <jean@pryen.org>
Acked-by: Shawn O. Pearce <spearce@spearce.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2009-10-27 12:46:22 -07:00
..
2009-03-19 02:47:40 -07:00
2009-04-06 00:27:09 -07:00
2007-07-24 00:47:05 -07:00
2008-08-01 23:21:44 -07:00
2009-07-22 21:54:54 -07:00
2009-04-18 14:45:59 -07:00
2008-08-01 23:21:44 -07:00
2008-08-01 23:21:44 -07:00
2008-08-01 23:21:44 -07:00
2008-08-01 23:21:44 -07:00
2008-08-01 23:21:44 -07:00
2009-08-15 15:17:47 -07:00
2009-08-12 16:36:04 -07:00
2008-08-08 18:27:19 -07:00
2008-08-01 23:21:44 -07:00
2008-08-01 23:21:44 -07:00
2008-08-01 23:21:44 -07:00
2009-10-10 00:05:19 -07:00
2007-06-07 00:04:01 -07:00
2007-06-07 00:04:01 -07:00
2007-06-07 00:04:01 -07:00
2007-04-21 13:57:07 -07:00
2007-06-07 00:04:01 -07:00
2007-05-08 22:11:17 -07:00
2007-05-20 00:15:53 -07:00
2007-05-20 00:15:53 -07:00
2007-04-03 22:47:01 -07:00
2007-06-02 16:02:49 -07:00
2007-07-02 00:35:58 -07:00
2007-07-12 12:01:47 -07:00
2007-08-15 15:01:20 -07:00
2007-09-19 03:11:28 -07:00
2008-01-29 22:00:34 -08:00
2007-10-03 02:33:48 -07:00
2007-11-18 14:00:38 -08:00
2007-12-01 11:20:00 -08:00
2008-01-07 22:41:43 -08:00
2008-02-17 00:20:38 -08:00
2008-02-17 00:20:38 -08:00
2008-02-23 11:31:04 -08:00
2008-06-26 17:11:21 -07:00
2008-12-16 22:06:47 -08:00
2008-02-01 19:10:10 -08:00
2008-04-20 11:36:53 -07:00
2008-05-25 21:11:24 -07:00
2008-05-27 22:32:47 -07:00
2008-06-07 11:45:48 -07:00
2008-06-26 17:59:51 -07:00
2008-12-16 22:08:28 -08:00
2008-04-07 21:57:43 -07:00
2008-06-25 17:13:48 -07:00
2008-07-04 01:38:41 -07:00
2008-07-13 15:23:43 -07:00
2008-07-19 10:58:01 -07:00
2008-08-06 13:40:53 -07:00
2008-12-16 22:13:36 -08:00
2008-06-18 13:09:43 -07:00
2008-08-24 14:47:24 -07:00
2008-10-21 13:37:42 -07:00
2008-12-07 15:11:54 -08:00
2008-12-19 19:27:35 -08:00
2008-08-17 11:42:10 -07:00
2009-02-07 00:51:47 -08:00
2009-05-03 15:29:31 -07:00
2008-12-24 19:41:08 -08:00
2009-03-15 13:05:05 -07:00
2009-04-02 12:34:16 -07:00
2009-04-12 15:57:58 -07:00
2009-04-19 17:34:26 -07:00
2009-05-03 16:54:14 -07:00
2009-03-03 23:37:19 -08:00
2009-05-12 22:30:29 -07:00
2009-06-03 22:47:48 -07:00
2009-06-21 21:15:50 -07:00
2009-07-28 23:59:30 -07:00
2009-05-06 18:16:40 -07:00
2009-08-21 20:16:10 -07:00
2009-08-29 14:31:01 -07:00
2009-09-13 01:28:13 -07:00
2009-09-16 14:53:26 -07:00
2009-07-29 00:32:42 -07:00
2009-10-10 00:05:19 -07:00