From 9774b72e8c0c9b0628de21d08e922d808e9fb0c3 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Apr 25 2018 09:44:14 +0000 Subject: [PATCH 1/2] Fix the hierarchy of titles in the configuration doc Signed-off-by: Pierre-Yves Chibon --- diff --git a/doc/configuration.rst b/doc/configuration.rst index 8f8a354..9254499 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -237,14 +237,14 @@ other systems (cf :ref:`custom-gitolite`). ~~~~~~~~~~~~~~~~~~~~ GITOLITE_HOME -~~~~~~~~~~~~~ +^^^^^^^^^^^^^ This configuration key points to the home directory of the user under which gitolite is ran. GITOLITE_KEYDIR -~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^ This configuration key points to the folder where gitolite stores and accesses the public SSH keys of all the user have access to the server. @@ -254,14 +254,14 @@ in this directory, effectively setting up the users to be able to use gitolite. GITOLITE_CONFIG -~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^ This configuration key points to the gitolite.conf file where pagure writes the gitolite repository access configuration. GITOLITE_BACKEND -~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^ This configuration key allows specifying which helper method to use to generate and compile gitolite's configuration file. @@ -278,7 +278,7 @@ Defaults to: ``gitolite3`` GITOLITE_CELERY_QUEUE -~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^ This configuration is useful for large pagure deployment where recompiling the gitolite config file can take a long time. By default the compilation @@ -299,25 +299,26 @@ to ``gitolite_queue``. ~~~~~~~~~~~~~~~~~~~ GL_RC -~~~~~ +^^^^^ This configuration key points to the file ``gitolite.rc`` used by gitolite to record who has access to what (ie: who has access to which repo/branch). GL_BINDIR -~~~~~~~~~ +^^^^^^^^^ This configuration key indicates the folder in which the gitolite tools can be found. It can be as simple as ``/usr/bin/`` if the tools have been installed using a package manager or something like ``/opt/bin/`` for a more custom install. + **gitolite 3 only** ~~~~~~~~~~~~~~~~~~~ GITOLITE_HAS_COMPILE_1 -~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^ By setting this configuration key to ``True``, you can turn on using the gitolite ``compile-1`` binary. This speeds up gitolite task when it recompiles @@ -337,6 +338,7 @@ conditions must be met: Defaults to: ``False`` + EventSource options ------------------- From c7a8ffdd5bff94808a08aef07dbf9948fab96c4a Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Apr 25 2018 09:44:14 +0000 Subject: [PATCH 2/2] Reword how to get compile-1 support in gitolite3 Explicitely mention that the command should be executable as otherwise gitolite won't find it Signed-off-by: Pierre-Yves Chibon --- diff --git a/doc/configuration.rst b/doc/configuration.rst index 9254499..6d97aa8 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -322,19 +322,33 @@ GITOLITE_HAS_COMPILE_1 By setting this configuration key to ``True``, you can turn on using the gitolite ``compile-1`` binary. This speeds up gitolite task when it recompiles -configuration after new project is created. In order to use this, some -conditions must be met: - -* You have to uncomment ``LOCAL_CODE`` in your ``gitolite.rc`` file and set it - to a full path of a directory that you choose. -* You have to copy ``compile-1`` binary into a subdirectory ``commands`` of the - directory from the previous step. If your installation doesn't ship this file, - you can `download it - `_. +configuration after new project is created. In order to use this, you need to +have the ``compile-1`` gitolite command. + +There are two ways to have it, + +#. You distribution already has the file installed for you and you can then + just use it. +#. You need to download and install it yourself. We are describing what + needs to be done for this here below. + +Installing the ``compile-1`` command: + * You also have to make sure that your distribution of gitolite contains `patch `_ - which makes gitolite respect ``ALLOW_ORPHAN_GL_CONF`` configuration variable. -* Finally, you must set ``ALLOW_ORPHAN_GL_CONF`` to ``1`` in ``gitolite.rc``. + which makes gitolite respect ``ALLOW_ORPHAN_GL_CONF`` configuration variable, + if this patch isn't already present, you will have to make the change yourself. +* In your ``gitolite.rc`` set ``ALLOW_ORPHAN_GL_CONF`` to ``1`` (you may + have to add it yourself). +* Still in your ``gitolite.rc`` file, uncomment ``LOCAL_CODE`` file and set + it to a full path of a directory that you choose (for example + ``/usr/local/share/gitolite3``). +* Create a subdirectory ``commands`` under the path you picked for ``LOCAL_CODE`` + (in our example, you will need to do: ``mkdir -p /usr/local/share/gitolite3/commands``) +* Finally, install the ``compile-1`` command in this ``commands`` subdirectory + If your installation doesn't ship this file, you can `download it + `_. + (Ensure the file is executable, otherwise gitolite will not find it) Defaults to: ``False``