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 291464550f15ca1127703c2d41d39323992c0a36..11667eacaf8bb436b22f47e380f1dae25fd21be4 100755 (executable)
--- 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',