On 08/09/2016 09:28 AM, Gerald Pfeifer wrote:
> On Wed, 3 Aug 2016, Martin Liška wrote:
>> I've installed (r239066) the script which is used by maintainers to 
>> update PRs in a batch mode.
> 
> I think it would be good to add a comment at the top that
> describes what the scripts does and how to invoke the script?
> 
> Gerald
> 

Sure, what about this?

Martin
>From 7dc4791e13186e8ed9306fcbabe8ad9e27f66ebd Mon Sep 17 00:00:00 2001
From: marxin <mli...@suse.cz>
Date: Fri, 12 Aug 2016 15:27:29 +0200
Subject: [PATCH] Document branch_changer.py script

maintainer-scripts/ChangeLog:

2016-08-12  Martin Liska  <mli...@suse.cz>

	* branch_changer.py: Describe the script.
---
 maintainer-scripts/branch_changer.py | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/maintainer-scripts/branch_changer.py b/maintainer-scripts/branch_changer.py
index 5e1681b..c1113cd 100755
--- a/maintainer-scripts/branch_changer.py
+++ b/maintainer-scripts/branch_changer.py
@@ -1,5 +1,14 @@
 #!/usr/bin/env python3
 
+# Script is used by maintainers to modify bugzilla entries in a batch mode.
+# Currently, the scripts can remove and add a release from/to PRs that are
+# prefixed with '[x Regression]'. Apart from that, the script can also
+# change a target milestone and optionally enhance list of known-to-fail
+# versions.
+#
+# The script utilizes the Bugzilla API, as documented here:
+# http://bugzilla.readthedocs.io/en/latest/api/index.html
+
 # The script requires simplejson, requests, semantic_version packages, in case
 # of openSUSE:
 # zypper in python3-simplejson python3-requests
-- 
2.9.2

Reply via email to