Skip to content

Commit

Permalink
rc file format change: some inline doc/help text fixups
Browse files Browse the repository at this point in the history
  • Loading branch information
sitaramc committed Mar 3, 2013
1 parent d7024de commit c770546
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 17 deletions.
2 changes: 1 addition & 1 deletion src/commands/htpasswd
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Sets your htpasswd, assuming your admin has enabled it.
(Admins: You need to add HTPASSWD_FILE to the rc file, pointing to an
existing, writable, but possibly an initially empty, file, as well as adding
an entry for 'htpasswd' to the COMMANDS hash).
'htpasswd' to the ENABLE list).
=cut

# usage and sanity checks
Expand Down
2 changes: 1 addition & 1 deletion src/commands/rsync
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ BUNDLE SUPPORT
that was then either deleted or rewound in the repo. This is checked
on every invocation.
(2) Add 'rsync' to the COMMANDS list in the rc file
(2) Add 'rsync' to the ENABLE list in the rc file
GENERIC RSYNC SUPPORT
Expand Down
10 changes: 5 additions & 5 deletions src/lib/Gitolite/Triggers/AutoCreate.pm
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@ use warnings;
# perl trigger set for stuff to do with auto-creating repos
# ----------------------------------------------------------------------

# to deny auto-create on read access, add 'AutoCreate::deny_R' to the
# PRE_CREATE trigger list
# to deny auto-create on read access, uncomment 'no-create-on-read' in the
# ENABLE list in the rc file
sub deny_R {
die "autocreate denied\n" if $_[3] and $_[3] eq 'R';
return;
}

# to deny auto-create on read *and* write access, add 'AutoCreate::deny_RW' to
# the PRE_CREATE trigger list. This means you can only create repos using the
# 'create' command, (which needs to be enabled in the COMMANDS list).
# to deny auto-create on read *and* write, uncomment 'no-auto-create' in the
# ENABLE list in the rc file. This means you can only create wild repos using
# the 'create' command, (which needs to be enabled in the ENABLE list).
sub deny_RW {
die "autocreate denied\n" if $_[3] and ( $_[3] eq 'R' or $_[3] eq 'W' );
return;
Expand Down
3 changes: 1 addition & 2 deletions src/lib/Gitolite/Triggers/Shell.pm
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package Gitolite::Triggers::Shell;

# usage notes: this module must be loaded first in the INPUT trigger list. Or
# at least before Mirroring::input anyway.
# usage notes: uncomment 'Shell' in the ENABLE list in the rc file.

# documentation is in the ssh troubleshooting and tips document, under the
# section "giving shell access to gitolite users"
Expand Down
4 changes: 2 additions & 2 deletions src/syntactic-sugar/macros
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ Documentation is mostly by example.

Setup:

* the line
* uncomment the line
'macros',
should be added to the SYNTACTIC_SUGAR list in ~/.gitolite.rc
in the ENABLE list in ~/.gitolite.rc

Notes on macro definition:

Expand Down
4 changes: 2 additions & 2 deletions src/triggers/post-compile/ssh-authkeys-split
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@
# USAGE
# -----
#
# add it to the POST_COMPILE trigger list in the rc file, but *before* the
# ssh-authkeys program entry.
# to enable, uncomment the 'ssh-authkeys-split' line in the ENABLE list in the
# rc file.

cd $GL_ADMIN_BASE/keydir

Expand Down
6 changes: 3 additions & 3 deletions src/triggers/post-compile/update-description-file
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
# just goes with the flow of setting config variables; nothing special needs
# to be done for the description.

# But this only works for gitweb, not for cgit. Cgit users must therefore add
# this line to the POST_COMPILE list in the rc file:
# 'post-compile/update-description-file',
# But this only works for gitweb, not for cgit. Cgit users must uncomment the
# 'cgit' line in the ENABLE list in the rc file (which has the effect of
# adding this program to the POST_COMPILE trigger list).

cd $GL_REPO_BASE
gitolite list-phy-repos | gitolite git-config % gitweb.description |
Expand Down
2 changes: 1 addition & 1 deletion src/triggers/upstream
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ git fetch -q "$url" '+refs/*:refs/*'

# INSTRUCTIONS:
#
# * add 'upstream' to the PRE_GIT trigger list in the rc file.
# * uncomment 'upstream' in the ENABLE list in the rc file.
# * add option lines to conf file. For example:
#
# repo git
Expand Down

0 comments on commit c770546

Please sign in to comment.