From: Nathan Cutler <ncutler@suse.com>
Date: Sun, 26 Mar 2017 16:46:11 +0000 (+0200)
Subject: tools: ceph-release-notes: document global variables
X-Git-Tag: v12.0.2~226^2~3
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=7b87722f29606d39b410a32d5aa12d76e9afa842;p=ceph.git

tools: ceph-release-notes: document global variables

Document the global variables we introduce in this patch set.

Signed-off-by: Nathan Cutler <ncutler@suse.com>
---

diff --git a/src/script/ceph-release-notes b/src/script/ceph-release-notes
index 291464550f15..11667eacaf8b 100755
--- a/src/script/ceph-release-notes
+++ b/src/script/ceph-release-notes
@@ -35,10 +35,12 @@ from git import Repo
 
 
 fixes_re = re.compile(r"Fixes\:? #(\d+)")
+# labels is the list of relevant labels defined for github.com/ceph/ceph
 labels = [ 'bluestore', 'build/ops', 'cephfs', 'common', 'core', 'mgr',
            'mon', 'performance', 'pybind', 'rdma', 'rgw', 'rbd', 'tests',
            'tools' ]
 merge_re = re.compile("Merge pull request #(\d+).*")
+# prefixes is the list of commit description prefixes we recognize
 prefixes = [ 'bluestore', 'build/ops', 'cephfs', 'cephx', 'cli', 'cmake',
              'common', 'core', 'crush', 'doc', 'fs', 'librados', 'librbd',
              'log', 'mds', 'mgr', 'mon', 'msgr', 'objecter', 'osd', 'rbd',