From cf3dd885fcfc7ed63d83b7e4eaa1b9d517ed29fd Mon Sep 17 00:00:00 2001 From: Sitaram Chamarty Date: Thu, 19 Apr 2012 06:33:36 +0530 Subject: [PATCH] (some docfixes) --- README.mkd | 23 +++++++++++++++-------- doc/dev-status.mkd | 2 +- doc/index.mkd | 2 +- doc/install.mkd | 20 +++++++++++++------- doc/mkdoc | 3 +++ 5 files changed, 33 insertions(+), 17 deletions(-) diff --git a/README.mkd b/README.mkd index e41f513..6400dc4 100644 --- a/README.mkd +++ b/README.mkd @@ -12,20 +12,27 @@ If you're reading this on the main gitolite page on github, several branch, and is now the actively maintained and supported software. Do NOT try to merge this with your old "master" branch! + The [main page][h-mp] leads to several useful starting points. The [table + of contents][h-mt] is a much more meaningfully ordered/structured list of + links (instead of putting them in alphabetical order of the filename, like + in g2!) + + If you are an existing (g2) user and wish to migrate, you MUST read + [this](http://sitaramc.github.com/gitolite/install.html#migr). + 2. Versions v2.x are on branch "g2". It will be supported for security issues and serious bugs in core functionality, but not for anything less - critical. Versions v1.x are completely unsupported now. - -If you're an existing (v1.x, v2.x) gitolite user please spend some time with -the documentation for the new version before upgrading. The [main page][h-mp] -leads to several useful starting points. The [table of contents][h-mt] is a -much more meaningfully ordered/structured list of links (instead of putting -them in alphabetical order of the filename, like in g2!) + critical. Versions v1.x are completely unsupported now. (Documentation + links for this version are [here][o1] and [here][o2]). [h-mp]: http://sitaramc.github.com/gitolite/ [h-mt]: http://sitaramc.github.com/gitolite/master-toc.html +[o1]: http://sitaramc.github.com/gitolite/g2/ +[o2]: http://sitaramc.github.com/gitolite/g2/master-toc.html ---- License information for code and documentation is at the end of doc/index.mkd -(or you can read it online [here][license]). +(or you can read it online +[here](http://sitaramc.github.com/gitolite/index.html#license)). + diff --git a/doc/dev-status.mkd b/doc/dev-status.mkd index c9af92a..03ef93f 100644 --- a/doc/dev-status.mkd +++ b/doc/dev-status.mkd @@ -2,7 +2,6 @@ Not yet done (will be tackled in this order unless someone asks): - * svnserve (someone is testing it) * mechanism for ADCs using unchecked arguments -- this is not just a matter of writing it; I have to think about *how* it will be done. (AFAIK the only tool affected is git-annexe; if there are more let me know) @@ -33,3 +32,4 @@ Done: * distro packaging instructions * migration advice for common cases * smart http + * svnserve diff --git a/doc/index.mkd b/doc/index.mkd index b153b50..9552975 100644 --- a/doc/index.mkd +++ b/doc/index.mkd @@ -13,7 +13,7 @@ For users of gitolite v2.x (call it "g2" for convenience), * [Why][g3why] I rewrote gitolite. * Development [status][dev-status]. - * Specific migration [issues and steps][g2migr]. + * Information on [migrating][migr] from g2 to g3. diff --git a/doc/install.mkd b/doc/install.mkd index 14f68ea..e3e925f 100644 --- a/doc/install.mkd +++ b/doc/install.mkd @@ -4,6 +4,12 @@ settings that MUST be dealt with **before** running `gitolite setup`; please start [here][migr]. RTFM is *mandatory* for migrations. +---- + +[[TOC]] + +---- + ## notes and naming conventions Gitolite uses a single "real" (i.e., unix) user to provide secure access to @@ -138,8 +144,8 @@ Here are the requirements for gitolite: ## #migr migrating -If you're migrating from gitosis, [this][gsmigr] is what -you want to start with. +This section is about migrating from older gitolite to +"g3". If you're migrating from gitosis, see [here][gsmigr]. First things first: g2 will be supported for a good long time for critical bugs, although enhancements and new features won't happen. @@ -147,7 +153,7 @@ bugs, although enhancements and new features won't happen. If you're an existing (gitolite v1.x or v2.x) user, and wish to migrate , here are the steps: -### pre-migration +### pre-migration checks 1. Check the [dev-status][] page to make sure all the features you want have been implemented in g3. @@ -157,13 +163,13 @@ are the steps: you were to a default install of the old gitolite, the less time a migration will take.) -### migration +### the actual migration **Note**: nothing in any of the gitolite install/setup/etc will ever touch the *data* in any repository except the gitolite-admin repo. The only thing it will normally touch in normal repos is the `update` hook. -1. Carefully wipe out the old gitolite +1. **On the server**, carefully wipe out the old gitolite: * The **code** @@ -203,8 +209,8 @@ will normally touch in normal repos is the `update` hook. followed by [setup][]. 4. Make sure your gitolite-admin clone has the correct pubkey for the - administrator in its `keydir` directory, then `git push -f` to the server - to overwrite the "default" admin repo created by the install. + administrator in its `keydir` directory, then run [`gitolite push + -f`][bypass] to overwrite the "default" admin repo created by the install. 5. Handle any errors, look for migration issues, etc., as described in the links at the top of this page. diff --git a/doc/mkdoc b/doc/mkdoc index 2f44d6c..bce1013 100755 --- a/doc/mkdoc +++ b/doc/mkdoc @@ -113,3 +113,6 @@ __DATA__ | license

+

+This is for gitolite "g3"; for older (v2.x) documentation click here +