diff --git a/doc/dev-notes.mkd b/doc/dev-notes.mkd index f652d93..9361fa4 100644 --- a/doc/dev-notes.mkd +++ b/doc/dev-notes.mkd @@ -50,9 +50,8 @@ perl API module) for ideas. ### the perl API -...is implemented by Gitolite::Easy; see src/Gitolite/Easy.pm. This is a work -in progress; for example it does not yet have the equivalent of `gitolite -git-config`. I'll add it when I or someone else needs it. +...is implemented by Gitolite::Easy; the comments in src/Gitolite/Easy.pm +serve as documentation. ## your own hooks diff --git a/doc/g2rcdiff.mkd b/doc/g2rcdiff.mkd index 53ebd55..5fa2605 100644 --- a/doc/g2rcdiff.mkd +++ b/doc/g2rcdiff.mkd @@ -11,11 +11,20 @@ when you're ready to migrate. Instead, you need to run # (assuming you saved your g2 rc file somewhere) gitolite print-default-rc > $HOME/.gitolite.rc $EDITOR $HOME/.gitolite.rc - # make appropriate changes, save + # make appropriate changes (see below), save gitolite setup -One example of this is `GL_NO_SETUP_AUTHKEYS`. If you don't jump in and fix -the rc first, the first run will clobber your authkeys file. +The most serious example of this is `GL_NO_SETUP_AUTHKEYS`. If you don't +preset the rc (in this case, by commenting out the 'ssh-authkeys' line) +**before** running `gitolite setup`, your `~/.ssh/authorized_keys` file will +get clobbered. + +There are several other settings that you may want to look at, with varying +degrees of severity; **please go through the list below before blindly running +`gitolite setup`**. (For example, if you had `GL_NO_DAEMON_NO_GITWEB` in g2 +but forgot to comment out all the gitweb and daemon update lines in the rc +file, your projects.list and git-daemon-export-ok files might get clobbered. +Of course this is less severe than ssh authkeys but still...). ### rc file differences diff --git a/doc/install.mkd b/doc/install.mkd index bc08162..51ca10f 100644 --- a/doc/install.mkd +++ b/doc/install.mkd @@ -4,6 +4,11 @@ Gitolite has only one server side "command" now, much like git itself. And it's been designed so that you don't even really have to *install* it, as you will see. +**NOTE**: if you're migrating from g2, there are some settings that MUST be +dealt with **before** running `gitolite setup`; please read the [g2 +migration][g2migr] page and linked pages, and especially the one on +'presetting the rc file][rc-preset]. + ## simplest 1. Put all of `src` in one place, doesn't matter where; let's call it