Changeset 959


Ignore:
Timestamp:
Dec 7, 2009, 5:54:37 AM (12 years ago)
Author:
Peter Johansson
Message:

documenting svndigest-copy-cache. closes #380

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/readme.txt

    r847 r959  
    9797
    9898To avoid retrieving the same data repeatedly from the repository,
    99 statistics is cahed in files located in `.svndigest`. Subsequent
     99statistics is cached in files located in `.svndigest`. Subsequent
    100100svndigest runs read the cache files and retrieve information from the
    101101repository only for the revisions that have been committed since the
     
    198198  * Create the plots and HTML presentation.
    199199
     200= Copy Cache =
     201
     202As explained above, statistics are cached during a run and svndigest
     203only communicates with the server to retrieve statistics of the
     204activity since last run. Subsequent runs are much faster why it is
     205prefereble to run svndigest in a wc with recent cache available.
     206
     207Sometimes it is useful to copy the cache from one wc to another, and
     208an easy way to do this is to use the tool `svndigest-copy-cache`,
     209which is shipped with svndigest. A common use case is when creating,
     210say, a release branch from the trunk, in which case you likely will
     211have two working copies to follow the two branches. If you want to run
     212svndigest on both of them and you want to avoid the first expensive
     213run (without cache) you can copy the cache from the trunk wc to the
     214release-branch wc.
     215
     216As explained in the caching section, it is important that the cache
     217reflects a revision that belong to the history of the wc. So, for
     218example, when creating a branch it is crucial to copy the cache from
     219the trunk wc to the new branch wc before running svndigest on trunk
     220wc. Otherwise the cache will contain information about changesets that
     221were committed after the new branch were forked out. This will not
     222only be untrue as these changesets are not in the line of history of
     223the branch, but it will also cause problems for svndigest when
     224calculating the statistics of the most recent revisons and result is
     225undefined due to inconsistency between the cache and the log. For an
     226example of how `svndigest-copy-cache` may be used please refer to the
     227ReleaseProcedure of svndigest.
     228
     229`svndigest-copy-cache` copies the cache file from `ROOT` tree to the
     230corresponding directory in `TARGET` tree. The tree structure of the
     231two working copies must be identical because `svndigest-copy-cache`
     232will not create any directories in `TARGET` tree except that
     233`.svndigest` directories are created when necessary.
     234
     235Also, `svndigest-copy-cache` is ignorant about svn wc and will parse
     236through `ROOT` directory and all its sub-directories ,looking for
     237svndigest cache files, regardless whether they belong to the same svn
     238working copy or not. Therefore, having other svn wc in subdirectories
     239of `ROOT` might give an unexpected result.
Note: See TracChangeset for help on using the changeset viewer.