Browse Source

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 <th.acker@arcor.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Thomas Ackermann 12 years ago committed by Junio C Hamano
parent
commit
1797e5c50c
  1. 4
      Documentation/howto/maintain-git.txt
  2. 11
      Documentation/howto/rebase-from-internal-branch.txt
  3. 4
      Documentation/howto/rebuild-from-update-hook.txt
  4. 10
      Documentation/howto/recover-corrupted-blob-object.txt
  5. 4
      Documentation/howto/revert-a-faulty-merge.txt
  6. 4
      Documentation/howto/revert-branch-rebase.txt
  7. 4
      Documentation/howto/separating-topic-branches.txt
  8. 4
      Documentation/howto/setup-git-server-over-http.txt
  9. 50
      Documentation/howto/update-hook-example.txt
  10. 3
      Documentation/howto/use-git-daemon.txt
  11. 4
      Documentation/howto/using-signed-tag-in-pull-request.txt

4
Documentation/howto/maintain-git.txt

@ -5,6 +5,10 @@ Abstract: Imagine that git development is racing along as usual, when our friend
neighborhood maintainer is struck down by a wayward bus. Out of the neighborhood maintainer is struck down by a wayward bus. Out of the
hordes of suckers (loyal developers), you have been tricked (chosen) to hordes of suckers (loyal developers), you have been tricked (chosen) to
step up as the new maintainer. This howto will show you "how to" do it. step up as the new maintainer. This howto will show you "how to" do it.
Content-type: text/asciidoc

How to maintain Git
===================


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



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

@ -8,7 +8,12 @@ Abstract: In this article, JC talks about how he rebases the
the "master" branch, and how "rebase" works. Also discussed the "master" branch, and how "rebase" works. Also discussed
is how this applies to individual developers who sends patches is how this applies to individual developers who sends patches
upstream. upstream.
Content-type: text/asciidoc


How to rebase from an internal branch
=====================================

--------------------------------------
Petr Baudis <pasky@suse.cz> writes: Petr Baudis <pasky@suse.cz> writes:


> Dear diary, on Sun, Aug 14, 2005 at 09:57:13AM CEST, I got a letter > Dear diary, on Sun, Aug 14, 2005 at 09:57:13AM CEST, I got a letter
@ -19,6 +24,7 @@ Petr Baudis <pasky@suse.cz> writes:
>> > branch to the real branches. >> > branch to the real branches.
>> >>
> Actually, wouldn't this be also precisely for what StGIT is intended to? > Actually, wouldn't this be also precisely for what StGIT is intended to?
--------------------------------------


Exactly my feeling. I was sort of waiting for Catalin to speak Exactly my feeling. I was sort of waiting for Catalin to speak
up. With its basing philosophical ancestry on quilt, this is 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
the #1' commit. the #1' commit.


-jc -jc

-
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html

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

@ -5,6 +5,10 @@ Date: Fri, 26 Aug 2005 18:19:10 -0700
Abstract: In this how-to article, JC talks about how he Abstract: In this how-to article, JC talks about how he
uses the post-update hook to automate git documentation page uses the post-update hook to automate git documentation page
shown at http://www.kernel.org/pub/software/scm/git/docs/. shown at http://www.kernel.org/pub/software/scm/git/docs/.
Content-type: text/asciidoc

How to rebuild from update hook
===============================


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

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

@ -3,11 +3,17 @@ From: Linus Torvalds <torvalds@linux-foundation.org>
Subject: corrupt object on git-gc Subject: corrupt object on git-gc
Abstract: Some tricks to reconstruct blob objects in order to fix Abstract: Some tricks to reconstruct blob objects in order to fix
a corrupted repository. a corrupted repository.
Content-type: text/asciidoc


How to recover a corrupted blob object
======================================

-----------------------------------------------------------
On Fri, 9 Nov 2007, Yossi Leybovich wrote: On Fri, 9 Nov 2007, Yossi Leybovich wrote:
> >
> Did not help still the repository look for this object? > Did not help still the repository look for this object?
> Any one know how can I track this object and understand which file is it > Any one know how can I track this object and understand which file is it
-----------------------------------------------------------


So exactly *because* the SHA1 hash is cryptographically secure, the hash So exactly *because* the SHA1 hash is cryptographically secure, the hash
itself doesn't actually tell you anything, in order to fix a corrupt 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
interesting for the future, in the hope that you can re-create a interesting for the future, in the hope that you can re-create a
non-corrupt version. non-corrupt version.


-----------------------------------------------------------
So: So:


> ib]$ mv .git/objects/4b/9458b3786228369c63936db65827de3cc06200 ../ > ib]$ mv .git/objects/4b/9458b3786228369c63936db65827de3cc06200 ../
-----------------------------------------------------------


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


Let's see what that tells us: Let's see what that tells us:


-----------------------------------------------------------
> ib]$ git-fsck --full > ib]$ git-fsck --full
> broken link from tree 2d9263c6d23595e7cb2a21e5ebbb53655278dff8 > broken link from tree 2d9263c6d23595e7cb2a21e5ebbb53655278dff8
> to blob 4b9458b3786228369c63936db65827de3cc06200 > to blob 4b9458b3786228369c63936db65827de3cc06200
> missing blob 4b9458b3786228369c63936db65827de3cc06200 > missing blob 4b9458b3786228369c63936db65827de3cc06200
-----------------------------------------------------------


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

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

@ -7,6 +7,10 @@ Abstract: Sometimes a branch that was already merged to the mainline
after the offending branch is fixed. after the offending branch is fixed.
Message-ID: <7vocz8a6zk.fsf@gitster.siamese.dyndns.org> Message-ID: <7vocz8a6zk.fsf@gitster.siamese.dyndns.org>
References: <alpine.LFD.2.00.0812181949450.14014@localhost.localdomain> References: <alpine.LFD.2.00.0812181949450.14014@localhost.localdomain>
Content-type: text/asciidoc

How to revert a faulty merge
============================


Alan <alan@clueserver.org> said: Alan <alan@clueserver.org> said:



4
Documentation/howto/revert-branch-rebase.txt

@ -8,8 +8,8 @@ Date: Mon, 29 Aug 2005 21:39:02 -0700
Content-type: text/asciidoc Content-type: text/asciidoc
Message-ID: <7voe7g3uop.fsf@assigned-by-dhcp.cox.net> Message-ID: <7voe7g3uop.fsf@assigned-by-dhcp.cox.net>


Reverting an existing commit How to revert an existing commit
============================ ================================


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

4
Documentation/howto/separating-topic-branches.txt

@ -1,6 +1,10 @@
From: Junio C Hamano <gitster@pobox.com> From: Junio C Hamano <gitster@pobox.com>
Subject: Separating topic branches Subject: Separating topic branches
Abstract: In this article, JC describes how to separate topic branches. Abstract: In this article, JC describes how to separate topic branches.
Content-type: text/asciidoc

How to separate topic branches
==============================


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

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

@ -1,6 +1,10 @@
From: Rutger Nijlunsing <rutger@nospam.com> From: Rutger Nijlunsing <rutger@nospam.com>
Subject: Setting up a git repository which can be pushed into and pulled from over HTTP(S). Subject: Setting up a git repository which can be pushed into and pulled from over HTTP(S).
Date: Thu, 10 Aug 2006 22:00:26 +0200 Date: Thu, 10 Aug 2006 22:00:26 +0200
Content-type: text/asciidoc

How to setup git server over http
=================================


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

50
Documentation/howto/update-hook-example.txt

@ -5,6 +5,10 @@ Message-ID: <7vfypumlu3.fsf@assigned-by-dhcp.cox.net>
Abstract: An example hooks/update script is presented to Abstract: An example hooks/update script is presented to
implement repository maintenance policies, such as who can push implement repository maintenance policies, such as who can push
into which branch and who can make a tag. into which branch and who can make a tag.
Content-type: text/asciidoc

How to use the update hook
==========================


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


-- >8 -- beginning of script -- >8 -- ----------------------------------------------------

#!/bin/bash #!/bin/bash


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


info "Found matching head pattern: '$head_pattern'" info "Found matching head pattern: '$head_pattern'"
for user_pattern in $user_patterns; do for user_pattern in $user_patterns; do
info "Checking user: '$username' against pattern: '$user_pattern'" info "Checking user: '$username' against pattern: '$user_pattern'"
matchlen=$(expr "$username" : "$user_pattern") matchlen=$(expr "$username" : "$user_pattern")
if test "$matchlen" = "${#username}" if test "$matchlen" = "${#username}"
then then
grant "Allowing user: '$username' with pattern: '$user_pattern'" grant "Allowing user: '$username' with pattern: '$user_pattern'"
fi fi
done done
deny "The user is not in the access list for this branch" deny "The user is not in the access list for this branch"
done done
@ -149,13 +152,13 @@ then


info "Found matching head pattern: '$head_pattern'" info "Found matching head pattern: '$head_pattern'"
for group_pattern in $group_patterns; do for group_pattern in $group_patterns; do
for groupname in $groups; do for groupname in $groups; do
info "Checking group: '$groupname' against pattern: '$group_pattern'" info "Checking group: '$groupname' against pattern: '$group_pattern'"
matchlen=$(expr "$groupname" : "$group_pattern") matchlen=$(expr "$groupname" : "$group_pattern")
if test "$matchlen" = "${#groupname}" if test "$matchlen" = "${#groupname}"
then then
grant "Allowing group: '$groupname' with pattern: '$group_pattern'" grant "Allowing group: '$groupname' with pattern: '$group_pattern'"
fi fi
done done
done done
deny "None of the user's groups are in the access list for this branch" deny "None of the user's groups are in the access list for this branch"
@ -169,24 +172,21 @@ then
fi fi


deny >/dev/null "There are no more rules to check. Denying access" deny >/dev/null "There are no more rules to check. Denying access"

----------------------------------------------------
-- >8 -- end of script -- >8 --


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


refs/heads/master junio refs/heads/master junio
+refs/heads/pu junio +refs/heads/pu junio
refs/heads/cogito$ pasky refs/heads/cogito$ pasky
refs/heads/bw/.* linus refs/heads/bw/.* linus
refs/heads/tmp/.* .* refs/heads/tmp/.* .*
refs/tags/v[0-9].* junio refs/tags/v[0-9].* junio


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

------------

3
Documentation/howto/use-git-daemon.txt

@ -1,4 +1,7 @@
Content-type: text/asciidoc

How to use git-daemon How to use git-daemon
=====================


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

4
Documentation/howto/using-signed-tag-in-pull-request.txt

@ -7,8 +7,8 @@ Abstract: Beginning v1.7.9, a contributor can push a signed tag to her
later validate it. later validate it.
Content-type: text/asciidoc Content-type: text/asciidoc


Using signed tag in pull requests How to use a signed tag in pull requests
================================= ========================================


A typical distributed workflow using Git is for a contributor to fork a A typical distributed workflow using Git is for a contributor to fork a
project, build on it, publish the result to her public repository, and ask project, build on it, publish the result to her public repository, and ask

Loading…
Cancel
Save