Changes from Version 1 of TracChangeset

Show
Ignore:
Author:
trac (IP: 127.0.0.1)
Timestamp:
03/05/06 12:47:52 (12 years ago)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracChangeset

    v v1  
     1= Trac Changeset Module = 
     2[[TracGuideToc]] 
     3 
     4Trac has a built-in functionality for visualizing “diffs” - changes to files. 
     5 
     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 could be shown. 
     10 
     11The changeset view consists of two parts, the ''header''  
     12and the ''diff views''. 
     13 
     14== Changeset Header == 
     15 
     16The header shows an overview of the whole changeset. 
     17Here you will find information such as: 
     18 
     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 * Files -- A list of files affected by this changeset 
     23 
     24If more than one revision is involved in the set of changes being 
     25displayed, the ''Timestamp'', ''Author'' and ''Message'' fields  
     26won't be shown. 
     27 
     28In front of each listed file, you'll find  a colored rectangle. The color 
     29indicates how the file is affected by the changeset. 
     30  
     31 * Green: Added 
     32 * Red: Removed 
     33 * Yellow: Modified 
     34 * Blue: Copied 
     35 * Gray: Moved 
     36 
     37The color legend is located below the header as a reminder. 
     38 
     39== Diff Views == 
     40 
     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): 
     42 
     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. 
     45 
     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 
     50 
     51 
     52== The Different Ways to Get a Diff == 
     53 
     54=== Examining a Changeset === 
     55 
     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. 
     60 
     61There will be also navigation links to the ''Previous Changeset'' 
     62to and ''Next Changeset''. 
     63 
     64 
     65'''Note: all of the following will only be available in Trac [milestone:0.10]''' 
     66 
     67=== Examining Differences Between Revisions === 
     68 
     69A very frequent need is to look at changes made on a file  
     70or on a directory spanning multiple revisions.  
     71The easiest way to get there is from the TracRevisionLog,  
     72where one can select the '''old''' and the '''new''' revisions 
     73of the path being examined, and then click the ''View changes'' 
     74button. 
     75 
     76=== Examining Arbitrary Differences === 
     77 
     78One of the main feature of source configuration management 
     79systems is the possibility to work simultaneously on alternate 
     80''Lines of Developments'', or ''branches''.  
     81The evolution of branches are often made in parallel, making it 
     82sometimes difficult to understand the exact set of differences  
     83between alternative versions. 
     84 
     85This is where Trac comes to the rescue:  
     86the '''View changes ...''' button in the TracBrowser 
     87leads to a form permitting the selection of arbitrary 
     88''From:'' and ''To:'' path/revision pairs. 
     89 
     90The resulting set of differences consist in the changes  
     91that should be applied to the ''From:'' content in order 
     92to make it look like the ''To:'' content. 
     93 
     94For convenience, it is possible to invert the roles 
     95of the '''old''' and the '''new''' path/revision pairs 
     96by clicking the ''Reverse Diff'' link on the changeset page. 
     97 
     98=== Checking the Last Change === 
     99 
     100The last possibility for looking at changes is  
     101to have a quick look on the ''Last Change'' while 
     102browsing a file or a directory.  
     103 
     104This shows the last change that happened on that path. 
     105The links ''Previous Changeset'' and ''Next Changeset'' 
     106are replace by links to ''Previous Change'' and ''Next Change'', 
     107which makes it really convenient to traverse the change history 
     108of a specific file or directory. 
     109This view of a changeset, restricted to a specific path, 
     110is called ''restricted changeset''. 
     111 
     112Of course, if one is doing that on the root of the 
     113repository, there will be no path restriction 
     114and the full changeset will be shown. 
     115 
     116 
     117---- 
     118See also: TracGuide, TracBrowser