Skip to content

Commit 82727f9

Browse files
avargitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 40cc537 commit 82727f9

File tree

6 files changed

+33
-11
lines changed

6 files changed

+33
-11
lines changed

Documentation/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ MAN5_TXT += gitmailmap.txt
3737
MAN5_TXT += gitmodules.txt
3838
MAN5_TXT += gitprotocol-capabilities.txt
3939
MAN5_TXT += gitprotocol-common.txt
40+
MAN5_TXT += gitprotocol-http.txt
4041
MAN5_TXT += gitprotocol-pack.txt
4142
MAN5_TXT += gitprotocol-v2.txt
4243
MAN5_TXT += gitrepository-layout.txt
@@ -107,7 +108,6 @@ TECH_DOCS += SubmittingPatches
107108
TECH_DOCS += ToolsForGit
108109
TECH_DOCS += technical/bitmap-format
109110
TECH_DOCS += technical/hash-function-transition
110-
TECH_DOCS += technical/http-protocol
111111
TECH_DOCS += technical/long-running-process-protocol
112112
TECH_DOCS += technical/multi-pack-index
113113
TECH_DOCS += technical/pack-heuristics

Documentation/git-upload-pack.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ OPTIONS
3939
--http-backend-info-refs::
4040
Used by linkgit:git-http-backend[1] to serve up
4141
`$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
4545
linkgit:git-receive-pack[1].
4646

4747
<directory>::

Documentation/technical/http-protocol.txt renamed to Documentation/gitprotocol-http.txt

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -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+
-----------
317

418
Git supports two HTTP based transfer protocols. A "dumb" protocol
519
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.
512526

513527
TODO: Document this further.
514528

515-
516-
References
529+
REFERENCES
517530
----------
518531

519532
http://www.ietf.org/rfc/rfc1738.txt[RFC 1738: Uniform Resource Locators (URL)]
520533
http://www.ietf.org/rfc/rfc2616.txt[RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1]
534+
535+
SEE ALSO
536+
--------
537+
521538
linkgit:gitprotocol-pack[5]
522539
linkgit:gitprotocol-capabilities[5]
540+
541+
GIT
542+
---
543+
Part of the linkgit:git[1] suite

Documentation/gitprotocol-pack.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Git supports transferring data in packfiles over the ssh://, git://, http:// and
1717
file:// transports. There exist two sets of protocols, one for pushing
1818
data from a client to a server and another for fetching data from a
1919
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].
2121

2222
The processes invoked in the canonical Git implementation are 'upload-pack'
2323
on the server side and 'fetch-pack' on the client side for fetching data;

Documentation/gitprotocol-v2.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Initial Client Request
5353
In general a client can request to speak protocol v2 by sending
5454
`version=2` through the respective side-channel for the transport being
5555
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
5757
`GIT_PROTOCOL` definition in `git.txt`. In all cases the
5858
response from the server is the capability advertisement.
5959

@@ -77,7 +77,7 @@ HTTP Transport
7777
~~~~~~~~~~~~~~
7878

7979
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
8181
v2 be used by supplying "version=2" in the `Git-Protocol` header.
8282

8383
C: GET $GIT_URL/info/refs?service=git-upload-pack HTTP/1.0

command-list.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,7 @@ gitmodules userinterfaces
225225
gitnamespaces guide
226226
gitprotocol-capabilities developerinterfaces
227227
gitprotocol-common developerinterfaces
228+
gitprotocol-http developerinterfaces
228229
gitprotocol-pack developerinterfaces
229230
gitprotocol-v2 developerinterfaces
230231
gitremote-helpers guide

0 commit comments

Comments
 (0)