Junio C Hamano wrote: > Nguyen Thai Ngoc Duy <pclo...@gmail.com> writes: > >> On Wed, Oct 3, 2012 at 3:46 PM, Ramkumar Ramachandra <artag...@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 <artag...@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 <artag...@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 -- To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
