Add setup instructions for quilt to README

master
Daniel Borchmann 2020-12-20 09:56:51 +01:00
parent e35997d9e3
commit 9e36dbd23f
No known key found for this signature in database
GPG Key ID: 1C7071A75BB72D64
2 changed files with 38 additions and 1 deletions

1
.gitignore vendored
View File

@ -1,2 +1,3 @@
# ignore quilt cache directory
/.pc/
/README.html

View File

@ -6,7 +6,8 @@ is either included as a git-submodule (preferred) or, if that is not possible,
directly contained in this repository. Additionally, local modifications of
certain modes (like disabling particular features) are included as separate
patches in the `patches` directory. These can be applied with `quilt push -a`
Before updating mods, unapply the patches with `quilt pop -a`.
Before updating mods, unapply the patches with `quilt pop -a`. See also section
on [setting up git](#git-setup) below.
Some standard extension mods are not included here, because they are shipped
with Debian. Run the following command to satisfy these dependencies:
@ -36,3 +37,38 @@ again. Enjoy! ☺
For licenses and copyrights see the corresponding mods. All that remains is
licensed under an MIT License.
<a name="git-setup">Setting up git hooks for remote updating</a>
-----------------------------------------------------------------
To automatically update a local copy of this git repository on updates, perform
the following configuration
- Make the local copy update its worktree on push, instead of barfing:
~~~sh
git config receive.denyCurrentBranch updateInstead
~~~
- Remove `quilt` patches on `pre-receive`, i.e., before receiving updates:
~~~sh
cat <<SCRIPT > .git/hooks/pre-receive
#!/bin/sh
quilt pop -a
SCRIPT
chmod +x .git/hooks/pre-receive
~~~
- After pushing, update all submodules, apply patches, and fix permissions:
~~~sh
cat <<SCRIPT > .git/hooks/post-update
#!/bin/sh
git submodule update --init
quilt push -a
chmod -R a+rX .
SCRIPT
chmod +x .git/hooks/post-update
~~~