Skip to content

Commit

Permalink
Documentation/technical: convert plain text files to asciidoc
Browse files Browse the repository at this point in the history
These were not originally meant for asciidoc, but they are already
so close.  Mark them up in asciidoc.

Signed-off-by: Thomas Ackermann <th.acker@arcor.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Thomas Ackermann authored and Junio C Hamano committed Oct 16, 2012
1 parent 368dc5d commit 5316c8e
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 27 deletions.
2 changes: 1 addition & 1 deletion Documentation/technical/index-format.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
GIT index format
================

= The git index file has the following format
== The git index file has the following format

All binary numbers are in network byte order. Version 2 is described
here unless stated otherwise.
Expand Down
8 changes: 4 additions & 4 deletions Documentation/technical/pack-format.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
GIT pack format
===============

= pack-*.pack files have the following format:
== pack-*.pack files have the following format:

- A header appears at the beginning and consists of the following:

Expand Down Expand Up @@ -34,7 +34,7 @@ GIT pack format

- The trailer records 20-byte SHA1 checksum of all of the above.

= Original (version 1) pack-*.idx files have the following format:
== Original (version 1) pack-*.idx files have the following format:

- The header consists of 256 4-byte network byte order
integers. N-th entry of this table records the number of
Expand Down Expand Up @@ -123,8 +123,8 @@ Pack file entry: <+



= Version 2 pack-*.idx files support packs larger than 4 GiB, and
have some other reorganizations. They have the format:
== Version 2 pack-*.idx files support packs larger than 4 GiB, and
have some other reorganizations. They have the format:

- A 4-byte magic number '\377tOc' which is an unreasonable
fanout[0] value.
Expand Down
7 changes: 4 additions & 3 deletions Documentation/technical/pack-protocol.txt
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ A few things to remember here:
- The repository path is always quoted with single quotes.

Fetching Data From a Server
===========================
---------------------------

When one Git repository wants to get data that a second repository
has, the first can 'fetch' from the second. This operation determines
Expand All @@ -134,7 +134,8 @@ with the object name that each reference currently points to.

$ echo -e -n "0039git-upload-pack /schacon/gitbook.git\0host=example.com\0" |
nc -v example.com 9418
00887217a7c7e582c46cec22a130adf4b9d7d950fba0 HEAD\0multi_ack thin-pack side-band side-band-64k ofs-delta shallow no-progress include-tag
00887217a7c7e582c46cec22a130adf4b9d7d950fba0 HEAD\0multi_ack thin-pack
side-band side-band-64k ofs-delta shallow no-progress include-tag
00441d3fcd5ced445d1abc402225c0b8a1299641f497 refs/heads/integration
003f7217a7c7e582c46cec22a130adf4b9d7d950fba0 refs/heads/master
003cb88d2441cac0977faf98efc80305012112238d9d refs/tags/v0.9
Expand Down Expand Up @@ -421,7 +422,7 @@ entire packfile without multiplexing.


Pushing Data To a Server
========================
------------------------

Pushing data to a server will invoke the 'receive-pack' process on the
server, which will allow the client to tell it which references it should
Expand Down
8 changes: 7 additions & 1 deletion Documentation/technical/shallow.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
Def.: Shallow commits do have parents, but not in the shallow
Shallow commits
===============

.Definition
*********************************************************
Shallow commits do have parents, but not in the shallow
repo, and therefore grafts are introduced pretending that
these commits have no parents.
*********************************************************

The basic idea is to write the SHA1s of shallow commits into
$GIT_DIR/shallow, and handle its contents like the contents
Expand Down
36 changes: 18 additions & 18 deletions Documentation/technical/trivial-merge.txt
Original file line number Diff line number Diff line change
Expand Up @@ -74,24 +74,24 @@ For multiple ancestors, a '+' means that this case applies even if
only one ancestor or remote fits; a '^' means all of the ancestors
must be the same.

case ancest head remote result
----------------------------------------
1 (empty)+ (empty) (empty) (empty)
2ALT (empty)+ *empty* remote remote
2 (empty)^ (empty) remote no merge
3ALT (empty)+ head *empty* head
3 (empty)^ head (empty) no merge
4 (empty)^ head remote no merge
5ALT * head head head
6 ancest+ (empty) (empty) no merge
8 ancest^ (empty) ancest no merge
7 ancest+ (empty) remote no merge
10 ancest^ ancest (empty) no merge
9 ancest+ head (empty) no merge
16 anc1/anc2 anc1 anc2 no merge
13 ancest+ head ancest head
14 ancest+ ancest remote remote
11 ancest+ head remote no merge
case ancest head remote result
----------------------------------------
1 (empty)+ (empty) (empty) (empty)
2ALT (empty)+ *empty* remote remote
2 (empty)^ (empty) remote no merge
3ALT (empty)+ head *empty* head
3 (empty)^ head (empty) no merge
4 (empty)^ head remote no merge
5ALT * head head head
6 ancest+ (empty) (empty) no merge
8 ancest^ (empty) ancest no merge
7 ancest+ (empty) remote no merge
10 ancest^ ancest (empty) no merge
9 ancest+ head (empty) no merge
16 anc1/anc2 anc1 anc2 no merge
13 ancest+ head ancest head
14 ancest+ ancest remote remote
11 ancest+ head remote no merge

Only #2ALT and #3ALT use *empty*, because these are the only cases
where there can be conflicts that didn't exist before. Note that we
Expand Down

0 comments on commit 5316c8e

Please sign in to comment.