From b60dd9c34933064b0bdc928186b92701fe595a9c Mon Sep 17 00:00:00 2001 From: Sitaram Chamarty Date: Sat, 14 Apr 2012 12:45:53 +0530 Subject: [PATCH] (minor) packaging notes updated --- doc/dev-notes.mkd | 6 +++--- doc/install.mkd | 30 +++++++++++++++++++----------- 2 files changed, 22 insertions(+), 14 deletions(-) diff --git a/doc/dev-notes.mkd b/doc/dev-notes.mkd index 3b1a6f1..ae9ab40 100644 --- a/doc/dev-notes.mkd +++ b/doc/dev-notes.mkd @@ -42,12 +42,12 @@ more info. * `gitolite query-rc` to check the value of an RC variable. Example use: src/commands/desc. -In addition, you can also look at the comments in src/Gitolite/Easy.pm (the -perl API module) for ideas. +In addition, you can also look at the comments in src/lib/Gitolite/Easy.pm +(the perl API module) for ideas. ### the perl API -...is implemented by Gitolite::Easy; the comments in src/Gitolite/Easy.pm +...is implemented by Gitolite::Easy; the comments in src/lib/Gitolite/Easy.pm serve as documentation. ## writing your own... diff --git a/doc/install.mkd b/doc/install.mkd index 4aef457..e5799b0 100644 --- a/doc/install.mkd +++ b/doc/install.mkd @@ -113,24 +113,32 @@ Creating a symlink doesn't need a separate program but 'install' also runs * Update your clone of the gitolite source. * Repeat the install command you used earlier (make sure you use the same arguments as before). - * Run `gitolite setup` just in case the hooks changed. + * Run `gitolite setup`. ## packaging gitolite -1. Put src/Gitolite in `/usr/share/perl5/vendor_perl` or some such place. +Here are the requirements for gitolite: -2. Put the rest of src anywhere your distro policy allows. (Fedora keeps - git's 150 executables in /usr/libexec/git-core, so maybe - /usr/libexec/gitolite?) + * The programs `gitolite` and `gitolite-shell`, and the directories + `commands`, `lib`, `syntactic-sugar`, `triggers`, and `VREF` must all be + in the same directory. -3. Symlink 'gitolite' to /usr/bin or something, similar to option 2. + It doesn't matter what this directory is. As an example, Fedora keeps + git's 150 executables in /usr/libexec/git-core, so /usr/libexec/gitolite + may be a good choice; it's upto you. -**Bottom line**: + The rest of this section will assume you chose /usr/libexec/gitolite as + the location. Adjust as needed. - * `GL_BINDIR` must point to a place that contains `commands`, `VREF`, and - `syntactic-sugar` (so they must all be sibling directories). - * The `Gitolite` directory can also be there, or it can be anywhere in - perl's `@INC` path. + * The program `/usr/libexec/gitolite/gitolite` must then be *symlinked* to + some directory in the PATH. Do not *copy* it; it must be a symlink. + + * The `Gitolite` subdirectory in `/usr/libexec/gitolite/lib` can stay there, + **OR**, if your distro policies don't allow that, can be put in any + directory in perl's `@INC` path (such as `/usr/share/perl5/vendor_perl`). + + * Finally, a file called `/usr/libexec/gitolite/VERSION` must contain a + suitable version string. ## #migr migrating