From: Stephen Boyd <bebarino@gmail.com>
To: "Wesley J. Landaker" <wjl@icecavern.net>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>
Subject: Re: [PATCH 2/2] Documentation: git-clean: make description more readable
Date: Sat, 25 Apr 2009 11:36:35 -0700 [thread overview]
Message-ID: <49F35833.5070005@gmail.com> (raw)
In-Reply-To: <1240672421-10309-3-git-send-email-wjl@icecavern.net>
Wesley J. Landaker wrote:
> DESCRIPTION
> -----------
> -Removes files unknown to git. This allows cleaning the working tree
> -of files that are not under version control. If the '-x' option is
> -specified, ignored files are also removed, allowing the removal of all
> -build products.
> +
> +This allows cleaning the working tree by removing files that are not
> +under version control.
> +
Why is the "Removes files unknown to git" part lost? Maybe it should be
replaced with a copy of the Name section, similar to log and diff. For
example:
DESCRIPTION
-----------
Removes untracked files from the working tree. This allows cleaning the
working tree by removing files that are not under version control.
But then the second sentence becomes redundant.
> +Normally, only files unknown to git are removed, but if the '-x'
> +option is specified, ignored files are also removed. This can, for
> +example, be useful to remove all build products.
This seems overly wordy. Maybe:
Specifying the '-x' option will also remove ignored files. This is
useful to remove generated files.
Better?
On a side note, why is -x getting special treatment here but not -X or
-d? You might want to just describe the general usefulness of the
command and let the reader move onto the options to learn more.
next prev parent reply other threads:[~2009-04-25 18:46 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2009-04-25 15:13 [PATCH 0/2] Documentation: git-clean: description updates Wesley J. Landaker
2009-04-25 15:13 ` [PATCH 1/2] Documentation: git-clean: fix minor grammatical errors Wesley J. Landaker
2009-04-25 15:13 ` [PATCH 2/2] Documentation: git-clean: make description more readable Wesley J. Landaker
2009-04-25 18:36 ` Stephen Boyd [this message]
2009-04-26 1:23 ` Wesley J. Landaker
2009-04-26 8:04 ` Stephen Boyd
2009-04-26 0:10 ` [PATCH 0/2] Documentation: git-clean: description updates Junio C Hamano
2009-04-26 1:33 ` Wesley J. Landaker
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=49F35833.5070005@gmail.com \
--to=bebarino@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=wjl@icecavern.net \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.