Mercurial > kallithea
changeset 1025:bbd499c7b55e beta
docs update
author | Marcin Kuzminski <marcin@python-works.com> |
---|---|
date | Fri, 11 Feb 2011 01:21:16 +0100 |
parents | 22c147726ea6 |
children | 3c80eb712a78 |
files | docs/enable_git.rst docs/index.rst docs/statistics.rst docs/usage/enable_git.rst docs/usage/general.rst docs/usage/statistics.rst |
diffstat | 6 files changed, 110 insertions(+), 55 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/enable_git.rst Fri Feb 11 00:44:22 2011 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,21 +0,0 @@ -.. _enable_git: - -Enabling GIT support (beta) -=========================== - - -Git support in RhodeCode 1.1 was disabled due to some instability issues, but -If You would like to test it fell free to re-enable it. To enable GIT just -uncomment git line in rhodecode/__init__.py file - -.. code-block:: python - - BACKENDS = { - 'hg': 'Mercurial repository', - #'git': 'Git repository', - } - -.. note:: - Please note that it's not fully stable and it might crash (that's why it - was disabled), so be careful about enabling git support. Don't use it in - production ! \ No newline at end of file
--- a/docs/index.rst Fri Feb 11 00:44:22 2011 +0100 +++ b/docs/index.rst Fri Feb 11 01:21:16 2011 +0100 @@ -19,8 +19,9 @@ .. toctree:: :maxdepth: 1 - enable_git - statistics + usage/general + usage/enable_git + usage/statistics **Develop**
--- a/docs/statistics.rst Fri Feb 11 00:44:22 2011 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,32 +0,0 @@ -.. _statistics: - - -Statistics -========== - -RhodeCode statistics system is heavy on resources, so in order to keep a -balance between the usability and performance statistics are cached inside db -and are gathered incrementally, this is how RhodeCode does this: - -With Celery disabled -++++++++++++++++++++ - -- on each first visit on summary page a set of 250 commits are parsed and - updates statistics cache -- this happens on each single visit of statistics page until all commits are - fetched. Statistics are kept cached until some more commits are added to - repository, in such case RhodeCode will fetch only the ones added and will - update it's cache. - - -With Celery enabled -+++++++++++++++++++ - -- on first visit on summary page RhodeCode will create task that will execute - on celery workers, that will gather all stats until all commits are parsed, - each task will parse 250 commits, and run next task to parse next 250 - commits, until all are parsed. - -.. note:: - In any time You can disable statistics on each repository in repository edit - form in admin panel, just uncheck the statistics checkbox. \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/usage/enable_git.rst Fri Feb 11 01:21:16 2011 +0100 @@ -0,0 +1,21 @@ +.. _enable_git: + +Enabling GIT support (beta) +=========================== + + +Git support in RhodeCode 1.1 was disabled due to some instability issues, but +If You would like to test it fell free to re-enable it. To enable GIT just +uncomment git line in rhodecode/__init__.py file + +.. code-block:: python + + BACKENDS = { + 'hg': 'Mercurial repository', + #'git': 'Git repository', + } + +.. note:: + Please note that it's not fully stable and it might crash (that's why it + was disabled), so be careful about enabling git support. Don't use it in + production ! \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/usage/general.rst Fri Feb 11 01:21:16 2011 +0100 @@ -0,0 +1,54 @@ +.. _general: + +General RhodeCode usage +======================= + + +Repository deleting ++++++++++++++++++++ + +Currently when admin/owner deletes a repository, RhodeCode does not physically +delete a repository from filesystem, it renames it in a special way so it's +not possible to push,clone or access repository. It's worth a notice that, +even if someone will be given administrative access to RhodeCode and will +delete a repository You can easy restore such action by restoring `rm__<date>` +from the repository name, and internal repository storage (.hg/.git) + +Follow current branch in file view +++++++++++++++++++++++++++++++++++ + +In file view when this checkbox is checked the << and >> arrows will jump +to changesets withing the same branch currently viewing. So for example +if someone is viewing files at 'beta' branch and marks `follow current branch` +checkbox the << and >> buttons will only show him revisions for 'beta' branch + + +Compare view from changelog ++++++++++++++++++++++++++++ + +Checkboxes in compare view allow users to view 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 in top saying +`Show selected changes <from-rev> -> <to-rev>` clicking this will bring +compare view + +Compare view is also available from the journal on pushes having more than +one changeset + + + +Mailing ++++++++ + +When administrator will fill up the mailing settings in .ini files +RhodeCode will send mails on user registration, or when RhodeCode errors occur +on errors the mails will have a detailed traceback of error. + + +Trending source files ++++++++++++++++++++++ + +Trending source files are calculated based on pre defined dict of known +types and extensions. If You miss some extension or Would like to scan some +custom files it's possible to add new types in `LANGUAGES_EXTENSIONS_MAP` dict +located in `/rhodecode/lib/celerylib/tasks.py` \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/usage/statistics.rst Fri Feb 11 01:21:16 2011 +0100 @@ -0,0 +1,32 @@ +.. _statistics: + + +Statistics +========== + +RhodeCode statistics system is heavy on resources, so in order to keep a +balance between the usability and performance statistics are cached inside db +and are gathered incrementally, this is how RhodeCode does this: + +With Celery disabled +++++++++++++++++++++ + +- on each first visit on summary page a set of 250 commits are parsed and + updates statistics cache +- this happens on each single visit of statistics page until all commits are + fetched. Statistics are kept cached until some more commits are added to + repository, in such case RhodeCode will fetch only the ones added and will + update it's cache. + + +With Celery enabled ++++++++++++++++++++ + +- on first visit on summary page RhodeCode will create task that will execute + on celery workers, that will gather all stats until all commits are parsed, + each task will parse 250 commits, and run next task to parse next 250 + commits, until all are parsed. + +.. note:: + In any time You can disable statistics on each repository in repository edit + form in admin panel, just uncheck the statistics checkbox. \ No newline at end of file