Skip to content

Commit dd55172

Browse files
pcloudsgitster
authored andcommitted
config.txt: move protocol.* to a separate file
Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
1 parent cd96754 commit dd55172

File tree

2 files changed

+65
-64
lines changed

2 files changed

+65
-64
lines changed

Documentation/config.txt

Lines changed: 1 addition & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -383,70 +383,7 @@ include::config/pager.txt[]
383383

384384
include::config/pretty.txt[]
385385

386-
protocol.allow::
387-
If set, provide a user defined default policy for all protocols which
388-
don't explicitly have a policy (`protocol.<name>.allow`). By default,
389-
if unset, known-safe protocols (http, https, git, ssh, file) have a
390-
default policy of `always`, known-dangerous protocols (ext) have a
391-
default policy of `never`, and all other protocols have a default
392-
policy of `user`. Supported policies:
393-
+
394-
--
395-
396-
* `always` - protocol is always able to be used.
397-
398-
* `never` - protocol is never able to be used.
399-
400-
* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
401-
either unset or has a value of 1. This policy should be used when you want a
402-
protocol to be directly usable by the user but don't want it used by commands which
403-
execute clone/fetch/push commands without user input, e.g. recursive
404-
submodule initialization.
405-
406-
--
407-
408-
protocol.<name>.allow::
409-
Set a policy to be used by protocol `<name>` with clone/fetch/push
410-
commands. See `protocol.allow` above for the available policies.
411-
+
412-
The protocol names currently used by git are:
413-
+
414-
--
415-
- `file`: any local file-based path (including `file://` URLs,
416-
or local paths)
417-
418-
- `git`: the anonymous git protocol over a direct TCP
419-
connection (or proxy, if configured)
420-
421-
- `ssh`: git over ssh (including `host:path` syntax,
422-
`ssh://`, etc).
423-
424-
- `http`: git over http, both "smart http" and "dumb http".
425-
Note that this does _not_ include `https`; if you want to configure
426-
both, you must do so individually.
427-
428-
- any external helpers are named by their protocol (e.g., use
429-
`hg` to allow the `git-remote-hg` helper)
430-
--
431-
432-
protocol.version::
433-
Experimental. If set, clients will attempt to communicate with a
434-
server using the specified protocol version. If unset, no
435-
attempt will be made by the client to communicate using a
436-
particular protocol version, this results in protocol version 0
437-
being used.
438-
Supported versions:
439-
+
440-
--
441-
442-
* `0` - the original wire protocol.
443-
444-
* `1` - the original wire protocol with the addition of a version string
445-
in the initial response from the server.
446-
447-
* `2` - link:technical/protocol-v2.html[wire protocol version 2].
448-
449-
--
386+
include::config/protocol.txt[]
450387

451388
include::pull-config.txt[]
452389

Documentation/config/protocol.txt

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
protocol.allow::
2+
If set, provide a user defined default policy for all protocols which
3+
don't explicitly have a policy (`protocol.<name>.allow`). By default,
4+
if unset, known-safe protocols (http, https, git, ssh, file) have a
5+
default policy of `always`, known-dangerous protocols (ext) have a
6+
default policy of `never`, and all other protocols have a default
7+
policy of `user`. Supported policies:
8+
+
9+
--
10+
11+
* `always` - protocol is always able to be used.
12+
13+
* `never` - protocol is never able to be used.
14+
15+
* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
16+
either unset or has a value of 1. This policy should be used when you want a
17+
protocol to be directly usable by the user but don't want it used by commands which
18+
execute clone/fetch/push commands without user input, e.g. recursive
19+
submodule initialization.
20+
21+
--
22+
23+
protocol.<name>.allow::
24+
Set a policy to be used by protocol `<name>` with clone/fetch/push
25+
commands. See `protocol.allow` above for the available policies.
26+
+
27+
The protocol names currently used by git are:
28+
+
29+
--
30+
- `file`: any local file-based path (including `file://` URLs,
31+
or local paths)
32+
33+
- `git`: the anonymous git protocol over a direct TCP
34+
connection (or proxy, if configured)
35+
36+
- `ssh`: git over ssh (including `host:path` syntax,
37+
`ssh://`, etc).
38+
39+
- `http`: git over http, both "smart http" and "dumb http".
40+
Note that this does _not_ include `https`; if you want to configure
41+
both, you must do so individually.
42+
43+
- any external helpers are named by their protocol (e.g., use
44+
`hg` to allow the `git-remote-hg` helper)
45+
--
46+
47+
protocol.version::
48+
Experimental. If set, clients will attempt to communicate with a
49+
server using the specified protocol version. If unset, no
50+
attempt will be made by the client to communicate using a
51+
particular protocol version, this results in protocol version 0
52+
being used.
53+
Supported versions:
54+
+
55+
--
56+
57+
* `0` - the original wire protocol.
58+
59+
* `1` - the original wire protocol with the addition of a version string
60+
in the initial response from the server.
61+
62+
* `2` - link:technical/protocol-v2.html[wire protocol version 2].
63+
64+
--

0 commit comments

Comments
 (0)