comparison docs/usage/general.rst @ 3363:1a498b11f154 rhodecode-0.0.1.5.3

Docs updates
author Marcin Kuzminski <marcin@python-works.com>
date Tue, 12 Feb 2013 22:42:26 +0100
parents 5d12768a0aa1
children 3563bb7b4b82
comparison
equal deleted inserted replaced
3362:89e7b189da64 3363:1a498b11f154
9 ------------------- 9 -------------------
10 10
11 Currently when admin/owner deletes a repository, RhodeCode does not physically 11 Currently when admin/owner deletes a repository, RhodeCode does not physically
12 delete a repository from filesystem, it renames it in a special way so it's 12 delete a repository from filesystem, it renames it in a special way so it's
13 not possible to push,clone or access repository. It's worth a notice that, 13 not possible to push,clone or access repository. It's worth a notice that,
14 even if someone will be given administrative access to RhodeCode and will 14 even if someone will be given administrative access to RhodeCode and will
15 delete a repository You can easy restore such action by restoring `rm__<date>` 15 delete a repository You can easy restore such action by restoring `rm__<date>`
16 from the repository name, and internal repository storage (.hg/.git) 16 from the repository name, and internal repository storage (.hg/.git). There
17 is also a special command for cleaning such archived repos::
18
19 paster cleanup-repos --older-than=30d production.ini
20
21 This command will scan for archived repositories that are older than 30d,
22 display them and ask if you want to delete them (there's a --dont-ask flag also)
23 If you host big amount of repositories with forks that are constantly deleted
24 it's recommended that you run such command via crontab.
17 25
18 Follow current branch in file view 26 Follow current branch in file view
19 ---------------------------------- 27 ----------------------------------
20 28
21 In file view when this checkbox is checked the << and >> arrows will jump 29 In file view when this checkbox is checked the << and >> arrows will jump
29 37
30 Checkboxes in compare view allow users to view combined compare view. You can 38 Checkboxes in compare view allow users to view combined compare view. You can
31 only show the range between the first and last checkbox (no cherry pick). 39 only show the range between the first and last checkbox (no cherry pick).
32 Clicking more than one checkbox will activate a link in top saying 40 Clicking more than one checkbox will activate a link in top saying
33 `Show selected changes <from-rev> -> <to-rev>` clicking this will bring 41 `Show selected changes <from-rev> -> <to-rev>` clicking this will bring
34 compare view 42 compare view. In this view also it's possible to switch to combined compare.
35 43
36 Compare view is also available from the journal on pushes having more than 44 Compare view is also available from the journal on pushes having more than
37 one changeset 45 one changeset
38 46
39 47
42 50
43 Due to complicated nature of repository grouping, often urls of repositories 51 Due to complicated nature of repository grouping, often urls of repositories
44 can change. 52 can change.
45 53
46 example:: 54 example::
47 55
48 #before 56 #before
49 http://server.com/repo_name 57 http://server.com/repo_name
50 # after insertion to test_group group the url will be 58 # after insertion to test_group group the url will be
51 http://server.com/test_group/repo_name 59 http://server.com/test_group/repo_name
52 60
53 This can be an issue for build systems and any other hardcoded scripts, moving 61 This can be an issue for build systems and any other hardcoded scripts, moving
54 repository to a group leads to a need for changing external systems. To 62 repository to a group leads to a need for changing external systems. To
55 overcome this RhodeCode introduces a non changable replacement url. It's 63 overcome this RhodeCode introduces a non changable replacement url. It's
56 simply an repository ID prefixed with `_` above urls are also accessible as:: 64 simply an repository ID prefixed with `_` above urls are also accessible as::
57 65
58 http://server.com/_<ID> 66 http://server.com/_<ID>
59 67
60 Since ID are always the same moving the repository will not affect such url. 68 Since ID are always the same moving the repository will not affect such url.
61 the _<ID> syntax can be used anywhere in the system so urls with repo_name 69 the _<ID> syntax can be used anywhere in the system so urls with repo_name
62 for changelogs, files and other can be exchanged with _<ID> syntax. 70 for changelogs, files and other can be exchanged with _<ID> syntax.
63 71
64 72
65 Mailing 73 Mailing
66 ------- 74 -------
69 RhodeCode will send mails on user registration, or when RhodeCode errors occur 77 RhodeCode will send mails on user registration, or when RhodeCode errors occur
70 on errors the mails will have a detailed traceback of error. 78 on errors the mails will have a detailed traceback of error.
71 79
72 80
73 Mails are also sent for code comments. If someone comments on a changeset 81 Mails are also sent for code comments. If someone comments on a changeset
74 mail is sent to all participants, the person who commited the changeset 82 mail is sent to all participants, the person who commited the changeset
75 (if present in RhodeCode), and to all people mentioned with @mention system. 83 (if present in RhodeCode), and to all people mentioned with @mention system.
76 84
77 85
78 Trending source files 86 Trending source files
79 --------------------- 87 ---------------------
94 - svn -> hg clone 102 - svn -> hg clone
95 - git -> git clone 103 - git -> git clone
96 104
97 105
98 .. note:: 106 .. note::
99 107
100 - *`svn -> hg` cloning requires `hgsubversion` library to be installed.* 108 * `svn -> hg` cloning requires `hgsubversion` library to be installed.*
101 109
102 If you need to clone repositories that are protected via basic auth, you 110 If you need to clone repositories that are protected via basic auth, you
103 might pass the url with stored credentials inside eg. 111 might pass the url with stored credentials inside eg.
104 `http://user:passw@remote.server/repo, RhodeCode will try to login and clone 112 `http://user:passw@remote.server/repo`, RhodeCode will try to login and clone
105 using given credentials. Please take a note that they will be stored as 113 using given credentials. Please take a note that they will be stored as
106 plaintext inside the database. RhodeCode will remove auth info when showing the 114 plaintext inside the database. RhodeCode will remove auth info when showing the
107 clone url in summary page. 115 clone url in summary page.