Re: wishlist: git info

From: Jakub Narebski <jnareb@gmail.com>
Date: Nov 13, 2007, 09:44 UTC
Message-ID: <fhbrll$ceq$1@ger.gmane.org>
In-Reply-To: <fhbn50$uqu$1@ger.gmane.org>

Thomas Neumann wrote:

>> Perhaps also project description (if it exists?)

> one can specify a project description? I did not even know this. But
> yes, this would be useful, too.

It is project description for gitweb (git web interface), and I think also for other web interfaces (cgit, wit, git-php). Or rather *repository* description. It is in .git/description (in 'description' file in git repository).

Unfortunately by default it contains (see: ${tempate_dir}/description)

  Unnamed repository; edit this file to name it for gitweb.

> In general I think git info should show everything to quickly understand
> what is currently checked out. The name of the current branch should
> probably be included, too.

Name of current branch, current directory, name of topdir (with '.git' stripped if it is bare repository), perhaps oneline description of top commit. And if branch is under StGit or Guilt (patch management interfaces) control.

See also helper functions to set shell prompt in contrib/completion/git-completion.bash.

I for example have "1760:[gitweb/web!git]$ " as bash prompt:
 - 1760 is number of command in history, 
 - 'gitweb/web' is name of branch I am on,
 - 'git' is the name of repository
This migitates need got 'git-info' command.

> I use an alias with the commands proposed by Alex Riessen for now, but a
> more general command would be nice.

You can always write[*1*] git-info.sh or git-info.perl[*2*], and install it as git-info in your git installation. And send patches here, to git mailing list, for comments.

Footnotes:
----------
[*1*] Even if one of the most common complaints is "too many user-visible
      commands".
[*2*] Scripts are better for ptototyping. Choose your own poison: POSIX
      shell or Perl...

-- 
Jakub Narebski
Warsaw, Poland
ShadeHawk on #git