Files @ 9cef5615da7b
Branch filter:

Location: kallithea/docs/index.rst

9cef5615da7b 1.2 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw
Thomas De Schampheleire
issues: simplify example in ini file

The example setting from the default ini file is:
issue_pat = (?:\s*#)(\d+)
issue_server_link = https://issues.example.com/{repo}/issue/{id}
issue_prefix = #

in which the clause '(?:\s*#)' is overly complex:
1. '\s*' means optional whitespace, which means there can be whitespace or
no whitespace, which means that you could equally write:
(?:#)(\d+)
(If any leading whitespace was eaten by the regexp, 32e1e0745d3c would take
care to restore a part of it.)
2. '(?:xxx)' means a non-capturing set of parentheses. In this case this is
equal to just mentioning 'xxx'. So the simplified pattern becomes:
#(\d+)

If instead of _optional_ whitespace, _mandatory_ whitespace was intended,
then the pattern should be different. But this would also mean that
patterns like PR#123 would not be matched anymore.
.. _index:

#######################
Kallithea Documentation
#######################

**Readme**

.. toctree::
   :maxdepth: 1

   readme

**Installation**

.. toctree::
   :maxdepth: 1

   overview
   installation
   installation_win
   installation_win_old
   installation_iis
   setup
   installation_puppet
   upgrade

**Usage**

.. toctree::
   :maxdepth: 1

   usage/general
   usage/vcs_support
   usage/locking
   usage/statistics

**Administrator's guide**

.. toctree::
   :maxdepth: 1

   usage/email
   usage/performance
   usage/backup
   usage/debugging
   usage/troubleshooting
   usage/customization

**Development**

.. toctree::
   :maxdepth: 1

   contributing
   dev/translation
   dev/dbmigrations

**API**

.. toctree::
   :maxdepth: 1

   api/api


Other topics
************

* :ref:`genindex`
* :ref:`search`


.. _virtualenv: http://pypi.python.org/pypi/virtualenv
.. _python: http://www.python.org/
.. _django: http://www.djangoproject.com/
.. _mercurial: https://www.mercurial-scm.org/
.. _bitbucket: http://bitbucket.org/
.. _subversion: http://subversion.tigris.org/
.. _git: http://git-scm.com/
.. _celery: http://celeryproject.org/
.. _Sphinx: http://sphinx.pocoo.org/
.. _vcs: http://pypi.python.org/pypi/vcs