annotate examples/trac/wiki-default/TracChangeset @ 39:93b4dcbafd7b trunk

Copy Trac to main branch.
author cmlenz
date Mon, 03 Jul 2006 18:53:27 +0000
parents
children
rev   line source
39
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
1 = Trac Changeset Module =
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
2 [[TracGuideToc]]
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
3
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
4 Trac has a built-in functionality for visualizing “diffs” - changes to files.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
5
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
6 There are different kinds of ''change sets''.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
7 Some can correspond to revisions made in the repositories,
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
8 others can aggregate changes made in several revisions,
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
9 but in the end, any kind of differences could be shown.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
10
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
11 The changeset view consists of two parts, the ''header''
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
12 and the ''diff views''.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
13
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
14 == Changeset Header ==
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
15
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
16 The header shows an overview of the whole changeset.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
17 Here you will find information such as:
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
18
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
19 * Timestamp -- When the changeset was commited
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
20 * Author -- Who commited the changeset
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
21 * Message -- A brief description from the author (the commit log message)
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
22 * Files -- A list of files affected by this changeset
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
23
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
24 If more than one revision is involved in the set of changes being
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
25 displayed, the ''Timestamp'', ''Author'' and ''Message'' fields
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
26 won't be shown.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
27
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
28 In front of each listed file, you'll find a colored rectangle. The color
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
29 indicates how the file is affected by the changeset.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
30
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
31 * Green: Added
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
32 * Red: Removed
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
33 * Yellow: Modified
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
34 * Blue: Copied
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
35 * Gray: Moved
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
36
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
37 The color legend is located below the header as a reminder.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
38
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
39 == Diff Views ==
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
40
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
41 Below the header is the main part of the changeset, the diff view. Each file is shown in a separate section, each of which will contain only the regions of the file that are affected by the changeset. There are two different styles of displaying the diffs: ''inline'' or ''side-by-side'' (you can switch between those styles using the preferences form):
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
42
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
43 * The ''inline'' style shows the changed regions of a file underneath each other. A region removed from the file will be colored red, an added region will be colored green. If a region was modified, the old version is displayed above the new version. Line numbers on the left side indicate the exact position of the change in both the old and the new version of the file.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
44 * The ''side-by-side'' style shows the old version on the left and the new version on the right (this will typically require more screen width than the inline style.) Added and removed regions will be colored in the same way as with the inline style (green and red, respectively), but modified regions will have a yellow background.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
45
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
46 In addition, various advanced options are available in the preferences form for adjusting the display of the diffs:
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
47 * You can set how many lines are displayed before and after every change
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
48 (if the value ''all'' is used, then the full file will be shown)
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
49 * You can toggle whether blank lines, case changes and white space changes are ignored, thereby letting you find the functional changes more quickly
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
50
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
51
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
52 == The Different Ways to Get a Diff ==
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
53
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
54 === Examining a Changeset ===
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
55
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
56 When viewing a repository check-in, such as when following a
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
57 changeset [wiki:TracLinks link] or a changeset event in the
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
58 [wiki:TracTimeline timeline], Trac will display the exact changes
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
59 made by the check-in.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
60
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
61 There will be also navigation links to the ''Previous Changeset''
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
62 to and ''Next Changeset''.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
63
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
64
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
65 '''Note: all of the following will only be available in Trac [milestone:0.10]'''
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
66
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
67 === Examining Differences Between Revisions ===
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
68
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
69 A very frequent need is to look at changes made on a file
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
70 or on a directory spanning multiple revisions.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
71 The easiest way to get there is from the TracRevisionLog,
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
72 where one can select the '''old''' and the '''new''' revisions
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
73 of the path being examined, and then click the ''View changes''
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
74 button.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
75
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
76 === Examining Arbitrary Differences ===
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
77
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
78 One of the main feature of source configuration management
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
79 systems is the possibility to work simultaneously on alternate
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
80 ''Lines of Developments'', or ''branches''.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
81 The evolution of branches are often made in parallel, making it
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
82 sometimes difficult to understand the exact set of differences
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
83 between alternative versions.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
84
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
85 This is where Trac comes to the rescue:
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
86 the '''View changes ...''' button in the TracBrowser
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
87 leads to a form permitting the selection of arbitrary
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
88 ''From:'' and ''To:'' path/revision pairs.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
89
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
90 The resulting set of differences consist in the changes
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
91 that should be applied to the ''From:'' content in order
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
92 to make it look like the ''To:'' content.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
93
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
94 For convenience, it is possible to invert the roles
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
95 of the '''old''' and the '''new''' path/revision pairs
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
96 by clicking the ''Reverse Diff'' link on the changeset page.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
97
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
98 === Checking the Last Change ===
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
99
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
100 The last possibility for looking at changes is
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
101 to have a quick look on the ''Last Change'' while
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
102 browsing a file or a directory.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
103
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
104 This shows the last change that happened on that path.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
105 The links ''Previous Changeset'' and ''Next Changeset''
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
106 are replace by links to ''Previous Change'' and ''Next Change'',
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
107 which makes it really convenient to traverse the change history
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
108 of a specific file or directory.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
109 This view of a changeset, restricted to a specific path,
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
110 is called ''restricted changeset''.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
111
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
112 Of course, if one is doing that on the root of the
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
113 repository, there will be no path restriction
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
114 and the full changeset will be shown.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
115
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
116
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
117 ----
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
118 See also: TracGuide, TracBrowser
Copyright (C) 2012-2017 Edgewall Software