Changeset - a144d15488db
[Not reviewed]
default
0 1 0
Thomas De Schampheleire - 11 years ago 2015-04-04 20:44:35
thomas.de.schampheleire@gmail.com
docs/usage: rework section 'follow current branch in file view'
1 file changed with 9 insertions and 6 deletions:
0 comments (0 inline, 0 general)
docs/usage/general.rst
Show inline comments
 
.. _general:
 

	
 
=======================
 
General Kallithea usage
 
=======================
 

	
 

	
 
Repository deleting
 
-------------------
 

	
 
Currently when an admin or owner deletes a repository, Kallithea does
 
not physically delete said repository from the filesystem, but instead
 
renames it in a special way so that it is not possible to push, clone
 
or access the repository.
 

	
 
There is a special command for cleaning up such archived repos::
 

	
 
    paster cleanup-repos --older-than=30d my.ini
 

	
 
This command scans for archived repositories that are older than
 
30 days, displays them, and asks if you want to delete them (unless given
 
the ``--dont-ask`` flag). If you host a large amount of repositories with
 
forks that are constantly being deleted, it is recommended that you run this
 
command via crontab.
 

	
 
It is worth noting that even if someone is given administrative access to
 
Kallithea and deletes a repository, you can easily restore such an action by
 
renaming the repository directory, removing the ``rm__<date>`` prefix.
 

	
 
Follow current branch in file view
 
----------------------------------
 
File view: follow current branch
 
--------------------------------
 

	
 
In file view when this checkbox is checked the << and >> arrows will jump
 
to changesets within the same branch currently being viewed. So for example
 
if someone is viewing files in the ``beta`` branch and marks the `follow current branch`
 
checkbox the << and >> buttons will only show revisions for the `'beta`` branch.
 
In the file view, left and right arrows allow to jump to the previous and next
 
revision. Depending on the way revisions were created in the repository, this
 
could jump to a different branch.  When the checkbox ``Follow current branch``
 
is checked, these arrows will only jump to revisions on the same branch as the
 
currently visible revision.  So for example, if someone is viewing files in the
 
``beta`` branch and marks the `Follow current branch` checkbox, the < and >
 
arrows will only show revisions on the ``beta`` branch.
 

	
 

	
 
Compare view from changelog
 
---------------------------
 

	
 
Checkboxes in the compare view allow users to view a combined compare
 
view. You can only show the range between the first and last checkbox
 
(no cherry pick).  Clicking more than one checkbox will activate a
 
link at the top saying ``Show selected changesets <from-rev> ->
 
<to-rev>``. Clicking this will activate the compare view. In this view
 
it is also possible to switch to combined compare.
 

	
 
Compare view is also available from the journal on pushes having more than
 
one changeset.
 

	
 

	
 
Non changeable repository urls
 
------------------------------
 

	
 
Due to the complicated nature of repository grouping, URLs of repositories
 
can often change.
 

	
 
example::
 

	
 
  #before
 
  http://server.com/repo_name
 
  # after insertion to test_group group the url will be
 
  http://server.com/test_group/repo_name
 

	
 
This can be an issue for build systems and any other hardcoded scripts, moving
 
a repository to a group leads to a need for changing external systems. To
 
overcome this Kallithea introduces a non-changable replacement URL. It's
 
simply a repository ID prefixed with ``_``. The above URLs are also accessible as::
 

	
 
  http://server.com/_<ID>
 

	
 
Since IDs are always the same, moving the repository will not affect
 
such a URL.  the ``_<ID>`` syntax can be used anywhere in the system so
 
URLs with ``repo_name`` for changelogs and files can be exchanged
 
with the ``_<ID>`` syntax.
 

	
 

	
 
E-mail notifications
 
--------------------
 

	
 
When the administrator correctly specified the e-mail settings in the Kallithea
 
configuration file, Kallithea will send e-mails on user registration and when
 
errors occur.
0 comments (0 inline, 0 general)