commit 57c4721d81da521e3d92e852b883179a129d9a60
author Mark Mentovai <mark@chromium.org> Thu Mar 09 11:14:09 2017 -0500
committer Commit Bot <commit-bot@chromium.org> Thu Mar 09 16:23:45 2017 +0000
tree 1f4947091f75a538549b28d761b016a18f55f1b9
parent 3e25201d21f0c9942442327a513041ce458a77ec

git-cl: Make BUG_LINE_FORMAT configurable in codereview.settings

The default BUG_LINE_FORMAT is the existing BUG=%s. Projects that wish
to begin using Gerrit-style footers like Bug: %s can now set this in
codereview.settings.

BUG=616753

Change-Id: I4470311a86db228eab2a1655ae884736cce8c380
Reviewed-on: https://chromium-review.googlesource.com/451565
Commit-Queue: Mark Mentovai <mark@chromium.org>
Reviewed-by: Andrii Shyshkalov <tandrii@chromium.org>

git_cl.py

diff --git a/git_cl.py b/git_cl.py
index f3eb5ed..47d5d01 100755
--- a/git_cl.py
+++ b/git_cl.py
@@ -811,6 +811,19 @@
       self.viewvc_url = self._GetRietveldConfig('viewvc-url', error_ok=True)
     return self.viewvc_url
 
+  def GetBugLineFormat(self):
+    # rietveld.bug-line-format should have a %s where the list of bugs should
+    # go. This is a bit of a quirk, because normal people will always want the
+    # bug list to go right after a prefix like BUG= or Bug:. The %s format
+    # approach is used strictly because there isn't a great way to carry the
+    # desired space after Bug: all the way from codereview.settings to here
+    # without treating : specially or inventing a quoting scheme.
+    bug_line_format = self._GetRietveldConfig('bug-line-format', error_ok=True)
+    if not bug_line_format:
+      # TODO(tandrii): change this to 'Bug: %s' to be a proper Gerrit footer.
+      bug_line_format = 'BUG=%s'
+    return bug_line_format
+
   def GetBugPrefix(self):
     return self._GetRietveldConfig('bug-prefix', error_ok=True)
 
@@ -3121,9 +3134,9 @@
     if not any((regexp.match(line) for line in self._description_lines)):
       prefix = settings.GetBugPrefix()
       values = list(_get_bug_line_values(prefix, bug or '')) or [prefix]
+      bug_line_format = settings.GetBugLineFormat()
       for value in values:
-        # TODO(tandrii): change this to 'Bug: xxx' to be a proper Gerrit footer.
-        self.append_footer('BUG=%s' % value)
+        self.append_footer(bug_line_format % value)
 
     content = gclient_utils.RunEditor(self.description, True,
                                       git_editor=settings.GetGitEditor())
@@ -3295,6 +3308,7 @@
   SetProperty('private', 'PRIVATE', unset_error_ok=True)
   SetProperty('tree-status-url', 'STATUS', unset_error_ok=True)
   SetProperty('viewvc-url', 'VIEW_VC', unset_error_ok=True)
+  SetProperty('bug-line-format', 'BUG_LINE_FORMAT', unset_error_ok=True)
   SetProperty('bug-prefix', 'BUG_PREFIX', unset_error_ok=True)
   SetProperty('cpplint-regex', 'LINT_REGEX', unset_error_ok=True)
   SetProperty('cpplint-ignore-regex', 'LINT_IGNORE_REGEX', unset_error_ok=True)