Re: [PATCH 1/5] check-ref-format doc: de-emphasize the implementation detail of a ref
- From
Eric Sunshine <sunshine@sunshineco.com>
- Date
- Jun 23, 2011, 22:14 UTC
- Message-ID
- <4E03BACA.8000303@sunshineco.com>
- In-Reply-To
- <1308847958-3429-2-git-send-email-gitster@pobox.com>
On 6/23/2011 12:52 PM, Junio C Hamano wrote:
Show 5 quoted lines
> A reference is used in git to specify branches and tags. A > -branch head is stored under the `$GIT_DIR/refs/heads` directory, and > -a tag is stored under the `$GIT_DIR/refs/tags` directory (or, if refs > -are packed by `git gc`, as entries in the `$GIT_DIR/packed-refs` file). > +branch head is stored in the `refs/heads` hierarchy while
s/hierarchy while/hierarchy, while/
> +a tag is stored in the `refs/tags` hierarchy of the ref namespace > +(which are found in `$GIT_DIR/refs/heads` and `$GIT_DIR/refs/tags` > +directories or, if refs are packed by `git gc`, as entries in > +the `$GIT_DIR/packed-refs` file).
Grammatical complexity of parenthetical comment makes it a bit difficult to read. Perhaps simplify as:
(typically in `$GIT_DIR/refs/heads` and `$GIT_DIR/refs/tags` directories, or as entries in file `$GIT_DIR/packed-refs` if refs are packed by `git gc`).
-- ES