From: Jonathan Nieder <jrnieder@gmail.com>
To: Sitaram Chamarty <sitaram@atc.tcs.com>
Cc: gitster@pobox.com, git@vger.kernel.org,
Ramkumar Ramachandra <artagnon@gmail.com>
Subject: Re: [PATCH] gitignore(5): explain how to stop tracking a file
Date: Wed, 10 Nov 2010 12:55:55 -0600 [thread overview]
Message-ID: <20101110185555.GA12365@burratino> (raw)
In-Reply-To: <1289387440-8509-1-git-send-email-sitaram@atc.tcs.com>
Sitaram Chamarty wrote:
> --- a/Documentation/gitignore.txt
> +++ b/Documentation/gitignore.txt
> @@ -18,7 +18,8 @@ Note that all the `gitignore` files really concern only files
> that are not already tracked by git;
> in order to ignore uncommitted changes in already tracked files,
> please refer to the 'git update-index --assume-unchanged'
> -documentation.
> +documentation. To stop tracking a file that is currently tracked,
> +use 'git rm --cached'.
Ack. But I fear this makes the gitignore page feel even more top-heavy
than it already is.
The current structure is:
SYNOPSIS
[list of excludes files]
DESCRIPTION
One-sentence description. Long comment about some totally
different command.
Description of structure. Long comment about precedence rules:
. some rules
...
Paragraph about which excludes file works for which use case.
Paragraph about which commands pay attention to excludes files.
Patterns have the following format:
. some rules
...
An example:
transcript
Another example:
transcript
Quick analysis.
DOCUMENTATION
Various people's names.
GIT
Part of the git(1) suite.
It's a wonder people can find anything there. :) So how about this?
Patch 1 splits the description into three sections. Yes, having the
PATTERN FORMAT section is not part of the conventional list in
man-pages(7), but I think it's easier to find the interesting part
this way.
Patch 2 puts the comments about related commands in a separate NOTES
section.
This way, one could expand on the "stop tracking file" procedure
without interrupting the flow of the basic description of what
excludes files do, by adding to the NOTES or EXAMPLES section.
Thoughts?
Jonathan Nieder (2):
Documentation: split gitignore page into sections
Documentation: point to related commands from gitignore
Documentation/gitignore.txt | 30 +++++++++++++++++++++++-------
1 files changed, 23 insertions(+), 7 deletions(-)
--
1.7.2.3.557.gab647.dirty
next parent reply other threads:[~2010-11-10 18:56 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <1289387440-8509-1-git-send-email-sitaram@atc.tcs.com>
2010-11-10 18:55 ` Jonathan Nieder [this message]
2010-11-10 18:57 ` [PATCH 1/2] Documentation: split gitignore page into sections Jonathan Nieder
2010-11-10 19:00 ` [PATCH 2/2] Documentation: point to related commands from gitignore Jonathan Nieder
2010-11-11 19:05 ` Junio C Hamano
2010-11-11 1:10 ` [PATCH] gitignore(5): explain how to stop tracking a file Sitaram Chamarty
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=20101110185555.GA12365@burratino \
--to=jrnieder@gmail.com \
--cc=artagnon@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=sitaram@atc.tcs.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).