Mercurial > kallithea
changeset 5434:8867673c8192
docs: consistent spacing between text
| author | Mads Kiilerich <madski@unity3d.com> |
|---|---|
| date | Wed, 26 Aug 2015 17:28:58 +0200 |
| parents | fbbe80e3322b |
| children | 60e04a21bf0f |
| files | docs/api/api.rst docs/installation.rst docs/installation_win.rst docs/installation_win_old.rst docs/setup.rst docs/usage/general.rst docs/usage/performance.rst docs/usage/troubleshooting.rst docs/usage/vcs_support.rst |
| diffstat | 9 files changed, 0 insertions(+), 43 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/api/api.rst Wed Aug 26 17:28:58 2015 +0200 +++ b/docs/api/api.rst Wed Aug 26 17:28:58 2015 +0200 @@ -252,7 +252,6 @@ Any userid can be specified when the command is executed using the api_key of a user with admin rights. Regular users can only speicy their own userid. - INPUT:: id : <id_for_response> @@ -295,7 +294,6 @@ List all existing users. This command can only be executed using the api_key of a user with admin rights. - INPUT:: id : <id_for_response> @@ -325,7 +323,6 @@ ] error: null - .. _create-user: create_user @@ -334,7 +331,6 @@ Create new user. This command can only be executed using the api_key of a user with admin rights. - INPUT:: id : <id_for_response> @@ -381,7 +377,6 @@ Update the given user if such user exists. This command can only be executed using the api_key of a user with admin rights. - INPUT:: id : <id_for_response> @@ -426,7 +421,6 @@ Delete the given user if such a user exists. This command can only be executed using the api_key of a user with admin rights. - INPUT:: id : <id_for_response> @@ -451,7 +445,6 @@ Get an existing user group. This command can only be executed using the api_key of a user with admin rights. - INPUT:: id : <id_for_response> @@ -494,7 +487,6 @@ List all existing user groups. This command can only be executed using the api_key of a user with admin rights. - INPUT:: id : <id_for_response> @@ -521,7 +513,6 @@ Create a new user group. This command can only be executed using the api_key of a user with admin rights. - INPUT:: id : <id_for_response> @@ -553,7 +544,6 @@ ``false``. This command can only be executed using the api_key of a user with admin rights. - INPUT:: id : <id_for_response> @@ -581,7 +571,6 @@ be ``false``. This command can only be executed using the api_key of a user with admin rights. - INPUT:: id : <id_for_response> @@ -698,7 +687,6 @@ This command can only be executed using the api_key of a user with admin rights, or that of a regular user with at least read access to the repository. - INPUT:: id : <id_for_response> @@ -736,7 +724,6 @@ It is possible to specify ret_type to show only ``files`` or ``dirs``. This command can only be executed using the api_key of a user with admin rights. - INPUT:: id : <id_for_response> @@ -772,7 +759,6 @@ or that of a regular user with create repository permission. Regular users cannot specify owner parameter. - INPUT:: id : <id_for_response> @@ -822,7 +808,6 @@ or that of a regular user with create repository permission. Regular users cannot specify owner parameter. - INPUT:: id : <id_for_response> @@ -886,7 +871,6 @@ repository permission and at least read access to the repository. Regular users cannot specify owner parameter. - INPUT:: id : <id_for_response> @@ -920,7 +904,6 @@ or that of a regular user with admin access to the repository. When ``forks`` param is set it is possible to detach or delete forks of the deleted repository. - INPUT:: id : <id_for_response> @@ -946,7 +929,6 @@ Grant permission for a user on the given repository, or update the existing one if found. This command can only be executed using the api_key of a user with admin rights. - INPUT:: id : <id_for_response> @@ -973,7 +955,6 @@ Revoke permission for a user on the given repository. This command can only be executed using the api_key of a user with admin rights. - INPUT:: id : <id_for_response> @@ -1000,7 +981,6 @@ existing one if found. This command can only be executed using the api_key of a user with admin rights. - INPUT:: id : <id_for_response>
--- a/docs/installation.rst Wed Aug 26 17:28:58 2015 +0200 +++ b/docs/installation.rst Wed Aug 26 17:28:58 2015 +0200 @@ -123,19 +123,16 @@ instance from version 0.1 to 0.2, the ``my.ini`` file could be backed up to ``my.ini.0-1``. - If using a SQLite database, stop the Kallithea process/daemon/service, and then make a copy of the database file:: service kallithea stop cp kallithea.db kallithea.db.{version} - Back up your configuration file:: cp my.ini my.ini.{version} - Ensure that you are using the Python virtual environment that you originally installed Kallithea in by running:: @@ -146,12 +143,10 @@ source /srv/kallithea/venv/bin/activate - Once you have verified the environment you can upgrade Kallithea with:: pip install --upgrade kallithea - Then run the following command from the installation directory:: paster make-config Kallithea my.ini @@ -164,12 +159,10 @@ Please always make sure your .ini files are up to date. Errors can often be caused by missing parameters added in new versions. - It is also recommended that you rebuild the whoosh index after upgrading since the new whoosh version could introduce some incompatible index changes. Please read the changelog to see if there were any changes to whoosh. - The final step is to upgrade the database. To do this simply run:: paster upgrade-db my.ini @@ -178,7 +171,6 @@ and will always recheck the settings of the application, if there are no new options that need to be set. - .. note:: The DB schema upgrade library has some limitations and can sometimes fail if you try to upgrade from older major releases. In such a case simply run upgrades sequentially, e.g.,
--- a/docs/installation_win.rst Wed Aug 26 17:28:58 2015 +0200 +++ b/docs/installation_win.rst Wed Aug 26 17:28:58 2015 +0200 @@ -206,7 +206,6 @@ Remark: If it does not work the first time, Ctrl-C the CMD process and start it again. Don't forget the "http://" in Internet Explorer. - What this guide does not cover: - Installing Celery
--- a/docs/installation_win_old.rst Wed Aug 26 17:28:58 2015 +0200 +++ b/docs/installation_win_old.rst Wed Aug 26 17:28:58 2015 +0200 @@ -178,7 +178,6 @@ %comspec% /k ""C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\vcvarsall.bat"" amd64 - In that CMD (loaded with VS2008 PATHs) type:: cd C:\Kallithea\Env\Scripts (or similar) @@ -247,7 +246,6 @@ If it does not work first time, just Ctrl-C the CMD process and start it again. Don't forget the "http://" in Internet Explorer - What this Guide does not cover: - Installing Celery
--- a/docs/setup.rst Wed Aug 26 17:28:58 2015 +0200 +++ b/docs/setup.rst Wed Aug 26 17:28:58 2015 +0200 @@ -18,7 +18,6 @@ proxy port, email settings, usage of static files, cache, Celery settings, and logging. - Next, you need to create the databases used by Kallithea. It is recommended to use PostgreSQL or SQLite (default). If you choose a database other than the default, ensure you properly adjust the database URL in your ``my.ini`` @@ -39,7 +38,6 @@ paster setup-db my.ini --user=nn --password=secret --email=nn@example.org --repos=/srv/repos - The ``setup-db`` command will create all needed tables and an admin account. When choosing a root path you can either use a new empty location, or a location which already contains existing @@ -144,7 +142,6 @@ paster make-index my.ini --index-only=vcs,kallithea - To keep your index up-to-date it is necessary to do periodic index builds; for this, it is recommended to use a crontab entry. Example:: @@ -430,7 +427,6 @@ RequestHeader set X-Forwarded-User %{RU}e </Location> - .. note:: If you enable proxy pass-through authentication, make sure your server is only accessible through the proxy. Otherwise, any client would be able to @@ -536,7 +532,6 @@ paster celeryd <configfile.ini> - .. note:: Make sure you run this command from the same virtualenv, and with the same user that Kallithea runs. @@ -677,7 +672,6 @@ #SetEnvIf X-Url-Scheme https HTTPS=1 </VirtualHost> - Additional tutorial http://pylonsbook.com/en/1.1/deployment.html#using-apache-to-proxy-requests-to-pylons @@ -734,7 +728,6 @@ Here is a sample excerpt from an Apache Virtual Host configuration file: - .. code-block:: apache WSGIDaemonProcess kallithea \
--- a/docs/usage/general.rst Wed Aug 26 17:28:58 2015 +0200 +++ b/docs/usage/general.rst Wed Aug 26 17:28:58 2015 +0200 @@ -132,7 +132,6 @@ - svn -> hg clone - git -> git clone - .. note:: svn -> hg cloning requires the ``hgsubversion`` library to be installed.
--- a/docs/usage/performance.rst Wed Aug 26 17:28:58 2015 +0200 +++ b/docs/usage/performance.rst Wed Aug 26 17:28:58 2015 +0200 @@ -16,10 +16,8 @@ increasing cache size (see below). This includes using the lightweight dashboard option and ``vcs_full_cache`` setting in .ini file. - Follow these few steps to improve performance of Kallithea system. - 1. Increase cache Tweak beaker cache settings in the ini file. The actual effect of that