git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: git@vger.kernel.org
Cc: "Junio C Hamano" <gitster@pobox.com>,
	"Eric Sunshine" <sunshine@sunshineco.com>,
	"Philippe Blain" <levraiphilippeblain@gmail.com>,
	"Derrick Stolee" <stolee@gmail.com>,
	"Taylor Blau" <me@ttaylorr.com>, "Jeff King" <peff@peff.net>,
	"Teng Long" <dyroneteng@gmail.com>,
	"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Subject: [PATCH v5 8/9] docs: move http-protocol docs to man section 5
Date: Thu, 21 Jul 2022 18:13:57 +0200	[thread overview]
Message-ID: <patch-v5-8.9-8f8214addfd-20220721T160721Z-avarab@gmail.com> (raw)
In-Reply-To: <cover-v5-0.9-00000000000-20220721T160721Z-avarab@gmail.com>

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>
---
 Documentation/Makefile                        |  2 +-
 Documentation/git-upload-pack.txt             |  6 ++--
 ...http-protocol.txt => gitprotocol-http.txt} | 29 ++++++++++++++++---
 Documentation/gitprotocol-pack.txt            |  2 +-
 Documentation/gitprotocol-v2.txt              |  4 +--
 command-list.txt                              |  1 +
 6 files changed, 33 insertions(+), 11 deletions(-)
 rename Documentation/{technical/http-protocol.txt => gitprotocol-http.txt} (98%)

diff --git a/Documentation/Makefile b/Documentation/Makefile
index cd09ccd8c13..6efac142e3e 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -37,6 +37,7 @@ MAN5_TXT += gitmailmap.txt
 MAN5_TXT += gitmodules.txt
 MAN5_TXT += gitprotocol-capabilities.txt
 MAN5_TXT += gitprotocol-common.txt
+MAN5_TXT += gitprotocol-http.txt
 MAN5_TXT += gitprotocol-pack.txt
 MAN5_TXT += gitprotocol-v2.txt
 MAN5_TXT += gitrepository-layout.txt
@@ -107,7 +108,6 @@ TECH_DOCS += SubmittingPatches
 TECH_DOCS += ToolsForGit
 TECH_DOCS += technical/bitmap-format
 TECH_DOCS += technical/hash-function-transition
-TECH_DOCS += technical/http-protocol
 TECH_DOCS += technical/long-running-process-protocol
 TECH_DOCS += technical/multi-pack-index
 TECH_DOCS += technical/pack-heuristics
diff --git a/Documentation/git-upload-pack.txt b/Documentation/git-upload-pack.txt
index 3409e0d36d1..3f89d640772 100644
--- a/Documentation/git-upload-pack.txt
+++ b/Documentation/git-upload-pack.txt
@@ -39,9 +39,9 @@ OPTIONS
 --http-backend-info-refs::
 	Used by linkgit:git-http-backend[1] to serve up
 	`$GIT_URL/info/refs?service=git-upload-pack` requests. See
-	"Smart Clients" in link:technical/http-protocol.html[the HTTP
-	transfer protocols] documentation and "HTTP Transport" in the
-	linkgit:gitprotocol-v2[5] documentation. Also understood by
+	"Smart Clients" in linkgit:gitprotocol-http[5] and "HTTP
+	Transport" in in the linkgit:gitprotocol-v2[5]
+	documentation. Also understood by
 	linkgit:git-receive-pack[1].
 
 <directory>::
diff --git a/Documentation/technical/http-protocol.txt b/Documentation/gitprotocol-http.txt
similarity index 98%
rename from Documentation/technical/http-protocol.txt
rename to Documentation/gitprotocol-http.txt
index 8bd672d55bb..ccc13f0a407 100644
--- a/Documentation/technical/http-protocol.txt
+++ b/Documentation/gitprotocol-http.txt
@@ -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
 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.
 
-
-References
+REFERENCES
 ----------
 
 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]
+
+SEE ALSO
+--------
+
 linkgit:gitprotocol-pack[5]
 linkgit:gitprotocol-capabilities[5]
+
+GIT
+---
+Part of the linkgit:git[1] suite
diff --git a/Documentation/gitprotocol-pack.txt b/Documentation/gitprotocol-pack.txt
index 93b30b88450..dd4108b7a3b 100644
--- a/Documentation/gitprotocol-pack.txt
+++ b/Documentation/gitprotocol-pack.txt
@@ -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
 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
-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'
 on the server side and 'fetch-pack' on the client side for fetching data;
diff --git a/Documentation/gitprotocol-v2.txt b/Documentation/gitprotocol-v2.txt
index d6105e07408..c9c0f9160b2 100644
--- a/Documentation/gitprotocol-v2.txt
+++ b/Documentation/gitprotocol-v2.txt
@@ -53,7 +53,7 @@ Initial Client Request
 In general a client can request to speak protocol v2 by sending
 `version=2` through the respective side-channel for the transport being
 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
 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"
-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.
 
    C: GET $GIT_URL/info/refs?service=git-upload-pack HTTP/1.0
diff --git a/command-list.txt b/command-list.txt
index 4f30a6c30c8..e3a5d417792 100644
--- a/command-list.txt
+++ b/command-list.txt
@@ -225,6 +225,7 @@ gitmodules                              userinterfaces
 gitnamespaces                           guide
 gitprotocol-capabilities                developerinterfaces
 gitprotocol-common                      developerinterfaces
+gitprotocol-http                       developerinterfaces
 gitprotocol-pack                        developerinterfaces
 gitprotocol-v2                          developerinterfaces
 gitremote-helpers                       guide
-- 
2.37.1.1095.g64a1e8362fd


  parent reply	other threads:[~2022-07-21 16:23 UTC|newest]

Thread overview: 112+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-10-15  2:05 [PATCH 0/2] git(1) doc + "git help": split-out user & git format docs Ævar Arnfjörð Bjarmason
2021-10-15  2:05 ` [PATCH 1/2] git(1) docs: split "User-facing file formats" off from "Guides" Ævar Arnfjörð Bjarmason
2021-10-15  2:05 ` [PATCH 2/2] git(1) docs: create a "Git file and wire formats" section Ævar Arnfjörð Bjarmason
2021-12-12 19:49 ` [PATCH v2 0/5] git doc + "git help": move "format" docs from technical/* Ævar Arnfjörð Bjarmason
2021-12-12 19:49   ` [PATCH v2 1/5] git docs: split "User-facing file formats" off from "Guides" Ævar Arnfjörð Bjarmason
2021-12-12 19:49   ` [PATCH v2 2/5] git docs: create a "Git file and wire formats" section Ævar Arnfjörð Bjarmason
2021-12-12 22:30     ` Eric Sunshine
2021-12-13  9:33       ` Ævar Arnfjörð Bjarmason
2021-12-12 19:49   ` [PATCH v2 3/5] docs: move commit-graph format docs to man section 5 Ævar Arnfjörð Bjarmason
2021-12-12 19:49   ` [PATCH v2 4/5] docs: move protocol-related " Ævar Arnfjörð Bjarmason
2021-12-12 19:49   ` [PATCH v2 5/5] docs: move {index,signature,bitmap,chunk}-format " Ævar Arnfjörð Bjarmason
2022-07-12 20:06   ` [PATCH v3 0/7] git doc + "git help": move "format" docs from technical/* Ævar Arnfjörð Bjarmason
2022-07-12 20:06     ` [PATCH v3 1/7] git docs: split "User-facing file formats" off from "Guides" Ævar Arnfjörð Bjarmason
2022-07-13  1:09       ` Ævar Arnfjörð Bjarmason
2022-07-12 20:06     ` [PATCH v3 2/7] git docs: create a "Git file formats and protocols" section Ævar Arnfjörð Bjarmason
2022-07-12 20:06     ` [PATCH v3 3/7] docs: move commit-graph format docs to man section 5 Ævar Arnfjörð Bjarmason
2022-07-12 20:06     ` [PATCH v3 4/7] docs: move protocol-related " Ævar Arnfjörð Bjarmason
2022-07-12 20:07     ` [PATCH v3 5/7] docs: move pack format " Ævar Arnfjörð Bjarmason
2022-07-12 20:07     ` [PATCH v3 6/7] docs: move http-protocol " Ævar Arnfjörð Bjarmason
2022-07-12 20:07     ` [PATCH v3 7/7] docs: move multi-pack-index " Ævar Arnfjörð Bjarmason
2022-07-18 13:29     ` [PATCH v4 0/8] git doc + "git help": move "format" docs from technical/* Ævar Arnfjörð Bjarmason
2022-07-18 13:29       ` [PATCH v4 1/8] help.c: BUG() out if "help --guides" can't remove "git" prefixes Ævar Arnfjörð Bjarmason
2022-07-18 17:03         ` Junio C Hamano
2022-07-18 13:29       ` [PATCH v4 2/8] git docs: split "User-facing file formats" off from "Guides" Ævar Arnfjörð Bjarmason
2022-07-18 17:17         ` Junio C Hamano
2022-07-18 18:41           ` Ævar Arnfjörð Bjarmason
2022-07-19 23:21             ` Junio C Hamano
2022-07-21  7:02               ` Ævar Arnfjörð Bjarmason
2022-07-18 13:29       ` [PATCH v4 3/8] git docs: create a "Git file formats and protocols" section Ævar Arnfjörð Bjarmason
2022-07-18 13:29       ` [PATCH v4 4/8] docs: move commit-graph format docs to man section 5 Ævar Arnfjörð Bjarmason
2022-07-18 13:29       ` [PATCH v4 5/8] docs: move protocol-related " Ævar Arnfjörð Bjarmason
2022-07-18 13:29       ` [PATCH v4 6/8] docs: move pack format " Ævar Arnfjörð Bjarmason
2022-07-18 13:29       ` [PATCH v4 7/8] docs: move http-protocol " Ævar Arnfjörð Bjarmason
2022-07-18 13:29       ` [PATCH v4 8/8] docs: move multi-pack-index " Ævar Arnfjörð Bjarmason
2022-07-18 16:54       ` [PATCH v4 0/8] git doc + "git help": move "format" docs from technical/* Junio C Hamano
2022-07-18 17:58         ` Ævar Arnfjörð Bjarmason
2022-07-21  7:12           ` Ævar Arnfjörð Bjarmason
2022-07-21 16:13       ` [PATCH v5 0/9] docs: create & use "(user|developer) interfaces" categories Ævar Arnfjörð Bjarmason
2022-07-21 16:13         ` [PATCH v5 1/9] help.c: BUG() out if "help --guides" can't remove "git" prefixes Ævar Arnfjörð Bjarmason
2022-07-21 16:13         ` [PATCH v5 2/9] git help doc: use "<doc>" instead of "<guide>" Ævar Arnfjörð Bjarmason
2022-07-21 16:13         ` [PATCH v5 3/9] git docs: add a category for user-facing file, repo and command UX Ævar Arnfjörð Bjarmason
2022-07-21 16:13         ` [PATCH v5 4/9] git docs: add a category for file formats, protocols and interfaces Ævar Arnfjörð Bjarmason
2022-07-21 17:31           ` Eric Sunshine
2022-07-21 16:13         ` [PATCH v5 5/9] docs: move commit-graph format docs to man section 5 Ævar Arnfjörð Bjarmason
2022-07-21 16:13         ` [PATCH v5 6/9] docs: move protocol-related " Ævar Arnfjörð Bjarmason
2022-07-21 16:13         ` [PATCH v5 7/9] docs: move pack format " Ævar Arnfjörð Bjarmason
2022-07-21 16:13         ` Ævar Arnfjörð Bjarmason [this message]
2022-07-21 16:13         ` [PATCH v5 9/9] docs: move multi-pack-index " Ævar Arnfjörð Bjarmason
2022-07-21 18:13         ` [PATCH v5 0/9] docs: create & use "(user|developer) interfaces" categories Junio C Hamano
2022-07-28 16:46         ` [PATCH v6 " Ævar Arnfjörð Bjarmason
2022-07-28 16:46           ` [PATCH v6 1/9] help.c: BUG() out if "help --guides" can't remove "git" prefixes Ævar Arnfjörð Bjarmason
2022-07-30  0:17             ` Junio C Hamano
2022-08-01 11:55               ` Ævar Arnfjörð Bjarmason
2022-08-01 16:45                 ` Junio C Hamano
2022-07-28 16:46           ` [PATCH v6 2/9] git help doc: use "<doc>" instead of "<guide>" Ævar Arnfjörð Bjarmason
2022-07-28 16:46           ` [PATCH v6 3/9] git docs: add a category for user-facing file, repo and command UX Ævar Arnfjörð Bjarmason
2022-07-28 16:46           ` [PATCH v6 4/9] git docs: add a category for file formats, protocols and interfaces Ævar Arnfjörð Bjarmason
2022-07-28 16:46           ` [PATCH v6 5/9] docs: move commit-graph format docs to man section 5 Ævar Arnfjörð Bjarmason
2022-07-28 16:46           ` [PATCH v6 6/9] docs: move protocol-related " Ævar Arnfjörð Bjarmason
2022-07-28 16:46           ` [PATCH v6 7/9] docs: move pack format " Ævar Arnfjörð Bjarmason
2022-07-28 16:46           ` [PATCH v6 8/9] docs: move http-protocol " Ævar Arnfjörð Bjarmason
2022-07-28 16:46           ` [PATCH v6 9/9] docs: move multi-pack-index " Ævar Arnfjörð Bjarmason
2022-07-28 20:40           ` [PATCH v6 0/9] docs: create & use "(user|developer) interfaces" categories Junio C Hamano
2022-08-02 12:56           ` [PATCH v7 00/10] " Ævar Arnfjörð Bjarmason
2022-08-02 12:56             ` [PATCH v7 01/10] help.c: refactor drop_prefix() to use a "switch" statement" Ævar Arnfjörð Bjarmason
2022-08-02 23:01               ` Junio C Hamano
2022-08-02 12:56             ` [PATCH v7 02/10] help.c: remove common category behavior from drop_prefix() behavior Ævar Arnfjörð Bjarmason
2022-08-02 12:56             ` [PATCH v7 03/10] git help doc: use "<doc>" instead of "<guide>" Ævar Arnfjörð Bjarmason
2022-08-02 12:56             ` [PATCH v7 04/10] git docs: add a category for user-facing file, repo and command UX Ævar Arnfjörð Bjarmason
2022-08-02 12:56             ` [PATCH v7 05/10] git docs: add a category for file formats, protocols and interfaces Ævar Arnfjörð Bjarmason
2022-08-02 23:08               ` Junio C Hamano
2022-08-02 12:56             ` [PATCH v7 06/10] docs: move commit-graph format docs to man section 5 Ævar Arnfjörð Bjarmason
2022-08-03 15:48               ` Junio C Hamano
2022-08-02 12:56             ` [PATCH v7 07/10] docs: move protocol-related " Ævar Arnfjörð Bjarmason
2022-08-03 15:53               ` Junio C Hamano
2022-08-04 16:29                 ` Ævar Arnfjörð Bjarmason
2022-08-04 19:30                   ` Junio C Hamano
2022-08-05  8:36                     ` Ævar Arnfjörð Bjarmason
2022-08-02 12:56             ` [PATCH v7 08/10] docs: move pack format " Ævar Arnfjörð Bjarmason
2022-08-03 16:25               ` Junio C Hamano
2022-08-02 12:56             ` [PATCH v7 09/10] docs: move http-protocol " Ævar Arnfjörð Bjarmason
2022-08-03 16:31               ` Junio C Hamano
2022-08-02 12:56             ` [PATCH v7 10/10] docs: move multi-pack-index " Ævar Arnfjörð Bjarmason
2022-08-03 16:37               ` Junio C Hamano
2022-08-04 16:28             ` [PATCH v8 00/12] docs: create & use "(user|developer) interfaces" categories Ævar Arnfjörð Bjarmason
2022-08-04 16:28               ` [PATCH v8 01/12] help.c: refactor drop_prefix() to use a "switch" statement" Ævar Arnfjörð Bjarmason
2022-08-04 21:16                 ` Junio C Hamano
2022-08-04 16:28               ` [PATCH v8 02/12] help.c: remove common category behavior from drop_prefix() behavior Ævar Arnfjörð Bjarmason
2022-08-04 16:28               ` [PATCH v8 03/12] git help doc: use "<doc>" instead of "<guide>" Ævar Arnfjörð Bjarmason
2022-08-04 16:28               ` [PATCH v8 04/12] git docs: add a category for user-facing file, repo and command UX Ævar Arnfjörð Bjarmason
2022-08-04 16:28               ` [PATCH v8 05/12] git docs: add a category for file formats, protocols and interfaces Ævar Arnfjörð Bjarmason
2022-08-04 16:28               ` [PATCH v8 06/12] docs: move commit-graph format docs to man section 5 Ævar Arnfjörð Bjarmason
2022-08-04 21:18                 ` Junio C Hamano
2022-11-08 18:04                 ` SZEDER Gábor
2022-11-08 19:16                   ` Ævar Arnfjörð Bjarmason
2022-11-08 21:27                     ` SZEDER Gábor
2022-11-09  1:34                       ` Ævar Arnfjörð Bjarmason
2022-11-21 14:15                         ` [PATCH] docs: de-indent first paragraph of gitformat-* to flow the text Ævar Arnfjörð Bjarmason
2022-11-21 17:59                           ` Jeff King
2022-11-22  0:36                           ` Junio C Hamano
2022-08-04 16:28               ` [PATCH v8 07/12] docs: move protocol-related docs to man section 5 Ævar Arnfjörð Bjarmason
2022-08-04 16:28               ` [PATCH v8 08/12] docs: move index format " Ævar Arnfjörð Bjarmason
2022-08-04 21:24                 ` Junio C Hamano
2022-08-04 16:28               ` [PATCH v8 09/12] docs: move signature " Ævar Arnfjörð Bjarmason
2022-08-04 21:25                 ` Junio C Hamano
2022-08-04 16:28               ` [PATCH v8 10/12] docs: move pack format " Ævar Arnfjörð Bjarmason
2022-08-04 16:28               ` [PATCH v8 11/12] docs: move cruft pack docs to gitformat-pack Ævar Arnfjörð Bjarmason
2022-08-04 21:34                 ` Junio C Hamano
2022-08-05  8:29                   ` Ævar Arnfjörð Bjarmason
2022-08-05 16:12                     ` Junio C Hamano
2022-08-04 16:28               ` [PATCH v8 12/12] docs: move http-protocol docs to man section 5 Ævar Arnfjörð Bjarmason
2022-08-04 21:36               ` [PATCH v8 00/12] docs: create & use "(user|developer) interfaces" categories Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=patch-v5-8.9-8f8214addfd-20220721T160721Z-avarab@gmail.com \
    --to=avarab@gmail.com \
    --cc=dyroneteng@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=levraiphilippeblain@gmail.com \
    --cc=me@ttaylorr.com \
    --cc=peff@peff.net \
    --cc=stolee@gmail.com \
    --cc=sunshine@sunshineco.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).