Changeset 1252 for trunk


Ignore:
Timestamp:
Oct 31, 2010, 5:25:06 PM (10 years ago)
Author:
Peter Johansson
Message:

revise text on copyright update refs #482

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/readme.txt

    r1251 r1252  
    2121}}}
    2222
     23= Content =
     24
     25This manual describes how to use the three programs included in the
     26svndigest package:
     27
     28  * svndigest
     29  * svndigest-copy-cache
     30  * svncopyright
    2331
    2432= About svndigest =
     
    3038directory).
    3139
    32 == Statistics ==
     40=== Statistics ===
    3341
    3442To understand what statistics is calculated by svndigest this
     
    4654see also: http://dev.thep.lu.se/svndigest/wiki/StatsType
    4755
    48 == Different linetypes ==
     56=== Different linetypes ===
    4957
    5058Svndigest parses each file to decide whether a line is ''code'',
     
    9098
    9199
    92 == Caching Statistics ==
     100=== Caching Statistics ===
    93101
    94102To avoid retrieving the same data repeatedly from the repository,
     
    106114
    107115
    108 == Different file types ==
     116=== Different file types ===
    109117
    110118There are many different types of files and for many file types it
     
    127135http://svnbook.red-bean.com/.
    128136
    129 == Configuration ==
     137=== Configuration ===
    130138
    131139The configuration file may be used to define various behaviors for
     
    158166implies that images are not created.
    159167
    160 == Copyright update ==
    161 
    162 Using the option `--copyright` svndigest will try to update the
    163 copyright statement in each of the parsed files. The copyright
    164 statement is detected as the first line containing `Copyright
    165 (C)`. The copyright statement block is defined to start at this line
    166 and ends with the first following line containing no alphanumerical
    167 characters (excluding `prefix` string preceeding `Copyright (C)`). This
    168 copyright statement block is replaced with a new copyright statement
    169 generated from analyzing `svn log`. An author is considered to have
    170 copyright of the file if (s)he has modified the file and thereby
    171 occurs in the log. For an example of the format of the generated
    172 copyright statement, please have a look at the bottom of this file. By
    173 default the `svn user name` of the author is printed in the copyright
    174 statement. This may be overridden by setting a `copyright-alias` in
    175 the config file. In svndigest, e.g., user name `jari` is set to
    176 copyright-alias ''Jari Häkkinen'' and user name `peter` is set to
    177 copyright-alias ''Peter Johansson''. If two (or several) authors are
    178 given the same copyright-alias they are considered as one person in
    179 the copyright statement (i.e. their alias is not repeated). This may
    180 be useful if you want to give copyright to an organization rather than
    181 to individual developers.
    182 
    183 == TracLinks ==
     168=== TracLinks ===
    184169
    185170From svndigest 0.6 there is support for TracLinks. The root trac
     
    190175in `Recent Log`.
    191176
    192 == Prerequisites ==
     177=== Prerequisites ===
    193178
    194179Svndigest runs against a working copy (WC), i.e., svndigest will not
     
    198183repository. Issue `svn update` before running svndigest.
    199184
    200 = Copy Cache =
     185= About svncopyright =
     186
     187svncopyright updates the copyright statement in subversion controlled
     188files. The program detects the copyright statement and replaces it
     189with a copyright statement calculated from repository statistics.
     190
     191The copyright statement is detected as the first line containing the
     192string given in configuation variable `copyright-string` (default
     193'`Copyright (C)`'). The copyright statement ends with the first
     194following line containing no alphanumerical characters excluding the
     195''prefix'' string that preceeds '`copyright-string`'. This copyright
     196statement block is replaced with a new copyright statement generated
     197from analyzing `svn blame output`. An author is considered to have
     198copyright of the file if (s)he has added a line of code of comment
     199(excluding copyright statements). For an example of the format of the
     200generated copyright statement, please have a look at the top of this
     201file.
     202
     203By default the `svn user name` of the author is printed in the
     204copyright statement. This may be overridden by setting a
     205'`copyright-alias`' in the config file. In svndigest, for example,
     206user name `jari` is set to copyright-alias ''Jari Häkkinen'' and user
     207name `peter` is set to copyright-alias ''Peter Johansson''. If two (or
     208several) authors are given the same copyright-alias they are
     209considered as one person in the copyright statement (i.e. their alias
     210is not repeated). This may be useful if you want to give copyright to
     211an organization rather than to individual developers.
     212
     213= About svndigest-copy-cache =
    201214
    202215As explained above, statistics are cached during a run and svndigest
     
    234247
    235248Also, `svndigest-copy-cache` is ignorant about svn wc and will parse
    236 through `ROOT` directory and all its sub-directories ,looking for
     249through `ROOT` directory and all its sub-directories, looking for
    237250svndigest cache files, regardless whether they belong to the same svn
    238251working copy or not. Therefore, having other svn wc in subdirectories
Note: See TracChangeset for help on using the changeset viewer.