Mercurial > kallithea

annotate docs/usage/general.rst @ 3335:2d4e1f5e854e beta

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs updates
author Marcin Kuzminski <marcin@python-works.com>
date Fri, 08 Feb 2013 19:24:07 +0100
parents 8b8edfc25856
children 549c73bfc206
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
1 .. _general:
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
2
2095
Marcin Kuzminski <marcin@python-works.com>
parents: 1813
diff changeset
3 =======================
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
4 General RhodeCode usage
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
5 =======================
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
6
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
7
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
8 Repository deleting
1123
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1026
diff changeset
9 -------------------
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
10
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
11 Currently when admin/owner deletes a repository, RhodeCode does not physically
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
12 delete a repository from filesystem, it renames it in a special way so it's
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
13 not possible to push,clone or access repository. It's worth a notice that,
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
14 even if someone will be given administrative access to RhodeCode and will
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
15 delete a repository You can easy restore such action by restoring `rm__<date>`
3335
2d4e1f5e854e docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
16 from the repository name, and internal repository storage (.hg/.git). There
2d4e1f5e854e docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
17 is also a special command for cleaning such archived repos::
2d4e1f5e854e docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
18
2d4e1f5e854e docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
19 paster cleanup-repos --older-than=30d production.ini
2d4e1f5e854e docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
20
2d4e1f5e854e docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
21 This command will scan for archived repositories that are older than 30d,
2d4e1f5e854e docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
22 display them and ask if you want to delete them (there's a --dont-ask flag also)
2d4e1f5e854e docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
23 If you host big amount of repositories with forks that are constantly deleted
2d4e1f5e854e docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
24 it's recommended that you run such command via crontab.
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
25
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
26 Follow current branch in file view
1123
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1026
diff changeset
27 ----------------------------------
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
28
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
29 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
30 to changesets within the same branch currently viewing. So for example
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
31 if someone is viewing files at 'beta' branch and marks `follow current branch`
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
32 checkbox the << and >> buttons will only show him revisions for 'beta' branch
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
33
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
34
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
35 Compare view from changelog
1123
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1026
diff changeset
36 ---------------------------
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
37
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
38 Checkboxes in compare view allow users to view combined compare view. You can
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
39 only show the range between the first and last checkbox (no cherry pick).
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
40 Clicking more than one checkbox will activate a link in top saying
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
41 `Show selected changes <from-rev> -> <to-rev>` clicking this will bring
3335
2d4e1f5e854e docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
42 compare view. In this view also it's possible to switch to combined compare.
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
43
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
44 Compare view is also available from the journal on pushes having more than
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
45 one changeset
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
46
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
47
1813
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
48 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
49 ------------------------------
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
50
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
51 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
52 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
53
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
54 example::
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
55
1813
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
56 #before
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
57 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
58 # 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
59 http://server.com/test_group/repo_name
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
60
1813
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
61 This can be an issue for build systems and any other hardcoded scripts, moving
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
62 repository to a group leads to a need for changing external systems. To
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
63 overcome this RhodeCode introduces a non changable replacement url. It's
1813
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
64 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
65
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
66 http://server.com/_<ID>
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
67
1813
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
68 Since ID are always the same moving the repository will not affect such url.
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
69 the _<ID> syntax can be used anywhere in the system so urls with repo_name
1813
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
70 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
71
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
72
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
73 Mailing
1123
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1026
diff changeset
74 -------
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
75
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
76 When administrator will fill up the mailing settings in .ini files
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
77 RhodeCode will send mails on user registration, or when RhodeCode errors occur
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
78 on errors the mails will have a detailed traceback of error.
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
79
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
80
2105
926f55b038bc added initial rc-extension module
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
81 Mails are also sent for code comments. If someone comments on a changeset
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
82 mail is sent to all participants, the person who commited the changeset
2105
926f55b038bc added initial rc-extension module
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
83 (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
84
926f55b038bc added initial rc-extension module
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
85
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
86 Trending source files
1123
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1026
diff changeset
87 ---------------------
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
88
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
89 Trending source files are calculated based on pre defined dict of known
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
90 types and extensions. If You miss some extension or Would like to scan some
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
91 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
92 located in `/rhodecode/lib/celerylib/tasks.py`
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
93
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
94
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
95 Cloning remote repositories
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 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
99 Currently it support following options:
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
100
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
101 - hg -> hg clone
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
102 - svn -> hg clone
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
103 - git -> git clone
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
104
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
105
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
106 .. note::
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
107
2706
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
108 - *`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
109
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
110 If you need to clone repositories that are protected via basic auth, you
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
111 might pass the url with stored credentials inside eg.
2706
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
112 `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
113 using given credentials. Please take a note that they will be stored as
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
114 plaintext inside the database. RhodeCode will remove auth info when showing the
2706
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
115 clone url in summary page.