Edgewall Software

Changes between Initial Version and Version 1 of TracDiff


Ignore:
Timestamp:
Jun 7, 2005, 10:02:18 AM (17 years ago)
Author:
Christian Boos
Comment:

Documentation for the Diff module

Legend:

Unmodified
Added
Removed
Modified
  • TracDiff

    v1 v1  
     1= Trac Diff Module =
     2
     3''Note 1: this is an new feature, quickly maturing in the source:branches/cboos-dev/anydiff-branch development branch.''
     4
     5''Note 2: this is a prototype for the feature documentation. It will eventually be merged with the TracChangeset documentation page''.
     6
     7== The Different Ways of to Prepare a Diff ==
     8
     9=== Examining Differences Between Revisions ===
     10
     11A very frequent need is to look at changes made on a file
     12or on a directory spanning multiple revisions.
     13In the TracLog view, one can select the '''old''' and the '''new'''
     14revision of the path being examined, and then select the '''Diff'''
     15operation.
     16
     17=== Examining Arbitrary Differences ===
     18
     19One of the main feature of source configuration management
     20systems is the possibility to work simultaneously on alternate
     21''Lines of Developments'', or ''branches''.
     22The evolution of branches are often made in parallel, making it
     23sometimes difficult to understand the exact set of differences
     24between alternative versions.
     25
     26This is where Trac comes to the rescue: the TracBrowser
     27allows any path in the repository, at any given revision
     28to be selected as the ''Base for Diff'',
     29i.e. the '''old''' file (or directory) which
     30can be compared to any other existing '''new'''
     31path/revision pair.
     32
     33The resulting set of differences consist in the changes
     34that would be necessary to make on the ''Base'' in order
     35to make it look like the target of the comparison.
     36
     37For convenience, it is possible to invert the roles
     38for the '''old''' and the '''new''' path/revision pairs.
     39
     40=== Checking the Last Changes ===
     41
     42The last possibility for looking at changes is
     43to have a quick look on the ''Previous Diff'' while
     44browsing a file or a directory.
     45
     46This shows the relevant TracChangeset information, but
     47restricted to the path being browsed, and with a link
     48to the next ''Previous Diff'', making it convenient to
     49look at the history of the changes for a given path.
     50
     51''TO BE DONE''
     52
     53== Looking at the Differences ==
     54
     55See TracChangeset for now, as the display is very similar.
     56
     57Except:
     58 * the Changeset information is shown only for the last mode
     59   (''Checking the Last Changes'')
     60 * the path and revision information for the individual files
     61   being examined are those corresponding to their creation
     62   (''created path/created rev''). This helps to discover which
     63   side is the ''real'' old file while examining parallel
     64   lines of development.
     65
     66In relation to the latest point, I'm thinking about providing
     67a checkbox for each file entry in order to generate a ''diff''
     68containing only the selected changes (''cherry-picking support'').
     69
     70
     71== Feedback ==
     72
     73''Please feel free to add your observations''
     74