From: A Large Angry SCM <gitzilla@gmail.com>
To: git@vger.kernel.org
Cc: "Santi Béjar" <sbejar@gmail.com>, "Kay Sievers" <kay.sievers@vrfy.org>
Subject: [RFC] GIT Repository Annotation Convention
Date: Thu, 08 Sep 2005 12:03:04 -0400 [thread overview]
Message-ID: <432060B8.6080408@gmail.com> (raw)
In-Reply-To: <431DA8CD.9060009@gmail.com>
GIT Repository Annotation Convention
====================================
GIT repositories can benefit from descriptions of /intent/ for portions
of the repository. This document formalizes a method to store those
descriptions in the repository.
Annotations
------------
Annotations are UTF8 text files. Each text starts with a one line
summary, optionally followed by a blank line and a longer, more detailed
description.
Annotations describe the /intended/ use or contents of the repository
portion described. For instance, a branch is defined by a head ref; the
annotation for that branch would describe what that branch is intended
to hold, how to interpret and/or use the stored state, etc.
Naming and Directory Structure
------------------------------
Annotations are named by appending ".txt" to the basename of the
repository component it describes, and by appending ".dir" to each
directory patch component leading to the repository component from
$GIT_DIR, and by prepending "annotations/" to the annotation pathname.
The use of the ".txt" and ".dir" suffixes is to allow for descriptions
of hierarchical structures (directories) and well as specific components
(files).
Missing annotations are ignored.
The file "$GIT_DIR/description", used by gitweb and other tools, becomes
a symbolic link to "$GIT_DIR/annotations/description.txt".
Example Layout
--------------
$GIT_DIR/
...
annotations/
...
annotations.txt
...
description.txt
...
refs.dir/
...
heads.dir/
<head dir 1>.dir/
<head name 1.1>.txt
...
<head name 1.M>.txt
<head dir 1>.txt
...
<head dir N>.dir/
<head name N.1>.txt
...
<head name N.P>.txt
<head name 1>.txt
...
<head name Q>.txt
...
tags.dir/
<tag name 1>.txt
...
<tag name T>.txt
...
...
description -> annotations/description.txt
...
--
next prev parent reply other threads:[~2005-09-08 16:03 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2005-09-06 13:21 git/gitweb - feature request: Add description to the branches Santi Béjar
2005-09-06 14:33 ` A Large Angry SCM
2005-09-08 1:27 ` Junio C Hamano
2005-09-08 16:03 ` A Large Angry SCM [this message]
2005-09-08 18:00 ` [RFC] GIT Repository Annotation Convention Junio C Hamano
2005-09-08 18:58 ` A Large Angry SCM
2005-09-11 16:37 ` Matthias Urlichs
2005-09-11 18:08 ` A Large Angry SCM
2005-09-12 0:26 ` Horst von Brand
2005-09-13 17:46 ` Matthias Urlichs
[not found] ` <43208110.6020607@gmail.com>
[not found] ` <7vvf1bq64t.fsf@assigned-by-dhcp.cox.net>
2005-09-09 14:24 ` A Large Angry SCM
[not found] ` <43207B68.5020204@citi.umich.edu>
2005-09-08 18:32 ` A Large Angry SCM
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=432060B8.6080408@gmail.com \
--to=gitzilla@gmail.com \
--cc=git@vger.kernel.org \
--cc=kay.sievers@vrfy.org \
--cc=sbejar@gmail.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.
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 NNTP newsgroup(s).