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>
This commit is contained in:
Ævar Arnfjörð Bjarmason 2022-08-04 18:28:41 +02:00 committed by Junio C Hamano
parent 6b6029dd1d
commit 1e2320161d
6 changed files with 33 additions and 11 deletions

View File

@ -36,6 +36,7 @@ MAN5_TXT += gitmailmap.txt
MAN5_TXT += gitmodules.txt MAN5_TXT += gitmodules.txt
MAN5_TXT += gitprotocol-capabilities.txt MAN5_TXT += gitprotocol-capabilities.txt
MAN5_TXT += gitprotocol-common.txt MAN5_TXT += gitprotocol-common.txt
MAN5_TXT += gitprotocol-http.txt
MAN5_TXT += gitprotocol-pack.txt MAN5_TXT += gitprotocol-pack.txt
MAN5_TXT += gitprotocol-v2.txt MAN5_TXT += gitprotocol-v2.txt
MAN5_TXT += gitrepository-layout.txt MAN5_TXT += gitrepository-layout.txt
@ -106,7 +107,6 @@ TECH_DOCS += SubmittingPatches
TECH_DOCS += ToolsForGit TECH_DOCS += ToolsForGit
TECH_DOCS += technical/bitmap-format TECH_DOCS += technical/bitmap-format
TECH_DOCS += technical/hash-function-transition TECH_DOCS += technical/hash-function-transition
TECH_DOCS += technical/http-protocol
TECH_DOCS += technical/long-running-process-protocol TECH_DOCS += technical/long-running-process-protocol
TECH_DOCS += technical/multi-pack-index TECH_DOCS += technical/multi-pack-index
TECH_DOCS += technical/pack-heuristics TECH_DOCS += technical/pack-heuristics

View File

@ -39,9 +39,9 @@ OPTIONS
--http-backend-info-refs:: --http-backend-info-refs::
Used by linkgit:git-http-backend[1] to serve up Used by linkgit:git-http-backend[1] to serve up
`$GIT_URL/info/refs?service=git-upload-pack` requests. See `$GIT_URL/info/refs?service=git-upload-pack` requests. See
"Smart Clients" in link:technical/http-protocol.html[the HTTP "Smart Clients" in linkgit:gitprotocol-http[5] and "HTTP
transfer protocols] documentation and "HTTP Transport" in the Transport" in in the linkgit:gitprotocol-v2[5]
linkgit:gitprotocol-v2[5] documentation. Also understood by documentation. Also understood by
linkgit:git-receive-pack[1]. linkgit:git-receive-pack[1].
<directory>:: <directory>::

View File

@ -1,5 +1,19 @@
HTTP transfer protocols gitprotocol-http(5)
======================= ===================
NAME
----
gitprotocol-http - Git HTTP-based protocols
SYNOPSIS
--------
[verse]
<over-the-wire-protocol>
DESCRIPTION
-----------
Git supports two HTTP based transfer protocols. A "dumb" protocol Git supports two HTTP based transfer protocols. A "dumb" protocol
which requires only a standard HTTP server on the server end of the 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.
TODO: Document this further. TODO: Document this further.
REFERENCES
References
---------- ----------
http://www.ietf.org/rfc/rfc1738.txt[RFC 1738: Uniform Resource Locators (URL)] http://www.ietf.org/rfc/rfc1738.txt[RFC 1738: Uniform Resource Locators (URL)]
http://www.ietf.org/rfc/rfc2616.txt[RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1] http://www.ietf.org/rfc/rfc2616.txt[RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1]
SEE ALSO
--------
linkgit:gitprotocol-pack[5] linkgit:gitprotocol-pack[5]
linkgit:gitprotocol-capabilities[5] linkgit:gitprotocol-capabilities[5]
GIT
---
Part of the linkgit:git[1] suite

View File

@ -17,7 +17,7 @@ Git supports transferring data in packfiles over the ssh://, git://, http:// and
file:// transports. There exist two sets of protocols, one for pushing file:// transports. There exist two sets of protocols, one for pushing
data from a client to a server and another for fetching data from a data from a client to a server and another for fetching data from a
server to a client. The three transports (ssh, git, file) use the same server to a client. The three transports (ssh, git, file) use the same
protocol to transfer data. http is documented in http-protocol.txt. protocol to transfer data. http is documented in linkgit:gitprotocol-http[5].
The processes invoked in the canonical Git implementation are 'upload-pack' The processes invoked in the canonical Git implementation are 'upload-pack'
on the server side and 'fetch-pack' on the client side for fetching data; on the server side and 'fetch-pack' on the client side for fetching data;

View File

@ -53,7 +53,7 @@ Initial Client Request
In general a client can request to speak protocol v2 by sending In general a client can request to speak protocol v2 by sending
`version=2` through the respective side-channel for the transport being `version=2` through the respective side-channel for the transport being
used which inevitably sets `GIT_PROTOCOL`. More information can be used which inevitably sets `GIT_PROTOCOL`. More information can be
found in linkgit:gitprotocol-pack[5] and `http-protocol.txt`, as well as the found in linkgit:gitprotocol-pack[5] and linkgit:gitprotocol-http[5], as well as the
`GIT_PROTOCOL` definition in `git.txt`. In all cases the `GIT_PROTOCOL` definition in `git.txt`. In all cases the
response from the server is the capability advertisement. response from the server is the capability advertisement.
@ -77,7 +77,7 @@ HTTP Transport
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
When using the http:// or https:// transport a client makes a "smart" When using the http:// or https:// transport a client makes a "smart"
info/refs request as described in `http-protocol.txt` and requests that info/refs request as described in linkgit:gitprotocol-http[5] and requests that
v2 be used by supplying "version=2" in the `Git-Protocol` header. v2 be used by supplying "version=2" in the `Git-Protocol` header.
C: GET $GIT_URL/info/refs?service=git-upload-pack HTTP/1.0 C: GET $GIT_URL/info/refs?service=git-upload-pack HTTP/1.0

View File

@ -224,6 +224,7 @@ gitmodules userinterfaces
gitnamespaces guide gitnamespaces guide
gitprotocol-capabilities developerinterfaces gitprotocol-capabilities developerinterfaces
gitprotocol-common developerinterfaces gitprotocol-common developerinterfaces
gitprotocol-http developerinterfaces
gitprotocol-pack developerinterfaces gitprotocol-pack developerinterfaces
gitprotocol-v2 developerinterfaces gitprotocol-v2 developerinterfaces
gitremote-helpers guide gitremote-helpers guide