X-Git-Url: http://git.tremily.us/?p=update-copyright.git;a=blobdiff_plain;f=README;h=2555ed07983244fccd4de1000b3cad737e9d1306;hp=995c19248145e9d917eb263459b1ab43ef1f7f99;hb=d087c88a9f89b827dfa02c90c1205073cc608db7;hpb=7abda844e15eaa8fee1abb76897c502eddcc5057 diff --git a/README b/README index 995c192..2555ed0 100644 --- 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 @@ -118,7 +120,7 @@ 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. +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 @@ -131,11 +133,11 @@ 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 , Jane Smith + path/to/file: John Doe | Jane Smith [year-hacks] path/to/another/file: 2009 @@ -173,7 +175,7 @@ Author ====== W. Trevor King -wking@drexel.edu +wking@tremily.us .. _Bugs Everywhere: http://bugseverywhere.org/