From: Ramkumar Ramachandra <artagnon@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: Nguyen Thai Ngoc Duy <pclouds@gmail.com>,
David Glasser <glasser@davidglasser.net>,
git@vger.kernel.org
Subject: Re: push.default documented in "man git-push"?
Date: Sun, 7 Oct 2012 21:39:48 +0530 [thread overview]
Message-ID: <CALkWK0m0ZzOmwFxAt40gHXi98JEq+==9ctiLYVYf4UE5GB+V8A@mail.gmail.com> (raw)
In-Reply-To: <7v7gr75s40.fsf@alter.siamese.dyndns.org>
Junio C Hamano wrote:
> Nguyen Thai Ngoc Duy <pclouds@gmail.com> writes:
>
>> On Wed, Oct 3, 2012 at 3:46 PM, Ramkumar Ramachandra <artagnon@gmail.com> wrote:
>>> On second thought, it might not be such a good idea. There are *lots*
>>> of variables that control the operation of each command, and it's hard
>>> to decide which ones to list and which ones to omit. I've listed all
>>> the relevant variables for git-push, except the advice.* variables- I
>>> don't know how useful such a long list might be.
>>
>> I think listing receive.* and advice.* (and maybe even
>> remove.<name>.*) is still ok. The goal is to give users a clue.
>> They'll need to look up in config.txt anyway for explanation. If we
>> name the config keys (and groups) well then users should be able to
>> guess what those keys may be for before deciding whether to look into
>> details.
>
> Please do not label the list as "These variables affect this
> command" to give a false impression that it is the complete list if
> it isn't.
>
> Unless somebody promises to keep an up-to-date complete list there
> (or even better, come up with a mechanism to help us keep that
> promise automatically, perhaps by annotating pieces with structured
> comments in config.txt and automatically appending such a section to
> manual pages of relevant commands), that is.
>
> With a weaker phrase, e.g. "These configuration variables may be of
> interest", such a list may not hurt readers, but personally I do not
> think it adds much value to have a list of variables without even a
> single line description of what each is used for.
Okay. Does this work?
-- 8< --
From: Ramkumar Ramachandra <artagnon@gmail.com>
Date: Sun, 7 Oct 2012 17:24:36 +0530
Subject: [PATCH] Documentation/git-push: add a configuration variables
section
The list of configuration variables that affect the operation of a git
command can often be hard to find. As a first step, add a
"Configuration variables" section to git-push. The intent is to
create similar sections in all manpages.
Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
---
Documentation/git-push.txt | 24 ++++++++++++++++++++++++
1 file changed, 24 insertions(+)
diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt
index cb97cc1..a125536 100644
--- a/Documentation/git-push.txt
+++ b/Documentation/git-push.txt
@@ -426,6 +426,30 @@ Commits A and B would no longer belong to a
branch with a sy
and so would be unreachable. As such, these commits would be removed by
a `git gc` command on the origin repository.
+Configuration variables
+-----------------------
+
+These configuration variables may be of interest. For more
+information see linkgit:git-config[1].
+
+branch.<name>.remote
+core.gitProxy
+http.proxy
+push.default
+receive.autogc
+receive.denyCurrentBranch
+receive.denyDeleteCurrent
+receive.denyDeletes
+receive.denyNonFastForwards
+receive.unpackLimit
+receive.updateserverinfo
+remote.<name>.mirror
+remote.<name>.proxy
+remote.<name>.push
+remote.<name>.pushurl
+remote.<name>.receivepack
+remote.<name>.url
+
GIT
---
Part of the linkgit:git[1] suite
--
1.7.12.1.428.g652398a.dirty
next prev parent reply other threads:[~2012-10-07 16:10 UTC|newest]
Thread overview: 35+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-10-02 0:25 push.default documented in "man git-push"? David Glasser
2012-10-02 15:09 ` Ramkumar Ramachandra
2012-10-02 15:18 ` David Glasser
2012-10-02 15:38 ` Ramkumar Ramachandra
2012-10-02 16:45 ` Matthieu Moy
2012-10-02 16:56 ` Ramkumar Ramachandra
2012-10-02 17:21 ` Junio C Hamano
2012-10-02 17:25 ` Matthieu Moy
2012-10-02 18:34 ` Junio C Hamano
2012-10-02 19:00 ` David Glasser
2012-10-02 19:08 ` Junio C Hamano
2012-10-03 7:54 ` Matthieu Moy
2012-10-03 8:52 ` Ramkumar Ramachandra
2012-10-03 8:14 ` Nguyen Thai Ngoc Duy
2012-10-03 8:17 ` Ramkumar Ramachandra
2012-10-03 8:23 ` Nguyen Thai Ngoc Duy
2012-10-03 8:46 ` Ramkumar Ramachandra
2012-10-03 10:18 ` Nguyen Thai Ngoc Duy
2012-10-03 18:26 ` Junio C Hamano
2012-10-03 21:40 ` Jeff King
2012-10-08 17:12 ` Junio C Hamano
2012-10-07 16:09 ` Ramkumar Ramachandra [this message]
2012-10-07 20:27 ` Junio C Hamano
2012-10-08 7:27 ` Ramkumar Ramachandra
2012-10-08 8:35 ` Nguyen Thai Ngoc Duy
2012-10-03 18:49 ` Junio C Hamano
2012-10-04 2:01 ` Nguyen Thai Ngoc Duy
2012-10-04 5:45 ` Junio C Hamano
2012-10-05 6:34 ` Nguyen Thai Ngoc Duy
2012-10-05 20:03 ` Junio C Hamano
2012-10-11 12:43 ` Nguyen Thai Ngoc Duy
2012-10-11 14:18 ` Matthieu Moy
2012-10-11 14:43 ` Nguyen Thai Ngoc Duy
2012-10-11 16:17 ` Junio C Hamano
2012-10-03 11:58 ` Peter Krefting
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CALkWK0m0ZzOmwFxAt40gHXi98JEq+==9ctiLYVYf4UE5GB+V8A@mail.gmail.com' \
--to=artagnon@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=glasser@davidglasser.net \
--cc=pclouds@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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).