Fix reStructuredText markup for `` */`` in the README.

[update-copyright.git] / README

diff --git a/README b/README
index a3b561ae1cd8a04ecd8d152a007676888b3dd598..a8d63776ac04f62bd1666422d38d221965406b83 100644 (file)
--- a/README
+++ b/README
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8 -*-
+
 ``update-copyright`` is an automatic copyright updating tool.  I wrote
 the original for `Bugs Everywhere`_, but ended up copying it into a
 number of my projects.  Copying is bad, so here it is, split out as
@@ -114,6 +116,17 @@ is replaced by a new blurb, which is automatically generated from your
 configured long copyright string, with author names and edit years
 extracted from the VCS data for that file.
 
+While the above works well for languages that use ``#`` to mark
+comment lines, it doesn't work for languages like C that use ``/*…*/``
+to mark comments.  There blurb-update algorithm also looks for any
+lines that begging with ``/* Copyright`` and replaces that line, and
+subsequent lines up to one beginning with `` */``, with a new blurb.
+
+Because I've never seen a file with *both* trigger lines, it shouldn't
+be a problem to run both against each of your versioned files.  If it
+is a problem for you, let me know, and we can add some configuration
+options to work around the problem.
+
 Incomplete VCS history
 ----------------------