Mercurial > kallithea
annotate docs/usage/general.rst @ 2946:dbb311201ce3 beta
add test for enabling lightweight dashboard
author | Marcin Kuzminski <marcin@python-works.com> |
---|---|
date | Sat, 20 Oct 2012 16:50:00 +0200 |
parents | 5d12768a0aa1 |
children | 8b8edfc25856 1a498b11f154 |
rev | line source |
---|---|
1025 | 1 .. _general: |
2 | |
2095 | 3 ======================= |
1025 | 4 General RhodeCode usage |
5 ======================= | |
6 | |
7 | |
8 Repository deleting | |
1123 | 9 ------------------- |
1025 | 10 |
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 | |
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 | |
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) | |
17 | |
18 Follow current branch in file view | |
1123 | 19 ---------------------------------- |
1025 | 20 |
21 In file view when this checkbox is checked the << and >> arrows will jump | |
1026
3c80eb712a78
uncommented migrate tables, docfix
Marcin Kuzminski <marcin@python-works.com>
parents:
1025
diff
changeset
|
22 to changesets within the same branch currently viewing. So for example |
1025 | 23 if someone is viewing files at 'beta' branch and marks `follow current branch` |
24 checkbox the << and >> buttons will only show him revisions for 'beta' branch | |
25 | |
26 | |
27 Compare view from changelog | |
1123 | 28 --------------------------- |
1025 | 29 |
30 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). | |
32 Clicking more than one checkbox will activate a link in top saying | |
33 `Show selected changes <from-rev> -> <to-rev>` clicking this will bring | |
34 compare view | |
35 | |
36 Compare view is also available from the journal on pushes having more than | |
37 one changeset | |
38 | |
39 | |
1813
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
40 Non changeable repository urls |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
41 ------------------------------ |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
42 |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
43 Due to complicated nature of repository grouping, often urls of repositories |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
44 can change. |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
45 |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
46 example:: |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
47 |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
48 #before |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
49 http://server.com/repo_name |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
50 # after insertion to test_group group the url will be |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
51 http://server.com/test_group/repo_name |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
52 |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
53 This can be an issue for build systems and any other hardcoded scripts, moving |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
54 repository to a group leads to a need for changing external systems. To |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
55 overcome this RhodeCode introduces a non changable replacement url. It's |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
56 simply an repository ID prefixed with `_` above urls are also accessible as:: |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
57 |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
58 http://server.com/_<ID> |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
59 |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
60 Since ID are always the same moving the repository will not affect such url. |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
61 the _<ID> syntax can be used anywhere in the system so urls with repo_name |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
62 for changelogs, files and other can be exchanged with _<ID> syntax. |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
63 |
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
64 |
1025 | 65 Mailing |
1123 | 66 ------- |
1025 | 67 |
68 When administrator will fill up the mailing settings in .ini files | |
69 RhodeCode will send mails on user registration, or when RhodeCode errors occur | |
70 on errors the mails will have a detailed traceback of error. | |
71 | |
72 | |
2105
926f55b038bc
added initial rc-extension module
Marcin Kuzminski <marcin@python-works.com>
parents:
2095
diff
changeset
|
73 Mails are also sent for code comments. If someone comments on a changeset |
926f55b038bc
added initial rc-extension module
Marcin Kuzminski <marcin@python-works.com>
parents:
2095
diff
changeset
|
74 mail is sent to all participants, the person who commited the changeset |
926f55b038bc
added initial rc-extension module
Marcin Kuzminski <marcin@python-works.com>
parents:
2095
diff
changeset
|
75 (if present in RhodeCode), and to all people mentioned with @mention system. |
926f55b038bc
added initial rc-extension module
Marcin Kuzminski <marcin@python-works.com>
parents:
2095
diff
changeset
|
76 |
926f55b038bc
added initial rc-extension module
Marcin Kuzminski <marcin@python-works.com>
parents:
2095
diff
changeset
|
77 |
1025 | 78 Trending source files |
1123 | 79 --------------------- |
1025 | 80 |
81 Trending source files are calculated based on pre defined dict of known | |
82 types and extensions. If You miss some extension or Would like to scan some | |
83 custom files it's possible to add new types in `LANGUAGES_EXTENSIONS_MAP` dict | |
2706
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
84 located in `/rhodecode/lib/celerylib/tasks.py` |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
85 |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
86 |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
87 Cloning remote repositories |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
88 --------------------------- |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
89 |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
90 RhodeCode has an ability to clone remote repos from given remote locations. |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
91 Currently it support following options: |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
92 |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
93 - hg -> hg clone |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
94 - svn -> hg clone |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
95 - git -> git clone |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
96 |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
97 |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
98 .. note:: |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
99 |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
100 - *`svn -> hg` cloning requires `hgsubversion` library to be installed.* |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
101 |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
102 If you need to clone repositories that are protected via basic auth, you |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
103 might pass the url with stored credentials inside eg. |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
104 `http://user:passw@remote.server/repo, RhodeCode will try to login and clone |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
105 using given credentials. Please take a note that they will be stored as |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
106 plaintext inside the database. RhodeCode will remove auth info when showing the |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
107 clone url in summary page. |