Issue 5250 - Add copyright update script

update-copyright/README.md

-# update-copyright #

[Vasily Kuznetsov, 2017/07/04 15:02:40]

In general we don't add # at ends of headings in the markdown documents. It's
not a big deal to have them here, but I'd suggest to keep things consistent
unless there's a good reason to not do it.

[rosie, 2017/07/04 15:14:02]

Done.

+# update-copyright
 
-This script accepts a URL to a mercurial index as input. It then makes a local copy of each repo, updates the copyright information on every file to the current year, then attempts to push the updates. If a user doesn't have permission to push to a repo, the script will make a local `repo-name.patch` file to submit later. You are free to use it for other projects but please keep in mind that we make no stability guarantees whatsoever and might change functionality any time.

[Vasily Kuznetsov, 2017/07/04 15:02:40]

Another mostly consistency-related point: the long lines are usually wrapped to
80 characters elsewhere. There's no strong reason, but it's a bit easier to work
with shorter lines and any decent editor can do the wrapping automatically.

[rosie, 2017/07/04 15:14:02]

Done.

+This script will attempt to update the eyeo copyright information on each
+page of each repo listed on a Mercurial index page.
+By default, running the script will scrape [https://hg.adblockplus.org/](https://hg.adblockplus.org/),
+and then for each repo, it will:
+* make a local copy of the repo
+* update the copyright information on each file to the current year
+* attempt to push the updates to `ssh://hg@hg.adblockplus.org/`
 
-## How to use ##
+If a user doesn't have permission to push to a repo, the script will make a
+local `repo-name.patch` file to submit later. 
 
-To update the copyright on all the repos indexed at [https://hg.adblockplus.org/](https://hg.adblockplus.org/), you can use the accompanying shell script, e.g.:
+You are free to use this for other projects but please keep in mind that we
+make no stability guarantees whatsoever and might change functionality any
+time.
 
-    ./run_update_copyright.sh
+## How to use
 
-To run the script elsewhere, you must specify the URL for a Mercurial index site to scrape, e.g.:
+To update the copyright on all the repos indexed at [https://hg.adblockplus.org/](https://hg.adblockplus.org/),
+simply run the script, e.g.:
 
-    python3 update_copyright.py -u https://hg.example.com/
+    ./update_copyright.py
 
-You may also specify a base URL of a remote repo to push to, if it is different than the base URL of the index page, e.g.:
+To run the script elsewhere, you must specify the URL for a Mercurial index
+site to scrape, and the location of the base URL to push to, e.g.:
 
-    python3 update_copyright.py -u https://hg.example.com/ -p ssh://user@hg.example.com/
+    ./update_copyright.py -u https://hg.example.com/ -p ssh://user@hg.example.com/
 
-## Testing ##
+## Testing
 
 Testing can be run via [tox](http://tox.readthedocs.org/).