Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

make non-core list a bit more visible

  • Loading branch information...
commit 198b649a7011e8de2c7889c40cfbde36b740521e 1 parent dbf6e99
Sitaram Chamarty authored December 21, 2012
18  cust.mkd
Source Rendered
@@ -5,9 +5,16 @@ not considered "core".  This keeps the core simpler, and allows you to enhance
5 5
 gitolite for your own purposes without too much fuss.  (As an extreme example,
6 6
 even mirroring is not in core now!)
7 7
 
8  
-This document will tell you about the types of non-core programs, and
9  
-how/where to install your own.  (Actually *writing* the code is described in
10  
-the [developer notes][dev-notes] page).
  8
+Here's how to find out more:
  9
+
  10
+  * this document describes the types of non-core programs and how/where to
  11
+    install your own
  12
+
  13
+  * the [developer notes][dev-notes] page tells you how to write your own
  14
+    non-core programs
  15
+
  16
+  * the [list of non-core programs][non-core] talks about what's already
  17
+    shipped with gitolite, with a brief description of each
11 18
 
12 19
 ----
13 20
 
@@ -28,9 +35,6 @@ There are 5 basic types of non-core programs.
28 35
     different name to avoid confusion and constant disambiguation in the docs.
29 36
   * **VREFs** are extensions to the access control check part of gitolite.
30 37
 
31  
-[Here][non-core] is a list of non-core programs shipped with gitolite, with
32  
-some description of each.
33  
-
34 38
 ## #ncloc locations
35 39
 
36 40
 ### default/primary location of non-core programs
@@ -112,6 +116,8 @@ while on the server you can run
112 116
 Very few commands are designed to be run both ways, but it can be done, by
113 117
 checking for the presence of env var `GL_USER`.
114 118
 
  119
+All commands respond to a single `-h` option with a suitable message.
  120
+
115 121
 You can get a **list of available commands** by using the `help` command.
116 122
 Naturally, a remote user will see a much smaller list than the server user.
117 123
 
3  dev-notes.mkd
Source Rendered
@@ -11,6 +11,9 @@ over.  Plus you may want to write your own programs to interact with it.
11 11
 scripts.  *Installing* them, including "where and how", is described
12 12
 [here][localcode]**.
13 13
 
  14
+Note: the [customisation][cust] document is the starting point for all
  15
+information about customising gitolite.
  16
+
14 17
 ## environment variables and other inputs
15 18
 
16 19
 In general, the following environment variables should always be available:
28  master-toc.mkd
Source Rendered
@@ -124,18 +124,20 @@ since there are so many of them**.
124 124
   * moving [existing][] repos into gitolite
125 125
   * [moving][] servers
126 126
 
127  
-## [customisation][cust]
128  
-
129  
-  * [where][ncloc] do you put custom code?
130  
-      * ([link][pushcode]: updating code via the admin repo)
131  
-  * [types][nctypes] of non-core programs
132  
-      * [commands][]
133  
-      * [hooks][]
134  
-      * syntactic [sugar][]
135  
-      * ([link][triggers]: triggers)
136  
-      * ([link][vref]: VREFs)
137  
-  * ([link][non-core]: non-core programs shipped with gitolite)
138  
-  * [developer notes][dev-notes] -- writing custom code
  127
+## customising gitolite
  128
+
  129
+  * [customisation][cust] overview
  130
+      * introduction
  131
+      * [where][ncloc] do you put custom code?
  132
+          * ([link][pushcode]: updating code via the admin repo)
  133
+      * [types][nctypes] of non-core programs
  134
+          * [commands][]
  135
+          * [hooks][]
  136
+          * syntactic [sugar][]
  137
+          * ([link][triggers]: triggers)
  138
+          * ([link][vref]: VREFs)
  139
+
  140
+  * [developer notes][dev-notes] -- writing your own custom code
139 141
       * environment variables and other inputs
140 142
       * APIs
141 143
           * the shell API
@@ -147,6 +149,8 @@ since there are so many of them**.
147 149
           * sugar
148 150
       * (appendix 1) notes on the INPUT trigger
149 151
 
  152
+  * [list of non-core programs][non-core] shipped with gitolite
  153
+
150 154
 ## background info
151 155
 
152 156
   * [files and directories][files] involved in install+setup
28  non-core.mkd
Source Rendered
@@ -2,25 +2,27 @@
2 2
 
3 3
 **Important Notes on "non-core" features**:
4 4
 
5  
-1.  If information about a non-core feature is not found in the documentation,
6  
-    it can be found within the source code; please look there.
  5
+1.  The [customisation][cust] document is the starting point for all
  6
+    information about customising gitolite.
  7
+
  8
+2.  If a non-core feature is shipped with gitolite, but information about it
  9
+    is not found in this document, it can be found within the source code;
  10
+    please look there.
7 11
 
8 12
     [Commands][], however, have some extra magic, which is not available to
9 13
     the other types of non-core programs:
10 14
 
11  
-      * running 'help', (either as `gitolite help` if you're logged into the
12  
-        server, or `ssh git@host help` if you're a remote user), will give you
13  
-        a list of commands you are allowed to run.
14  
-
15  
-      * every command will respond to being run with a single `-h` option with
16  
-        a suitable message.  Please report a bug to me if one of them doesn't.
  15
+      * running the command with a single `-h` option (i.e., `gitolite
  16
+        <command> -h` or `ssh git@host <command> -h`), will display a suitable
  17
+        message.  Please report a bug to me if one of them doesn't.
17 18
 
18  
-2.  The [customisation][cust] document has details about the various types of
19  
-    non-core programs that you can add to gitolite, and how to write your own.
  19
+      * running 'help', (either as `gitolite help` on the server, or `ssh
  20
+        git@host help` remotely), will give you a list of commands you are
  21
+        allowed to run.
20 22
 
21  
-    In particular, non-core code is **meant** to be [localised for your
22  
-    site][localcode] if you don't like what the shipped version does.  You can
23  
-    even maintain it [within your gitolite-admin repo][pushcode] if you wish.
  23
+3.  Non-core code is **meant** to be [localised for your site][localcode] if
  24
+    you don't like what the shipped version does.  You can even maintain it
  25
+    [within your gitolite-admin repo][pushcode] if you wish.
24 26
 
25 27
 ----
26 28
 

0 notes on commit 198b649

Please sign in to comment.
Something went wrong with that request. Please try again.