Skip to content

Commit 1797e5c

Browse files
Thomas Ackermanngitster
authored andcommitted
Documentation/howto: convert plain text files to asciidoc
These were not originally meant for asciidoc, but they are already so close. Mark them up in asciidoc. Signed-off-by: Thomas Ackermann <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 5316c8e commit 1797e5c

11 files changed

+68
-34
lines changed

Documentation/howto/maintain-git.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ Abstract: Imagine that git development is racing along as usual, when our friend
55
neighborhood maintainer is struck down by a wayward bus. Out of the
66
hordes of suckers (loyal developers), you have been tricked (chosen) to
77
step up as the new maintainer. This howto will show you "how to" do it.
8+
Content-type: text/asciidoc
9+
10+
How to maintain Git
11+
===================
812

913
The maintainer's git time is spent on three activities.
1014

Documentation/howto/rebase-from-internal-branch.txt

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,12 @@ Abstract: In this article, JC talks about how he rebases the
88
the "master" branch, and how "rebase" works. Also discussed
99
is how this applies to individual developers who sends patches
1010
upstream.
11+
Content-type: text/asciidoc
1112

13+
How to rebase from an internal branch
14+
=====================================
15+
16+
--------------------------------------
1217
Petr Baudis <[email protected]> writes:
1318

1419
> Dear diary, on Sun, Aug 14, 2005 at 09:57:13AM CEST, I got a letter
@@ -19,6 +24,7 @@ Petr Baudis <[email protected]> writes:
1924
>> > branch to the real branches.
2025
>>
2126
> Actually, wouldn't this be also precisely for what StGIT is intended to?
27+
--------------------------------------
2228

2329
Exactly my feeling. I was sort of waiting for Catalin to speak
2430
up. With its basing philosophical ancestry on quilt, this is
@@ -156,8 +162,3 @@ you continue on starting from the new "master" head, which is
156162
the #1' commit.
157163

158164
-jc
159-
160-
-
161-
To unsubscribe from this list: send the line "unsubscribe git" in
162-
the body of a message to [email protected]
163-
More majordomo info at http://vger.kernel.org/majordomo-info.html

Documentation/howto/rebuild-from-update-hook.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ Date: Fri, 26 Aug 2005 18:19:10 -0700
55
Abstract: In this how-to article, JC talks about how he
66
uses the post-update hook to automate git documentation page
77
shown at http://www.kernel.org/pub/software/scm/git/docs/.
8+
Content-type: text/asciidoc
9+
10+
How to rebuild from update hook
11+
===============================
812

913
The pages under http://www.kernel.org/pub/software/scm/git/docs/
1014
are built from Documentation/ directory of the git.git project

Documentation/howto/recover-corrupted-blob-object.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,17 @@ From: Linus Torvalds <[email protected]>
33
Subject: corrupt object on git-gc
44
Abstract: Some tricks to reconstruct blob objects in order to fix
55
a corrupted repository.
6+
Content-type: text/asciidoc
67

8+
How to recover a corrupted blob object
9+
======================================
10+
11+
-----------------------------------------------------------
712
On Fri, 9 Nov 2007, Yossi Leybovich wrote:
813
>
914
> Did not help still the repository look for this object?
1015
> Any one know how can I track this object and understand which file is it
16+
-----------------------------------------------------------
1117

1218
So exactly *because* the SHA1 hash is cryptographically secure, the hash
1319
itself doesn't actually tell you anything, in order to fix a corrupt
@@ -31,19 +37,23 @@ original object, so right now the corrupt object is useless, but it's very
3137
interesting for the future, in the hope that you can re-create a
3238
non-corrupt version.
3339

40+
-----------------------------------------------------------
3441
So:
3542

3643
> ib]$ mv .git/objects/4b/9458b3786228369c63936db65827de3cc06200 ../
44+
-----------------------------------------------------------
3745

3846
This is the right thing to do, although it's usually best to save it under
3947
it's full SHA1 name (you just dropped the "4b" from the result ;).
4048

4149
Let's see what that tells us:
4250

51+
-----------------------------------------------------------
4352
> ib]$ git-fsck --full
4453
> broken link from tree 2d9263c6d23595e7cb2a21e5ebbb53655278dff8
4554
> to blob 4b9458b3786228369c63936db65827de3cc06200
4655
> missing blob 4b9458b3786228369c63936db65827de3cc06200
56+
-----------------------------------------------------------
4757

4858
Ok, I removed the "dangling commit" messages, because they are just
4959
messages about the fact that you probably have rebased etc, so they're not

Documentation/howto/revert-a-faulty-merge.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ Abstract: Sometimes a branch that was already merged to the mainline
77
after the offending branch is fixed.
88
Message-ID: <[email protected]>
99
References: <[email protected]>
10+
Content-type: text/asciidoc
11+
12+
How to revert a faulty merge
13+
============================
1014

1115
Alan <[email protected]> said:
1216

Documentation/howto/revert-branch-rebase.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ Date: Mon, 29 Aug 2005 21:39:02 -0700
88
Content-type: text/asciidoc
99
Message-ID: <[email protected]>
1010

11-
Reverting an existing commit
12-
============================
11+
How to revert an existing commit
12+
================================
1313

1414
One of the changes I pulled into the 'master' branch turns out to
1515
break building GIT with GCC 2.95. While they were well intentioned

Documentation/howto/separating-topic-branches.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
From: Junio C Hamano <[email protected]>
22
Subject: Separating topic branches
33
Abstract: In this article, JC describes how to separate topic branches.
4+
Content-type: text/asciidoc
5+
6+
How to separate topic branches
7+
==============================
48

59
This text was originally a footnote to a discussion about the
610
behaviour of the git diff commands.

Documentation/howto/setup-git-server-over-http.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
From: Rutger Nijlunsing <[email protected]>
22
Subject: Setting up a git repository which can be pushed into and pulled from over HTTP(S).
33
Date: Thu, 10 Aug 2006 22:00:26 +0200
4+
Content-type: text/asciidoc
5+
6+
How to setup git server over http
7+
=================================
48

59
Since Apache is one of those packages people like to compile
610
themselves while others prefer the bureaucrat's dream Debian, it is

Documentation/howto/update-hook-example.txt

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ Message-ID: <[email protected]>
55
Abstract: An example hooks/update script is presented to
66
implement repository maintenance policies, such as who can push
77
into which branch and who can make a tag.
8+
Content-type: text/asciidoc
9+
10+
How to use the update hook
11+
==========================
812

913
When your developer runs git-push into the repository,
1014
git-receive-pack is run (either locally or over ssh) as that
@@ -32,8 +36,7 @@ like this as your hooks/update script.
3236
[jc: editorial note. This is a much improved version by Carl
3337
since I posted the original outline]
3438

35-
-- >8 -- beginning of script -- >8 --
36-
39+
----------------------------------------------------
3740
#!/bin/bash
3841

3942
umask 002
@@ -111,12 +114,12 @@ then
111114

112115
info "Found matching head pattern: '$head_pattern'"
113116
for user_pattern in $user_patterns; do
114-
info "Checking user: '$username' against pattern: '$user_pattern'"
115-
matchlen=$(expr "$username" : "$user_pattern")
116-
if test "$matchlen" = "${#username}"
117-
then
118-
grant "Allowing user: '$username' with pattern: '$user_pattern'"
119-
fi
117+
info "Checking user: '$username' against pattern: '$user_pattern'"
118+
matchlen=$(expr "$username" : "$user_pattern")
119+
if test "$matchlen" = "${#username}"
120+
then
121+
grant "Allowing user: '$username' with pattern: '$user_pattern'"
122+
fi
120123
done
121124
deny "The user is not in the access list for this branch"
122125
done
@@ -149,13 +152,13 @@ then
149152

150153
info "Found matching head pattern: '$head_pattern'"
151154
for group_pattern in $group_patterns; do
152-
for groupname in $groups; do
153-
info "Checking group: '$groupname' against pattern: '$group_pattern'"
154-
matchlen=$(expr "$groupname" : "$group_pattern")
155-
if test "$matchlen" = "${#groupname}"
156-
then
157-
grant "Allowing group: '$groupname' with pattern: '$group_pattern'"
158-
fi
155+
for groupname in $groups; do
156+
info "Checking group: '$groupname' against pattern: '$group_pattern'"
157+
matchlen=$(expr "$groupname" : "$group_pattern")
158+
if test "$matchlen" = "${#groupname}"
159+
then
160+
grant "Allowing group: '$groupname' with pattern: '$group_pattern'"
161+
fi
159162
done
160163
done
161164
deny "None of the user's groups are in the access list for this branch"
@@ -169,24 +172,21 @@ then
169172
fi
170173

171174
deny >/dev/null "There are no more rules to check. Denying access"
172-
173-
-- >8 -- end of script -- >8 --
175+
----------------------------------------------------
174176

175177
This uses two files, $GIT_DIR/info/allowed-users and
176178
allowed-groups, to describe which heads can be pushed into by
177179
whom. The format of each file would look like this:
178180

179-
refs/heads/master junio
180-
+refs/heads/pu junio
181-
refs/heads/cogito$ pasky
182-
refs/heads/bw/.* linus
183-
refs/heads/tmp/.* .*
184-
refs/tags/v[0-9].* junio
181+
refs/heads/master junio
182+
+refs/heads/pu junio
183+
refs/heads/cogito$ pasky
184+
refs/heads/bw/.* linus
185+
refs/heads/tmp/.* .*
186+
refs/tags/v[0-9].* junio
185187

186188
With this, Linus can push or create "bw/penguin" or "bw/zebra"
187189
or "bw/panda" branches, Pasky can do only "cogito", and JC can
188190
do master and pu branches and make versioned tags. And anybody
189191
can do tmp/blah branches. The '+' sign at the pu record means
190192
that JC can make non-fast-forward pushes on it.
191-
192-
------------

Documentation/howto/use-git-daemon.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1+
Content-type: text/asciidoc
2+
13
How to use git-daemon
4+
=====================
25

36
Git can be run in inetd mode and in stand alone mode. But all you want is
47
let a coworker pull from you, and therefore need to set up a git server

0 commit comments

Comments
 (0)