docs: move http-protocol docs to man section 5
Continue the move of existing Documentation/technical/* protocol and file-format documentation into our main documentation space by moving the http-protocol.txt documentation over. I'm renaming it to "protocol-http" to be consistent with other things in the new gitformat-protocol-* namespace. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Ævar Arnfjörð Bjarmason committed
Aug 4, 2022 at 18:28 UTC
1e2320161d27684205f55ffa91f7f481d32863d5
6 files changed
+33
-11
Documentation/Makefile
+1
-1
@@ -36,6 +36,7 @@ MAN5_TXT += gitmailmap.txt
36
MAN5_TXT += gitmodules.txt
37
MAN5_TXT += gitprotocol-capabilities.txt
38
MAN5_TXT += gitprotocol-common.txt
39
+MAN5_TXT += gitprotocol-http.txt
40
MAN5_TXT += gitprotocol-pack.txt
41
MAN5_TXT += gitprotocol-v2.txt
42
MAN5_TXT += gitrepository-layout.txt
@@ -106,7 +107,6 @@ TECH_DOCS += SubmittingPatches
107
TECH_DOCS += ToolsForGit
108
TECH_DOCS += technical/bitmap-format
109
TECH_DOCS += technical/hash-function-transition
109
-TECH_DOCS += technical/http-protocol
110
TECH_DOCS += technical/long-running-process-protocol
111
TECH_DOCS += technical/multi-pack-index
112
TECH_DOCS += technical/pack-heuristics
Documentation/git-upload-pack.txt
+3
-3
@@ -39,9 +39,9 @@ OPTIONS
39
--http-backend-info-refs::
40
Used by linkgit:git-http-backend[1] to serve up
41
`$GIT_URL/info/refs?service=git-upload-pack` requests. See
42
- "Smart Clients" in link:technical/http-protocol.html[the HTTP
43
- transfer protocols] documentation and "HTTP Transport" in the
44
- linkgit:gitprotocol-v2[5] documentation. Also understood by
42
+ "Smart Clients" in linkgit:gitprotocol-http[5] and "HTTP
43
+ Transport" in in the linkgit:gitprotocol-v2[5]
44
+ documentation. Also understood by
45
linkgit:git-receive-pack[1].
46
47
<directory>::
Documentation/gitprotocol-http.txt
renamed
+25
-4
@@ -1,5 +1,19 @@
1
-HTTP transfer protocols
2
-=======================
1
+gitprotocol-http(5)
2
+===================
3
+
4
+NAME
5
+----
6
+gitprotocol-http - Git HTTP-based protocols
7
+
8
+
9
+SYNOPSIS
10
+--------
11
+[verse]
12
+<over-the-wire-protocol>
13
+
14
+
15
+DESCRIPTION
16
+-----------
17
18
Git supports two HTTP based transfer protocols. A "dumb" protocol
19
which requires only a standard HTTP server on the server end of the
@@ -512,11 +526,18 @@ the id obtained through ref discovery as old_id.
526
527
TODO: Document this further.
528
515
-
516
-References
529
+REFERENCES
530
----------
531
532
http://www.ietf.org/rfc/rfc1738.txt[RFC 1738: Uniform Resource Locators (URL)]
533
http://www.ietf.org/rfc/rfc2616.txt[RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1]
534
+
535
+SEE ALSO
536
+--------
537
+
538
linkgit:gitprotocol-pack[5]
539
linkgit:gitprotocol-capabilities[5]
540
+
541
+GIT
542
+---
543
+Part of the linkgit:git[1] suite
Documentation/gitprotocol-pack.txt
+1
-1
@@ -17,7 +17,7 @@ Git supports transferring data in packfiles over the ssh://, git://, http:// and
17
file:// transports. There exist two sets of protocols, one for pushing
18
data from a client to a server and another for fetching data from a
19
server to a client. The three transports (ssh, git, file) use the same
20
-protocol to transfer data. http is documented in http-protocol.txt.
20
+protocol to transfer data. http is documented in linkgit:gitprotocol-http[5].
21
22
The processes invoked in the canonical Git implementation are 'upload-pack'
23
on the server side and 'fetch-pack' on the client side for fetching data;
Documentation/gitprotocol-v2.txt
+2
-2
@@ -53,7 +53,7 @@ Initial Client Request
53
In general a client can request to speak protocol v2 by sending
54
`version=2` through the respective side-channel for the transport being
55
used which inevitably sets `GIT_PROTOCOL`. More information can be
56
-found in linkgit:gitprotocol-pack[5] and `http-protocol.txt`, as well as the
56
+found in linkgit:gitprotocol-pack[5] and linkgit:gitprotocol-http[5], as well as the
57
`GIT_PROTOCOL` definition in `git.txt`. In all cases the
58
response from the server is the capability advertisement.
59
@@ -77,7 +77,7 @@ HTTP Transport
77
~~~~~~~~~~~~~~
78
79
When using the http:// or https:// transport a client makes a "smart"
80
-info/refs request as described in `http-protocol.txt` and requests that
80
+info/refs request as described in linkgit:gitprotocol-http[5] and requests that
81
v2 be used by supplying "version=2" in the `Git-Protocol` header.
82
83
C: GET $GIT_URL/info/refs?service=git-upload-pack HTTP/1.0
command-list.txt
+1
@@ -224,6 +224,7 @@ gitmodules userinterfaces
224
gitnamespaces guide
225
gitprotocol-capabilities developerinterfaces
226
gitprotocol-common developerinterfaces
227
+gitprotocol-http developerinterfaces
228
gitprotocol-pack developerinterfaces
229
gitprotocol-v2 developerinterfaces
230
gitremote-helpers guide