Changeset 351 for trunk/doc/readme.txt

Timestamp:

May 20, 2007, 12:35:40 PM (16 years ago)

Author:

Peter Johansson

Message:

added text on configuration

File:

• trunk/doc/readme.txt (modified) (2 diffs)

trunk/doc/readme.txt

@@ -86 +86 @@
 treatment.
 
+== Configuration ==
+
+The configuration file may be used to define Various behaviors for
+svndigest. By default svndigest looks for a config file named `config`
+in directory `<root-dir>/.svndigest` (<root-dir> is directory set by
+option `--root`). If no such file is found, svndigest behaves as
+default. Which file to be used as config file may also be set with
+option `--config-file`. To update an old config file you can use the
+option `--generate-config`. With this option set the used
+configuration will be written to standard output. If new variables has
+been added to configuration of svndigest, these variables will be
+written with default values. Note: if you have added a comment (e.g. a
+subversion keyword $Id$) to your old config file, this will not be
+inherited to the new config file. To preserve such a comment you must
+merge the new config file with the old config file manually.
+
 == Copyright update ==
 
@@ -98 +114 @@
 copyright of the file if (s)he has modified the file and thereby
 occurs in the log. For an example of the format of the generated
-copyright statement, please have a look at any file in the svndigest
-project.
+copyright statement, please have a look at the bottom of this file. By
+default the `svn user name` of the author is printed in the copyright
+statement. This may be overridden by setting a `copyright-alias` in
+the config file. In svndigest, e.g., user name `jari` is set to
+copyright-alias ''Jari Häkkinen'' and user name `peter` is set to
+copyright-alias ''Peter Johansson''. If two (or several) authors are
+given the same copyright-alias they are considered as one person in
+the copyright statement (i.e. their alias is not repeated). This may
+be useful if you want to give copyright to an organization rather than
+to individual developers.
 
 == Prerequisites ==