kallithea Changeset - 543bf62d06c7

Changeset - 543bf62d06c7

Parent rev.

Child rev.

[Not reviewed]

default

0 1 0

Thomas De Schampheleire - 11 years ago 2015-04-04 21:13:47
thomas.de.schampheleire@gmail.com

docs/usage: reword and extend section on changelog

1 file changed with 27 insertions and 10 deletions:

docs/usage/general.rst

0 comments (0 inline, 0 general)

docs/usage/general.rst

➞

Show inline comments

@@ @@ -18,61 +18,78 @@ There is a special command for cleaning @@
     paster cleanup-repos --older-than=30d my.ini
 This command scans for archived repositories that are older than
 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.
 File view: follow current 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
 ---------------------------
 Changelog features
 ------------------
 The core feature of a repository's ``changelog`` page is to show the revisions
 in a repository. However, there are several other features available from the
 changelog.
 Branch filter
   By default, the changelog shows revisions from all branches in the
   repository. Use the branch filter to restrict to a given branch.
 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.
 Viewing a changeset
   A particular changeset can be opened by clicking on either the changeset
   hash or the commit message, or by ticking the checkbox and clicking the
   ``Show selected changeset`` button at the top.
 Compare view is also available from the journal on pushes having more than
 one changeset.
 Viewing all changes between two changesets
   To get a list of all changesets between two selected changesets, along with
   the changes in each one of them, tick the checkboxes of the first and
   last changeset in the desired range and click the ``Show selected changesets``
   button at the top. You can only show the range between the first and last
   checkbox (no cherry-picking).
   From that page, you can proceed to viewing the overall delta between the
   selected changesets, by clicking the ``Compare revisions`` button.
 Creating a pull request
   You can create a new pull request for the changes of a particular changeset
   (and its ancestors) by selecting it and clicking the ``Open new pull request
   for selected changesets`` button.
 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

0 comments (0 inline, 0 general)