Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

make non-core list a bit more visible

  • Loading branch information...
commit 198b649a7011e8de2c7889c40cfbde36b740521e 1 parent dbf6e99
@sitaramc authored
Showing with 46 additions and 31 deletions.
  1. +12 −6 cust.mkd
  2. +3 −0  dev-notes.mkd
  3. +16 −12 master-toc.mkd
  4. +15 −13 non-core.mkd
View
18 cust.mkd
@@ -5,9 +5,16 @@ not considered "core". This keeps the core simpler, and allows you to enhance
gitolite for your own purposes without too much fuss. (As an extreme example,
even mirroring is not in core now!)
-This document will tell you about the types of non-core programs, and
-how/where to install your own. (Actually *writing* the code is described in
-the [developer notes][dev-notes] page).
+Here's how to find out more:
+
+ * this document describes the types of non-core programs and how/where to
+ install your own
+
+ * the [developer notes][dev-notes] page tells you how to write your own
+ non-core programs
+
+ * the [list of non-core programs][non-core] talks about what's already
+ shipped with gitolite, with a brief description of each
----
@@ -28,9 +35,6 @@ There are 5 basic types of non-core programs.
different name to avoid confusion and constant disambiguation in the docs.
* **VREFs** are extensions to the access control check part of gitolite.
-[Here][non-core] is a list of non-core programs shipped with gitolite, with
-some description of each.
-
## #ncloc locations
### default/primary location of non-core programs
@@ -112,6 +116,8 @@ while on the server you can run
Very few commands are designed to be run both ways, but it can be done, by
checking for the presence of env var `GL_USER`.
+All commands respond to a single `-h` option with a suitable message.
+
You can get a **list of available commands** by using the `help` command.
Naturally, a remote user will see a much smaller list than the server user.
View
3  dev-notes.mkd
@@ -11,6 +11,9 @@ over. Plus you may want to write your own programs to interact with it.
scripts. *Installing* them, including "where and how", is described
[here][localcode]**.
+Note: the [customisation][cust] document is the starting point for all
+information about customising gitolite.
+
## environment variables and other inputs
In general, the following environment variables should always be available:
View
28 master-toc.mkd
@@ -124,18 +124,20 @@ since there are so many of them**.
* moving [existing][] repos into gitolite
* [moving][] servers
-## [customisation][cust]
-
- * [where][ncloc] do you put custom code?
- * ([link][pushcode]: updating code via the admin repo)
- * [types][nctypes] of non-core programs
- * [commands][]
- * [hooks][]
- * syntactic [sugar][]
- * ([link][triggers]: triggers)
- * ([link][vref]: VREFs)
- * ([link][non-core]: non-core programs shipped with gitolite)
- * [developer notes][dev-notes] -- writing custom code
+## customising gitolite
+
+ * [customisation][cust] overview
+ * introduction
+ * [where][ncloc] do you put custom code?
+ * ([link][pushcode]: updating code via the admin repo)
+ * [types][nctypes] of non-core programs
+ * [commands][]
+ * [hooks][]
+ * syntactic [sugar][]
+ * ([link][triggers]: triggers)
+ * ([link][vref]: VREFs)
+
+ * [developer notes][dev-notes] -- writing your own custom code
* environment variables and other inputs
* APIs
* the shell API
@@ -147,6 +149,8 @@ since there are so many of them**.
* sugar
* (appendix 1) notes on the INPUT trigger
+ * [list of non-core programs][non-core] shipped with gitolite
+
## background info
* [files and directories][files] involved in install+setup
View
28 non-core.mkd
@@ -2,25 +2,27 @@
**Important Notes on "non-core" features**:
-1. If information about a non-core feature is not found in the documentation,
- it can be found within the source code; please look there.
+1. The [customisation][cust] document is the starting point for all
+ information about customising gitolite.
+
+2. If a non-core feature is shipped with gitolite, but information about it
+ is not found in this document, it can be found within the source code;
+ please look there.
[Commands][], however, have some extra magic, which is not available to
the other types of non-core programs:
- * running 'help', (either as `gitolite help` if you're logged into the
- server, or `ssh git@host help` if you're a remote user), will give you
- a list of commands you are allowed to run.
-
- * every command will respond to being run with a single `-h` option with
- a suitable message. Please report a bug to me if one of them doesn't.
+ * running the command with a single `-h` option (i.e., `gitolite
+ <command> -h` or `ssh git@host <command> -h`), will display a suitable
+ message. Please report a bug to me if one of them doesn't.
-2. The [customisation][cust] document has details about the various types of
- non-core programs that you can add to gitolite, and how to write your own.
+ * running 'help', (either as `gitolite help` on the server, or `ssh
+ git@host help` remotely), will give you a list of commands you are
+ allowed to run.
- In particular, non-core code is **meant** to be [localised for your
- site][localcode] if you don't like what the shipped version does. You can
- even maintain it [within your gitolite-admin repo][pushcode] if you wish.
+3. Non-core code is **meant** to be [localised for your site][localcode] if
+ you don't like what the shipped version does. You can even maintain it
+ [within your gitolite-admin repo][pushcode] if you wish.
----
Please sign in to comment.
Something went wrong with that request. Please try again.