summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Friesel <derf@derf.homelinux.org>2009-07-17 20:46:10 +0200
committerDaniel Friesel <derf@derf.homelinux.org>2009-07-17 20:46:10 +0200
commit9709b98b8e5456cb9f39f51849a7e14a8ffb7176 (patch)
treedeb6d49d0d7662f775c15a9e78a1f9e661006df4
parent1d56581a4f69fd6953af24b8650c41909002d7c4 (diff)
caretaker-setup.pod: Added CREATING A PACKAGE (example: vim package)
-rw-r--r--man/7/caretaker-setup.pod41
1 files changed, 41 insertions, 0 deletions
diff --git a/man/7/caretaker-setup.pod b/man/7/caretaker-setup.pod
index d59a0a2..334c9ea 100644
--- a/man/7/caretaker-setup.pod
+++ b/man/7/caretaker-setup.pod
@@ -15,3 +15,44 @@ Now you can add your own packages as git repos in PKG_ROOT.
To use caretaker with your packages on a machine, download and execute
the bootstrap script (include/bootstrap).
+
+=head1 CREATING A PACKAGE
+
+Example: a vim package
+
+First of all, you'll need to create the package's git repository. Ideally you do not do
+this in the package root itself, since it's recommended to have bare git repos there.
+
+ client ~ > cd /tmp
+ client /tmp > mkdir vim; cd vim
+ /client tmp/vim > git init
+ Initialized empty Git repository in /tmp/vim/.git/
+ /client tmp/vim > mkdir etc
+ /client tmp/vim > cp $your_fancy_vimrc etc/vimrc
+ /client tmp/vim > echo 'soft .vimrc $etc/vimrc' > links
+ /client tmp/vim > git add .
+ /client tmp/vim > git commit -m 'initial commit. Now with extra cake'
+ [master (root-commit) 4359548] initial commit. Now with extra cake
+ 2 files changed, 51 insertions(+), 0 deletions(-)
+ create mode 100644 etc/vimrc
+ create mode 100644 links
+
+You now have a working vim package, it just is not accessible to caretaker yet.
+So let's fix that.
+
+ server $PKG_ROOT > mkdir vim; cd vim
+ server $PKG_ROOT/vim > git --bare init
+
+ client /tmp/vim > git push server:$PKG_ROOT/vim master
+
+Now you can install the vim package the normal way
+
+ client ~ > ct update
+ Updating local package list
+ Updating remote package list
+ client ~ > ct add vim
+ Retrieving package vim...
+ [...]
+ created .vimrc -> packages/vim/etc/vimrc
+
+And that's it. You can safely rm -rf /tmp/vim now.