+.. -*- 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
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
----------------------
Sometimes files have authors or alterations not recorded in a
project's VCS history. You can use the ``author-hacks`` section to
add authors to a file, and the ``year-hacks`` section to adjust the
-files original year. Author names should be comma-separated. For
+files original year. Author names should be pipe-separated. For
example::
[author-hacks]
- path/to/file: John Doe <jdoe@a.com>, Jane Smith <jsmith@b.net>
+ path/to/file: John Doe <jdoe@a.com> | Jane Smith <jsmith@b.net>
[year-hacks]
path/to/another/file: 2009
are the canonical name of the ...?. For example::
[aliases]
- John Doe <jdoe@a.com>: John Doe, jdoe, J. Doe <j@doe.net>
+ John Doe <jdoe@a.com>: John Doe | jdoe | J. Doe <j@doe.net>
Testing
=======
======
W. Trevor King
-wking@drexel.edu
+wking@tremily.us
.. _Bugs Everywhere: http://bugseverywhere.org/