threads / patch / 9353

patchFix documentation for core.gitproxy to reflect code

Subject: [PATCH] Fix documentation for core.gitproxy to reflect code

## tl;dr

4 messages between Aug 2, 2007 and Aug 2, 2007. Diffs are folded; open one to read it.

replies: 3people: 2as markdown or json

David Symonds· Aug 2, 2007, 12:23 UTC · lore

This is with respect to my earlier email about core.gitproxy. I figured since 1.5.3 is looming it would be best to get the documentation correct, then nag about the feature later!

Dave.
---
 Documentation/config.txt     |    2 +-
 Documentation/git-config.txt |    4 +---
 2 files changed, 2 insertions(+), 4 deletions(-)
Show changes to 2 files +2 −4

Documentation/config.txt, Documentation/git-config.txt

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 3135cb7..de9e72b 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -101,7 +101,7 @@ Example

 	# Proxy settings
 	[core]
-		gitProxy="ssh" for "ssh://kernel.org/"
+		gitProxy="ssh" for "kernel.org"
 		gitProxy=default-proxy ; for the rest

 Variables
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index 8451ccc..c3dffff 100644
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -214,9 +214,7 @@ Given a .git/config like this:

 	; Proxy settings
 	[core]
-		gitproxy="ssh" for "ssh://kernel.org/"
 		gitproxy="proxy-command" for kernel.org
-		gitproxy="myprotocol-command" for "my://"
 		gitproxy=default-proxy ; for all the rest

 you can set the filemode to true with
@@ -291,7 +289,7 @@ To actually match only values with an exclamation
mark, you have to
 To add a new proxy, without altering any of the existing ones, use

 ------------
-% git config core.gitproxy '"proxy" for example.com'
+% git config core.gitproxy '"proxy-command" for example.com'
 ------------

-- 
1.5.2.4
Junio C Hamano· Aug 2, 2007, 20:12 UTC · re: David Symonds · lore

Re: [PATCH] Fix documentation for core.gitproxy to reflect code

"David Symonds" <dsymonds@gmail.com> writes:
Show 5 quoted lines
> This is with respect to my earlier email about core.gitproxy. I
> figured since 1.5.3 is looming it would be best to get the
> documentation correct, then nag about the feature later!
>
> Dave.
That's not a commit log message.

If the existing example does not work, then please say that you fixed it (i.e. "The values in the example does not work. The accepted forms are such and such and such, so use them in the example") in the log message. "Your earlier email" does not count. People who are reading the "git log" output would not have easy access to it.

If core.gitproxy is not documented (I suspect the parts you touched are not about "how to use core.gitproxy" but "what's the syntax of a configuration file" example), it needs its own proper entry in config.txt. If it has one, but if you feel it needs more explanation or exmples, that section needs to be updated.

Please retry.
David Symonds· Aug 2, 2007, 22:45 UTC · re: Junio C Hamano · lore

Re: [PATCH] Fix documentation for core.gitproxy to reflect code

The current implementation of core.gitproxy only operates on git:// URLs, so
the ssh:// examples and custom protocol examples have been removed or edited.
---
 Documentation/config.txt     |    2 +-
 Documentation/git-config.txt |    4 +---
 2 files changed, 2 insertions(+), 4 deletions(-)
Show changes to 2 files +2 −4

Documentation/config.txt, Documentation/git-config.txt

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 3135cb7..de9e72b 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -101,7 +101,7 @@ Example

        # Proxy settings
        [core]
-               gitProxy="ssh" for "ssh://kernel.org/"
+               gitProxy="ssh" for "kernel.org"
                gitProxy=default-proxy ; for the rest

 Variables
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index 8451ccc..c3dffff 100644
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -214,9 +214,7 @@ Given a .git/config like this:

        ; Proxy settings
        [core]
-               gitproxy="ssh" for "ssh://kernel.org/"
                gitproxy="proxy-command" for kernel.org
-               gitproxy="myprotocol-command" for "my://"
                gitproxy=default-proxy ; for all the rest

 you can set the filemode to true with
@@ -291,7 +289,7 @@ To actually match only values with an exclamation mark, you
have to
 To add a new proxy, without altering any of the existing ones, use

 ------------
-% git config core.gitproxy '"proxy" for example.com'
+% git config core.gitproxy '"proxy-command" for example.com'
 ------------

-- 
1.5.2.4

← back to recent threads