Skip to content

Commit 7fb5fdd

Browse files
committed
Merge branch 'lp/doc-gitprotocol-pack-fixes' into next
Doc update. * lp/doc-gitprotocol-pack-fixes: doc: gitprotocol-pack: normalize italic formatting doc: gitprotocol-pack: improve paragraphs structure doc: gitprotocol-pack: fix pronoun-antecedent agreement
2 parents 5690910 + a56fa1c commit 7fb5fdd

1 file changed

Lines changed: 10 additions & 8 deletions

File tree

Documentation/gitprotocol-pack.adoc

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,9 @@ process defined in this protocol is terminated.
4747
Transports
4848
----------
4949
There are three transports over which the packfile protocol is
50-
initiated. The Git transport is a simple, unauthenticated server that
50+
initiated.
51+
52+
The Git transport is a simple, unauthenticated server that
5153
takes the command (almost always 'upload-pack', though Git
5254
servers can be configured to be globally writable, in which 'receive-
5355
pack' initiation is also allowed) with which the client wishes to
@@ -65,7 +67,7 @@ Extra Parameters
6567
----------------
6668

6769
The protocol provides a mechanism in which clients can send additional
68-
information in its first message to the server. These are called "Extra
70+
information in their first message to the server. These are called "Extra
6971
Parameters", and are supported by the Git, SSH, and HTTP protocols.
7072

7173
Each Extra Parameter takes the form of `<key>=<value>` or `<key>`.
@@ -115,7 +117,7 @@ process on the server side over the Git protocol is this:
115117
SSH Transport
116118
-------------
117119
118-
Initiating the upload-pack or receive-pack processes over SSH is
120+
Initiating the 'upload-pack' or 'receive-pack' processes over SSH is
119121
executing the binary on the server via SSH remote execution.
120122
It is basically equivalent to running this:
121123
@@ -129,7 +131,7 @@ two commands, or even just one of them.
129131
130132
In an ssh:// format URI, it's absolute in the URI, so the '/' after
131133
the host name (or port number) is sent as an argument, which is then
132-
read by the remote git-upload-pack exactly as is, so it's effectively
134+
read by the remote 'git-upload-pack' exactly as is, so it's effectively
133135
an absolute path in the remote filesystem.
134136
135137
git clone ssh://user@example.com/project.git
@@ -161,7 +163,7 @@ supports passing environment variables as an argument.
161163
162164
A few things to remember here:
163165
164-
- The "command name" is spelled with dash (e.g. git-upload-pack), but
166+
- The "command name" is spelled with dash (e.g. 'git-upload-pack'), but
165167
this can be overridden by the client;
166168
167169
- The repository path is always quoted with single quotes.
@@ -277,7 +279,7 @@ out of what the server said it could do with the first 'want' line.
277279
filter-request = PKT-LINE("filter" SP filter-spec)
278280
----
279281

280-
Clients MUST send all the obj-ids it wants from the reference
282+
Clients MUST send all the obj-ids they want from the reference
281283
discovery phase as 'want' lines. Clients MUST send at least one
282284
'want' command in the request body. Clients MUST NOT mention an
283285
obj-id in a 'want' command which did not appear in the response
@@ -375,10 +377,10 @@ In multi_ack_detailed mode:
375377

376378
Without either multi_ack or multi_ack_detailed:
377379

378-
* upload-pack sends "ACK obj-id" on the first common object it finds.
380+
* 'upload-pack' sends "ACK obj-id" on the first common object it finds.
379381
After that it says nothing until the client gives it a "done".
380382

381-
* upload-pack sends "NAK" on a flush-pkt if no common object
383+
* 'upload-pack' sends "NAK" on a flush-pkt if no common object
382384
has been found yet. If one has been found, and thus an ACK
383385
was already sent, it's silent on the flush-pkt.
384386

0 commit comments

Comments
 (0)