Changeset 526 for trunk

Timestamp:

Dec 25, 2007, 4:37:57 AM (15 years ago)

Author:

Peter Johansson

Message:

added paragraph on file-name-dictionary plus some minor changes

File:

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

trunk/doc/readme.txt

@@ -39 +39 @@
 ''other''. 
 
-From svndigest 0.7, it is possible to set the configuration file which
-rules are used for different files. For more on how to configure
-svndigest see below. If no configuration file is given or no rules are
-given, a set of default rules are used. For files named `*.h`, for
-example, rules allowing to detect comments as either `// ... \n` or
-`/* ... */`. These rules can be set in the configuration file using a
+From svndigest 0.7, it is possible to configure which rules are used
+for different files. For more on how to configure svndigest see
+below. If no configuration file is given or no rules are given, a set
+of default rules are used. For files named `*.h`, for example, rules
+allowing to detect comments as either `// ... \n` or `/*
+... */`. These rules can be set in the configuration file using a
 one-liner like:
 
@@ -59 +59 @@
 can be found in directory `.svndigest`, and the svndigest screenshots
 that can be reached through http://trac.thep.lu.se/svndigest/.
+
+Sometimes it might be useful if a file could be parsed as though it
+was going under a different name. It could, for example, be useful if
+files named `Makefile.in` could be parsed as `Makefile` or files named
+`test_repo.sh.in` could be parsed as though it was named
+`test_repo.sh`. More generally, it would be useful if files named
+`<file-name-pattern>.in` could be parsed as though it was named
+`<file-name-pattern>`. For this reason it is possible to set rules on
+how a filename should be interpreted (see section
+[file-name-dictionary] in configuration file). Default behaviour is
+that there is only one such a rule in use, namely the one described
+above that trailing `.in` in file names are discarded.
+
 
 == Different file types ==