source: wiki/pages/TracChangeset @ 26484

Last change on this file since 26484 was 26484, checked in by obi, 10 years ago

add wiki pages

File size: 4.9 KB
1= Trac Changeset Module =
4Trac has a built-in functionality for visualizing “diffs” - changes to files.
6There are different kinds of ''change sets''.
7Some can correspond to revisions made in the repositories,
8others can aggregate changes made in several revisions,
9but in the end, any kind of differences can be shown.
11The changeset view consists of two parts, the ''header''
12and the ''diff views''.
14== Changeset Header ==
16The header shows an overview of the whole changeset.
17Here you will find information such as:
19 * Timestamp — When the changeset was commited
20 * Author — Who commited the changeset
21 * Message — A brief description from the author (the commit log message)
22 * Location — Parent directory of all files affected by this changeset
23 * Files — A list of files affected by this changeset
25If more than one revision is involved in the set of changes being
26displayed, the ''Timestamp'', ''Author'' and ''Message'' fields
27won't be shown.
29In front of each listed file, you'll find  a colored rectangle. The color
30indicates how the file is affected by the changeset.
32 [[span(style=background:#bfb;border:1px solid #999;font-size:80%;margin-right:.5em,''  '')]] Green: Added \\
33 [[span(style=background:#f88;border:1px solid #999;font-size:80%;margin-right:.5em,''  '')]] Red: Removed \\
34 [[span(style=background:#fd8;border:1px solid #999;font-size:80%;margin-right:.5em,''  '')]] Yellow: Modified \\
35 [[span(style=background:#88f;border:1px solid #999;font-size:80%;margin-right:.5em,''  '')]] Blue: Copied \\
36 [[span(style=background:#ccc;border:1px solid #999;font-size:80%;margin-right:.5em,''  '')]] Gray: Moved \\
37The color legend is located below the header as a reminder.
39== Diff Views ==
41Below 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):
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.
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.
46In addition, various advanced options are available in the preferences form for adjusting the display of the diffs:
47 * You can set how many lines are displayed before and after every change
48   (if the value ''all'' is used, then the full file will be shown)
49 * You can toggle whether blank lines, case changes and white space changes are ignored, thereby letting you find the functional changes more quickly
52== The Different Ways to Get a Diff ==
54=== Examining a Changeset ===
56When viewing a repository check-in, such as when following a
57changeset [wiki:TracLinks link] or a changeset event in the
58[wiki:TracTimeline timeline], Trac will display the exact changes
59made by the check-in.
61There will be also navigation links to the ''Previous Changeset''
62to and ''Next Changeset''.
64=== Examining Differences Between Revisions ===
66Often you'll want to look at changes made on a file
67or on a directory spanning multiple revisions. The easiest way
68to get there is from the TracRevisionLog, where you can select
69the ''old'' and the ''new'' revisions of the file or directory, and
70then click the ''View changes'' button.
72=== Examining Differences Between Branches ===
74One of the core features of version control systems is the possibility
75to work simultaneously on different ''Lines of Developments'', commonly
76called “branches”. Trac enables you to examine the exact differences
77between such branches.
79Using the '''View changes ...''' button in the TracBrowser allows you to enter
80''From:'' and ''To:'' path/revision pairs. The resulting set of differences consist
81of the changes that should be applied to the ''From:'' content in order
82to get to the ''To:'' content.
84For convenience, it is possible to invert the roles of the ''old'' and the ''new''
85path/revision pairs by clicking the ''Reverse Diff'' link on the changeset page.
87=== Checking the Last Change ===
89The last possibility for examining changes is to use the ''Last Change''
90link provided by the TracBrowser.
92This link will take you to the last change that was made on that path.
93From there, you can use the ''Previous Change'' and ''Next Change'' links
94to traverse the change history of the file or directory.
97See also: TracGuide, TracBrowser
Note: See TracBrowser for help on using the repository browser.