Added git footers tool to parse conventional metadata from git commits
BUG=407316 Review URL: https://codereview.chromium.org/521033002 git-svn-id: svn://svn.chromium.org/chrome/trunk/tools/depot_tools@291777 0039d316-1c4b-4281-b951-d872f2087c98changes/01/332501/1
luqui@chromium.org
11 years ago
parent
9d2c880e98
commit
0b88762379
@ -0,0 +1,8 @@
|
||||
#!/usr/bin/env bash
|
||||
# Copyright 2014 The Chromium Authors. All rights reserved.
|
||||
# Use of this source code is governed by a BSD-style license that can be
|
||||
# found in the LICENSE file.
|
||||
|
||||
# git_footers.py -- Extract the conventional footers associated with a commit.
|
||||
|
||||
. $(type -P python_git_runner.sh)
|
||||
@ -0,0 +1,131 @@
|
||||
#!/usr/bin/env python
|
||||
# Copyright 2014 The Chromium Authors. All rights reserved.
|
||||
# Use of this source code is governed by a BSD-style license that can be
|
||||
# found in the LICENSE file.
|
||||
|
||||
import argparse
|
||||
import re
|
||||
import sys
|
||||
|
||||
from collections import defaultdict
|
||||
|
||||
import git_common as git
|
||||
|
||||
FOOTER_PATTERN = re.compile(r'^\s*([\w-]+): (.*)$')
|
||||
CHROME_COMMIT_POSITION_PATTERN = re.compile(r'^([\w/-]+)@{#(\d+)}$')
|
||||
GIT_SVN_ID_PATTERN = re.compile('^([^\s@]+)@(\d+)')
|
||||
|
||||
def normalize_name(header):
|
||||
return '-'.join([ word.title() for word in header.strip().split('-') ])
|
||||
|
||||
|
||||
def parse_footer(line):
|
||||
match = FOOTER_PATTERN.match(line)
|
||||
if match:
|
||||
return (match.group(1), match.group(2))
|
||||
else:
|
||||
return None
|
||||
|
||||
|
||||
def parse_footers(message):
|
||||
"""Parses a git commit message into a multimap of footers."""
|
||||
footer_lines = []
|
||||
for line in reversed(message.splitlines()):
|
||||
if line == '' or line.isspace():
|
||||
break
|
||||
footer_lines.append(line)
|
||||
|
||||
footers = map(parse_footer, footer_lines)
|
||||
if not all(footers):
|
||||
return defaultdict(list)
|
||||
|
||||
footer_map = defaultdict(list)
|
||||
for (k, v) in footers:
|
||||
footer_map[normalize_name(k)].append(v.strip())
|
||||
|
||||
return footer_map
|
||||
|
||||
|
||||
def get_unique(footers, key):
|
||||
key = normalize_name(key)
|
||||
values = footers[key]
|
||||
assert len(values) <= 1, 'Multiple %s footers' % key
|
||||
if values:
|
||||
return values[0]
|
||||
else:
|
||||
return None
|
||||
|
||||
|
||||
def get_position(footers):
|
||||
"""Get the chrome commit position from a footer multimap using a heuristic.
|
||||
|
||||
Returns:
|
||||
A tuple of the branch and the position on that branch. For example,
|
||||
|
||||
Cr-Commit-Position: refs/heads/master@{#292272}
|
||||
|
||||
would give the return value ('refs/heads/master', 292272). If
|
||||
Cr-Commit-Position is not defined, we try to infer the ref and position
|
||||
from git-svn-id. The position number can be None if it was not inferrable.
|
||||
"""
|
||||
|
||||
position = get_unique(footers, 'Cr-Commit-Position')
|
||||
if position:
|
||||
match = CHROME_COMMIT_POSITION_PATTERN.match(position)
|
||||
assert match, 'Invalid Cr-Commit-Position value: %s' % position
|
||||
return (match.group(1), match.group(2))
|
||||
|
||||
svn_commit = get_unique(footers, 'git-svn-id')
|
||||
if svn_commit:
|
||||
match = GIT_SVN_ID_PATTERN.match(svn_commit)
|
||||
assert match, 'Invalid git-svn-id value: %s' % svn_commit
|
||||
if re.match('.*/chrome/trunk/src$', match.group(1)):
|
||||
return ('refs/heads/master', match.group(2))
|
||||
branch_match = re.match('.*/chrome/branches/([\w/-]+)/src$', match.group(1))
|
||||
if branch_match:
|
||||
# svn commit numbers do not map to branches.
|
||||
return ('refs/branch-heads/%s' % branch_match.group(1), None)
|
||||
|
||||
raise ValueError('Unable to infer commit position from footers')
|
||||
|
||||
|
||||
def main(args):
|
||||
parser = argparse.ArgumentParser(
|
||||
formatter_class=argparse.ArgumentDefaultsHelpFormatter
|
||||
)
|
||||
parser.add_argument('ref')
|
||||
|
||||
g = parser.add_mutually_exclusive_group()
|
||||
g.add_argument('--key', metavar='KEY',
|
||||
help='Get all values for the given footer name, one per '
|
||||
'line (case insensitive)')
|
||||
g.add_argument('--position', action='store_true')
|
||||
g.add_argument('--position-ref', action='store_true')
|
||||
g.add_argument('--position-num', action='store_true')
|
||||
|
||||
|
||||
opts = parser.parse_args(args)
|
||||
|
||||
message = git.run('log', '-1', '--format=%B', opts.ref)
|
||||
footers = parse_footers(message)
|
||||
|
||||
if opts.key:
|
||||
for v in footers.get(normalize_name(opts.key), []):
|
||||
print v
|
||||
elif opts.position:
|
||||
pos = get_position(footers)
|
||||
print '%s@{#%s}' % (pos[0], pos[1] or '?')
|
||||
elif opts.position_ref:
|
||||
print get_position(footers)[0]
|
||||
elif opts.position_num:
|
||||
pos = get_position(footers)
|
||||
assert pos[1], 'No valid position for commit'
|
||||
print pos[1]
|
||||
else:
|
||||
for k in footers.keys():
|
||||
for v in footers[k]:
|
||||
print '%s: %s' % (k, v)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
sys.exit(main(sys.argv[1:]))
|
||||
@ -0,0 +1,878 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
|
||||
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
|
||||
<meta name="generator" content="AsciiDoc 8.6.9" />
|
||||
<title>git-freeze(1)</title>
|
||||
<style type="text/css">
|
||||
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
|
||||
|
||||
/* Default font. */
|
||||
body {
|
||||
font-family: Georgia,serif;
|
||||
}
|
||||
|
||||
/* Title font. */
|
||||
h1, h2, h3, h4, h5, h6,
|
||||
div.title, caption.title,
|
||||
thead, p.table.header,
|
||||
#toctitle,
|
||||
#author, #revnumber, #revdate, #revremark,
|
||||
#footer {
|
||||
font-family: Arial,Helvetica,sans-serif;
|
||||
}
|
||||
|
||||
body {
|
||||
margin: 1em 5% 1em 5%;
|
||||
}
|
||||
|
||||
a {
|
||||
color: blue;
|
||||
text-decoration: underline;
|
||||
}
|
||||
a:visited {
|
||||
color: fuchsia;
|
||||
}
|
||||
|
||||
em {
|
||||
font-style: italic;
|
||||
color: navy;
|
||||
}
|
||||
|
||||
strong {
|
||||
font-weight: bold;
|
||||
color: #083194;
|
||||
}
|
||||
|
||||
h1, h2, h3, h4, h5, h6 {
|
||||
color: #527bbd;
|
||||
margin-top: 1.2em;
|
||||
margin-bottom: 0.5em;
|
||||
line-height: 1.3;
|
||||
}
|
||||
|
||||
h1, h2, h3 {
|
||||
border-bottom: 2px solid silver;
|
||||
}
|
||||
h2 {
|
||||
padding-top: 0.5em;
|
||||
}
|
||||
h3 {
|
||||
float: left;
|
||||
}
|
||||
h3 + * {
|
||||
clear: left;
|
||||
}
|
||||
h5 {
|
||||
font-size: 1.0em;
|
||||
}
|
||||
|
||||
div.sectionbody {
|
||||
margin-left: 0;
|
||||
}
|
||||
|
||||
hr {
|
||||
border: 1px solid silver;
|
||||
}
|
||||
|
||||
p {
|
||||
margin-top: 0.5em;
|
||||
margin-bottom: 0.5em;
|
||||
}
|
||||
|
||||
ul, ol, li > p {
|
||||
margin-top: 0;
|
||||
}
|
||||
ul > li { color: #aaa; }
|
||||
ul > li > * { color: black; }
|
||||
|
||||
.monospaced, code, pre {
|
||||
font-family: "Courier New", Courier, monospace;
|
||||
font-size: inherit;
|
||||
color: navy;
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
}
|
||||
pre {
|
||||
white-space: pre-wrap;
|
||||
}
|
||||
|
||||
#author {
|
||||
color: #527bbd;
|
||||
font-weight: bold;
|
||||
font-size: 1.1em;
|
||||
}
|
||||
#email {
|
||||
}
|
||||
#revnumber, #revdate, #revremark {
|
||||
}
|
||||
|
||||
#footer {
|
||||
font-size: small;
|
||||
border-top: 2px solid silver;
|
||||
padding-top: 0.5em;
|
||||
margin-top: 4.0em;
|
||||
}
|
||||
#footer-text {
|
||||
float: left;
|
||||
padding-bottom: 0.5em;
|
||||
}
|
||||
#footer-badges {
|
||||
float: right;
|
||||
padding-bottom: 0.5em;
|
||||
}
|
||||
|
||||
#preamble {
|
||||
margin-top: 1.5em;
|
||||
margin-bottom: 1.5em;
|
||||
}
|
||||
div.imageblock, div.exampleblock, div.verseblock,
|
||||
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
|
||||
div.admonitionblock {
|
||||
margin-top: 1.0em;
|
||||
margin-bottom: 1.5em;
|
||||
}
|
||||
div.admonitionblock {
|
||||
margin-top: 2.0em;
|
||||
margin-bottom: 2.0em;
|
||||
margin-right: 10%;
|
||||
color: #606060;
|
||||
}
|
||||
|
||||
div.content { /* Block element content. */
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
/* Block element titles. */
|
||||
div.title, caption.title {
|
||||
color: #527bbd;
|
||||
font-weight: bold;
|
||||
text-align: left;
|
||||
margin-top: 1.0em;
|
||||
margin-bottom: 0.5em;
|
||||
}
|
||||
div.title + * {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
td div.title:first-child {
|
||||
margin-top: 0.0em;
|
||||
}
|
||||
div.content div.title:first-child {
|
||||
margin-top: 0.0em;
|
||||
}
|
||||
div.content + div.title {
|
||||
margin-top: 0.0em;
|
||||
}
|
||||
|
||||
div.sidebarblock > div.content {
|
||||
background: #ffffee;
|
||||
border: 1px solid #dddddd;
|
||||
border-left: 4px solid #f0f0f0;
|
||||
padding: 0.5em;
|
||||
}
|
||||
|
||||
div.listingblock > div.content {
|
||||
border: 1px solid #dddddd;
|
||||
border-left: 5px solid #f0f0f0;
|
||||
background: #f8f8f8;
|
||||
padding: 0.5em;
|
||||
}
|
||||
|
||||
div.quoteblock, div.verseblock {
|
||||
padding-left: 1.0em;
|
||||
margin-left: 1.0em;
|
||||
margin-right: 10%;
|
||||
border-left: 5px solid #f0f0f0;
|
||||
color: #888;
|
||||
}
|
||||
|
||||
div.quoteblock > div.attribution {
|
||||
padding-top: 0.5em;
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
div.verseblock > pre.content {
|
||||
font-family: inherit;
|
||||
font-size: inherit;
|
||||
}
|
||||
div.verseblock > div.attribution {
|
||||
padding-top: 0.75em;
|
||||
text-align: left;
|
||||
}
|
||||
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
|
||||
div.verseblock + div.attribution {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
div.admonitionblock .icon {
|
||||
vertical-align: top;
|
||||
font-size: 1.1em;
|
||||
font-weight: bold;
|
||||
text-decoration: underline;
|
||||
color: #527bbd;
|
||||
padding-right: 0.5em;
|
||||
}
|
||||
div.admonitionblock td.content {
|
||||
padding-left: 0.5em;
|
||||
border-left: 3px solid #dddddd;
|
||||
}
|
||||
|
||||
div.exampleblock > div.content {
|
||||
border-left: 3px solid #dddddd;
|
||||
padding-left: 0.5em;
|
||||
}
|
||||
|
||||
div.imageblock div.content { padding-left: 0; }
|
||||
span.image img { border-style: none; vertical-align: text-bottom; }
|
||||
a.image:visited { color: white; }
|
||||
|
||||
dl {
|
||||
margin-top: 0.8em;
|
||||
margin-bottom: 0.8em;
|
||||
}
|
||||
dt {
|
||||
margin-top: 0.5em;
|
||||
margin-bottom: 0;
|
||||
font-style: normal;
|
||||
color: navy;
|
||||
}
|
||||
dd > *:first-child {
|
||||
margin-top: 0.1em;
|
||||
}
|
||||
|
||||
ul, ol {
|
||||
list-style-position: outside;
|
||||
}
|
||||
ol.arabic {
|
||||
list-style-type: decimal;
|
||||
}
|
||||
ol.loweralpha {
|
||||
list-style-type: lower-alpha;
|
||||
}
|
||||
ol.upperalpha {
|
||||
list-style-type: upper-alpha;
|
||||
}
|
||||
ol.lowerroman {
|
||||
list-style-type: lower-roman;
|
||||
}
|
||||
ol.upperroman {
|
||||
list-style-type: upper-roman;
|
||||
}
|
||||
|
||||
div.compact ul, div.compact ol,
|
||||
div.compact p, div.compact p,
|
||||
div.compact div, div.compact div {
|
||||
margin-top: 0.1em;
|
||||
margin-bottom: 0.1em;
|
||||
}
|
||||
|
||||
tfoot {
|
||||
font-weight: bold;
|
||||
}
|
||||
td > div.verse {
|
||||
white-space: pre;
|
||||
}
|
||||
|
||||
div.hdlist {
|
||||
margin-top: 0.8em;
|
||||
margin-bottom: 0.8em;
|
||||
}
|
||||
div.hdlist tr {
|
||||
padding-bottom: 15px;
|
||||
}
|
||||
dt.hdlist1.strong, td.hdlist1.strong {
|
||||
font-weight: bold;
|
||||
}
|
||||
td.hdlist1 {
|
||||
vertical-align: top;
|
||||
font-style: normal;
|
||||
padding-right: 0.8em;
|
||||
color: navy;
|
||||
}
|
||||
td.hdlist2 {
|
||||
vertical-align: top;
|
||||
}
|
||||
div.hdlist.compact tr {
|
||||
margin: 0;
|
||||
padding-bottom: 0;
|
||||
}
|
||||
|
||||
.comment {
|
||||
background: yellow;
|
||||
}
|
||||
|
||||
.footnote, .footnoteref {
|
||||
font-size: 0.8em;
|
||||
}
|
||||
|
||||
span.footnote, span.footnoteref {
|
||||
vertical-align: super;
|
||||
}
|
||||
|
||||
#footnotes {
|
||||
margin: 20px 0 20px 0;
|
||||
padding: 7px 0 0 0;
|
||||
}
|
||||
|
||||
#footnotes div.footnote {
|
||||
margin: 0 0 5px 0;
|
||||
}
|
||||
|
||||
#footnotes hr {
|
||||
border: none;
|
||||
border-top: 1px solid silver;
|
||||
height: 1px;
|
||||
text-align: left;
|
||||
margin-left: 0;
|
||||
width: 20%;
|
||||
min-width: 100px;
|
||||
}
|
||||
|
||||
div.colist td {
|
||||
padding-right: 0.5em;
|
||||
padding-bottom: 0.3em;
|
||||
vertical-align: top;
|
||||
}
|
||||
div.colist td img {
|
||||
margin-top: 0.3em;
|
||||
}
|
||||
|
||||
@media print {
|
||||
#footer-badges { display: none; }
|
||||
}
|
||||
|
||||
#toc {
|
||||
margin-bottom: 2.5em;
|
||||
}
|
||||
|
||||
#toctitle {
|
||||
color: #527bbd;
|
||||
font-size: 1.1em;
|
||||
font-weight: bold;
|
||||
margin-top: 1.0em;
|
||||
margin-bottom: 0.1em;
|
||||
}
|
||||
|
||||
div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
div.toclevel2 {
|
||||
margin-left: 2em;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
div.toclevel3 {
|
||||
margin-left: 4em;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
div.toclevel4 {
|
||||
margin-left: 6em;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
|
||||
span.aqua { color: aqua; }
|
||||
span.black { color: black; }
|
||||
span.blue { color: blue; }
|
||||
span.fuchsia { color: fuchsia; }
|
||||
span.gray { color: gray; }
|
||||
span.green { color: green; }
|
||||
span.lime { color: lime; }
|
||||
span.maroon { color: maroon; }
|
||||
span.navy { color: navy; }
|
||||
span.olive { color: olive; }
|
||||
span.purple { color: purple; }
|
||||
span.red { color: red; }
|
||||
span.silver { color: silver; }
|
||||
span.teal { color: teal; }
|
||||
span.white { color: white; }
|
||||
span.yellow { color: yellow; }
|
||||
|
||||
span.aqua-background { background: aqua; }
|
||||
span.black-background { background: black; }
|
||||
span.blue-background { background: blue; }
|
||||
span.fuchsia-background { background: fuchsia; }
|
||||
span.gray-background { background: gray; }
|
||||
span.green-background { background: green; }
|
||||
span.lime-background { background: lime; }
|
||||
span.maroon-background { background: maroon; }
|
||||
span.navy-background { background: navy; }
|
||||
span.olive-background { background: olive; }
|
||||
span.purple-background { background: purple; }
|
||||
span.red-background { background: red; }
|
||||
span.silver-background { background: silver; }
|
||||
span.teal-background { background: teal; }
|
||||
span.white-background { background: white; }
|
||||
span.yellow-background { background: yellow; }
|
||||
|
||||
span.big { font-size: 2em; }
|
||||
span.small { font-size: 0.6em; }
|
||||
|
||||
span.underline { text-decoration: underline; }
|
||||
span.overline { text-decoration: overline; }
|
||||
span.line-through { text-decoration: line-through; }
|
||||
|
||||
div.unbreakable { page-break-inside: avoid; }
|
||||
|
||||
|
||||
/*
|
||||
* xhtml11 specific
|
||||
*
|
||||
* */
|
||||
|
||||
div.tableblock {
|
||||
margin-top: 1.0em;
|
||||
margin-bottom: 1.5em;
|
||||
}
|
||||
div.tableblock > table {
|
||||
border: 3px solid #527bbd;
|
||||
}
|
||||
thead, p.table.header {
|
||||
font-weight: bold;
|
||||
color: #527bbd;
|
||||
}
|
||||
p.table {
|
||||
margin-top: 0;
|
||||
}
|
||||
/* Because the table frame attribute is overriden by CSS in most browsers. */
|
||||
div.tableblock > table[frame="void"] {
|
||||
border-style: none;
|
||||
}
|
||||
div.tableblock > table[frame="hsides"] {
|
||||
border-left-style: none;
|
||||
border-right-style: none;
|
||||
}
|
||||
div.tableblock > table[frame="vsides"] {
|
||||
border-top-style: none;
|
||||
border-bottom-style: none;
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
* html5 specific
|
||||
*
|
||||
* */
|
||||
|
||||
table.tableblock {
|
||||
margin-top: 1.0em;
|
||||
margin-bottom: 1.5em;
|
||||
}
|
||||
thead, p.tableblock.header {
|
||||
font-weight: bold;
|
||||
color: #527bbd;
|
||||
}
|
||||
p.tableblock {
|
||||
margin-top: 0;
|
||||
}
|
||||
table.tableblock {
|
||||
border-width: 3px;
|
||||
border-spacing: 0px;
|
||||
border-style: solid;
|
||||
border-color: #527bbd;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
th.tableblock, td.tableblock {
|
||||
border-width: 1px;
|
||||
padding: 4px;
|
||||
border-style: solid;
|
||||
border-color: #527bbd;
|
||||
}
|
||||
|
||||
table.tableblock.frame-topbot {
|
||||
border-left-style: hidden;
|
||||
border-right-style: hidden;
|
||||
}
|
||||
table.tableblock.frame-sides {
|
||||
border-top-style: hidden;
|
||||
border-bottom-style: hidden;
|
||||
}
|
||||
table.tableblock.frame-none {
|
||||
border-style: hidden;
|
||||
}
|
||||
|
||||
th.tableblock.halign-left, td.tableblock.halign-left {
|
||||
text-align: left;
|
||||
}
|
||||
th.tableblock.halign-center, td.tableblock.halign-center {
|
||||
text-align: center;
|
||||
}
|
||||
th.tableblock.halign-right, td.tableblock.halign-right {
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
th.tableblock.valign-top, td.tableblock.valign-top {
|
||||
vertical-align: top;
|
||||
}
|
||||
th.tableblock.valign-middle, td.tableblock.valign-middle {
|
||||
vertical-align: middle;
|
||||
}
|
||||
th.tableblock.valign-bottom, td.tableblock.valign-bottom {
|
||||
vertical-align: bottom;
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
* manpage specific
|
||||
*
|
||||
* */
|
||||
|
||||
body.manpage h1 {
|
||||
padding-top: 0.5em;
|
||||
padding-bottom: 0.5em;
|
||||
border-top: 2px solid silver;
|
||||
border-bottom: 2px solid silver;
|
||||
}
|
||||
body.manpage h2 {
|
||||
border-style: none;
|
||||
}
|
||||
body.manpage div.sectionbody {
|
||||
margin-left: 3em;
|
||||
}
|
||||
|
||||
@media print {
|
||||
body.manpage div#toc { display: none; }
|
||||
}
|
||||
|
||||
|
||||
div.listingblock > div.content {
|
||||
background: rgb(28, 28, 28);
|
||||
}
|
||||
|
||||
div.listingblock > div > pre > code {
|
||||
color: rgb(187, 187, 187);
|
||||
}
|
||||
</style>
|
||||
<script type="text/javascript">
|
||||
/*<+'])');
|
||||
// Function that scans the DOM tree for header elements (the DOM2
|
||||
// nodeIterator API would be a better technique but not supported by all
|
||||
// browsers).
|
||||
var iterate = function (el) {
|
||||
for (var i = el.firstChild; i != null; i = i.nextSibling) {
|
||||
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
|
||||
var mo = re.exec(i.tagName);
|
||||
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
|
||||
result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
|
||||
}
|
||||
iterate(i);
|
||||
}
|
||||
}
|
||||
}
|
||||
iterate(el);
|
||||
return result;
|
||||
}
|
||||
|
||||
var toc = document.getElementById("toc");
|
||||
if (!toc) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Delete existing TOC entries in case we're reloading the TOC.
|
||||
var tocEntriesToRemove = [];
|
||||
var i;
|
||||
for (i = 0; i < toc.childNodes.length; i++) {
|
||||
var entry = toc.childNodes[i];
|
||||
if (entry.nodeName.toLowerCase() == 'div'
|
||||
&& entry.getAttribute("class")
|
||||
&& entry.getAttribute("class").match(/^toclevel/))
|
||||
tocEntriesToRemove.push(entry);
|
||||
}
|
||||
for (i = 0; i < tocEntriesToRemove.length; i++) {
|
||||
toc.removeChild(tocEntriesToRemove[i]);
|
||||
}
|
||||
|
||||
// Rebuild TOC entries.
|
||||
var entries = tocEntries(document.getElementById("content"), toclevels);
|
||||
for (var i = 0; i < entries.length; ++i) {
|
||||
var entry = entries[i];
|
||||
if (entry.element.id == "")
|
||||
entry.element.id = "_toc_" + i;
|
||||
var a = document.createElement("a");
|
||||
a.href = "#" + entry.element.id;
|
||||
a.appendChild(document.createTextNode(entry.text));
|
||||
var div = document.createElement("div");
|
||||
div.appendChild(a);
|
||||
div.className = "toclevel" + entry.toclevel;
|
||||
toc.appendChild(div);
|
||||
}
|
||||
if (entries.length == 0)
|
||||
toc.parentNode.removeChild(toc);
|
||||
},
|
||||
|
||||
|
||||
/////////////////////////////////////////////////////////////////////
|
||||
// Footnotes generator
|
||||
/////////////////////////////////////////////////////////////////////
|
||||
|
||||
/* Based on footnote generation code from:
|
||||
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
|
||||
*/
|
||||
|
||||
footnotes: function () {
|
||||
// Delete existing footnote entries in case we're reloading the footnodes.
|
||||
var i;
|
||||
var noteholder = document.getElementById("footnotes");
|
||||
if (!noteholder) {
|
||||
return;
|
||||
}
|
||||
var entriesToRemove = [];
|
||||
for (i = 0; i < noteholder.childNodes.length; i++) {
|
||||
var entry = noteholder.childNodes[i];
|
||||
if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
|
||||
entriesToRemove.push(entry);
|
||||
}
|
||||
for (i = 0; i < entriesToRemove.length; i++) {
|
||||
noteholder.removeChild(entriesToRemove[i]);
|
||||
}
|
||||
|
||||
// Rebuild footnote entries.
|
||||
var cont = document.getElementById("content");
|
||||
var spans = cont.getElementsByTagName("span");
|
||||
var refs = {};
|
||||
var n = 0;
|
||||
for (i=0; i<spans.length; i++) {
|
||||
if (spans[i].className == "footnote") {
|
||||
n++;
|
||||
var note = spans[i].getAttribute("data-note");
|
||||
if (!note) {
|
||||
// Use [\s\S] in place of . so multi-line matches work.
|
||||
// Because JavaScript has no s (dotall) regex flag.
|
||||
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
|
||||
spans[i].innerHTML =
|
||||
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
|
||||
"' title='View footnote' class='footnote'>" + n + "</a>]";
|
||||
spans[i].setAttribute("data-note", note);
|
||||
}
|
||||
noteholder.innerHTML +=
|
||||
"<div class='footnote' id='_footnote_" + n + "'>" +
|
||||
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
|
||||
n + "</a>. " + note + "</div>";
|
||||
var id =spans[i].getAttribute("id");
|
||||
if (id != null) refs["#"+id] = n;
|
||||
}
|
||||
}
|
||||
if (n == 0)
|
||||
noteholder.parentNode.removeChild(noteholder);
|
||||
else {
|
||||
// Process footnoterefs.
|
||||
for (i=0; i<spans.length; i++) {
|
||||
if (spans[i].className == "footnoteref") {
|
||||
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
|
||||
href = href.match(/#.*/)[0]; // Because IE return full URL.
|
||||
n = refs[href];
|
||||
spans[i].innerHTML =
|
||||
"[<a href='#_footnote_" + n +
|
||||
"' title='View footnote' class='footnote'>" + n + "</a>]";
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
install: function(toclevels) {
|
||||
var timerId;
|
||||
|
||||
function reinstall() {
|
||||
asciidoc.footnotes();
|
||||
if (toclevels) {
|
||||
asciidoc.toc(toclevels);
|
||||
}
|
||||
}
|
||||
|
||||
function reinstallAndRemoveTimer() {
|
||||
clearInterval(timerId);
|
||||
reinstall();
|
||||
}
|
||||
|
||||
timerId = setInterval(reinstall, 500);
|
||||
if (document.addEventListener)
|
||||
document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
|
||||
else
|
||||
window.onload = reinstallAndRemoveTimer;
|
||||
}
|
||||
|
||||
}
|
||||
asciidoc.install();
|
||||
/*]]>*/
|
||||
</script>
|
||||
</head>
|
||||
<body class="manpage">
|
||||
<div id="header">
|
||||
<h1>
|
||||
git-freeze(1) Manual Page
|
||||
</h1>
|
||||
<h2>NAME</h2>
|
||||
<div class="sectionbody">
|
||||
<p>git-footers -
|
||||
Extract meta-information expressed as footers in a commit message.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
<div id="content">
|
||||
<div class="sect1">
|
||||
<h2 id="_synopsis">SYNOPSIS</h2>
|
||||
<div class="sectionbody">
|
||||
<div class="verseblock">
|
||||
<pre class="content"><em>git footers</em> [--key FOOTER] REF
|
||||
<em>git footers</em> [--position | --position-ref | --position-num] REF</pre>
|
||||
<div class="attribution">
|
||||
</div></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect1">
|
||||
<h2 id="_description">DESCRIPTION</h2>
|
||||
<div class="sectionbody">
|
||||
<div class="paragraph"><p><code>git footers</code> extracts information included in commit messages as "footers",
|
||||
which are roughly like HTTP headers except they are at the end. For example, a
|
||||
commit might look like:</p></div>
|
||||
<div class="literalblock">
|
||||
<div class="content">
|
||||
<pre><code>This is a fancy commit message.</code></pre>
|
||||
</div></div>
|
||||
<div class="literalblock">
|
||||
<div class="content">
|
||||
<pre><code>Cr-Commit-Position: refs/heads/master@{#292272}
|
||||
Tech-Debt-Introduced: 17 nanoMSOffices</code></pre>
|
||||
</div></div>
|
||||
<div class="paragraph"><p><code>git footers</code> knows how to extract this information.</p></div>
|
||||
<div class="paragraph"><p>Footers are order-independent and can appear more than once. Thus they are
|
||||
treated as a multimap.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect1">
|
||||
<h2 id="_options">OPTIONS</h2>
|
||||
<div class="sectionbody">
|
||||
<div class="paragraph"><p>If no options are given, all footers are printed, with their names
|
||||
case-normalized.</p></div>
|
||||
<div class="dlist"><dl>
|
||||
<dt class="hdlist1">
|
||||
--key FOOTER
|
||||
</dt>
|
||||
<dd>
|
||||
<p>
|
||||
Extract all the headers associated with the given key, and print one per
|
||||
line. If there are no footers with this key, produces no output and exits
|
||||
successfully.
|
||||
</p>
|
||||
</dd>
|
||||
<dt class="hdlist1">
|
||||
--position
|
||||
</dt>
|
||||
<dd>
|
||||
<p>
|
||||
Extract the Chrome commit position from the footers. This first attempts
|
||||
to get the value of the <code>Cr-Commit-Position</code> footer. If that doesn’t exist
|
||||
then it tries a heuristic based on <code>Git-Svn-Id</code>. Output is in one of the
|
||||
following forms:
|
||||
</p>
|
||||
<div class="literalblock">
|
||||
<div class="content">
|
||||
<pre><code>refs/heads/master@{#292272}
|
||||
refs/branch-heads/branchname</code></pre>
|
||||
</div></div>
|
||||
</dd>
|
||||
<dt class="hdlist1">
|
||||
--position-num
|
||||
</dt>
|
||||
<dd>
|
||||
<p>
|
||||
Extracts and prints the Chrome commit position number only (292272 in the
|
||||
example above). Exits with an error if one cannot be found.
|
||||
</p>
|
||||
</dd>
|
||||
<dt class="hdlist1">
|
||||
--position-ref
|
||||
</dt>
|
||||
<dd>
|
||||
<p>
|
||||
Extracts and prints the Chrome commit position ref name only
|
||||
(<code>ref/heads/master</code> or <code>refs/branch-heads/branchname</code> in the example above).
|
||||
</p>
|
||||
</dd>
|
||||
</dl></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect1">
|
||||
<h2 id="_example">EXAMPLE</h2>
|
||||
<div class="sectionbody">
|
||||
<div class="paragraph"><p></p></div><div class="listingblock"><div class="content"><pre><code><span style="font-weight: bold; color: #ffffff">$ git footers HEAD</span>
|
||||
Tech-Debt-Introduced: -4 microMSOffices
|
||||
Tech-Debt-Introduced: 17 microMSOffices
|
||||
Cr-Commit-Position: refs/heads/master@{#292272}
|
||||
<span style="font-weight: bold; color: #ffffff">$ git footers --key Tech-Debt-Introduced HEAD</span>
|
||||
-4 microMSOffices
|
||||
17 microMSOffices
|
||||
<span style="font-weight: bold; color: #ffffff">$ git footers --position HEAD</span>
|
||||
refs/heads/master@{#292272}
|
||||
<span style="font-weight: bold; color: #ffffff">$ git footers --position-num HEAD</span>
|
||||
292272
|
||||
<span style="font-weight: bold; color: #ffffff">$ git footers --position-ref HEAD</span>
|
||||
refs/heads/master
|
||||
</code></pre></div></div><p><div class="paragraph"></p></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect1">
|
||||
<h2 id="_see_also">SEE ALSO</h2>
|
||||
<div class="sectionbody">
|
||||
<div class="paragraph"><p><a href="git-number.html">git-number(1)</a></p></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect1">
|
||||
<h2 id="_chromium_depot_tools">CHROMIUM DEPOT_TOOLS</h2>
|
||||
<div class="sectionbody">
|
||||
<div class="paragraph"><p>Part of the chromium <a href="depot_tools.html">depot_tools(7)</a> suite. These tools are meant to
|
||||
assist with the development of chromium and related projects. Download the tools
|
||||
from <a href="https://chromium.googlesource.com/chromium/tools/depot_tools.git">here</a>.</p></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="footnotes"><hr /></div>
|
||||
<div id="footer">
|
||||
<div id="footer-text">
|
||||
Last updated 2014-09-02 16:59:41 PDT
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,144 @@
|
||||
'\" t
|
||||
.\" Title: git-freeze
|
||||
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
|
||||
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
|
||||
.\" Date: 09/02/2014
|
||||
.\" Manual: Chromium depot_tools Manual
|
||||
.\" Source: depot_tools c9f28eb
|
||||
.\" Language: English
|
||||
.\"
|
||||
.TH "GIT\-FREEZE" "1" "09/02/2014" "depot_tools c9f28eb" "Chromium depot_tools Manual"
|
||||
.\" -----------------------------------------------------------------
|
||||
.\" * Define some portability stuff
|
||||
.\" -----------------------------------------------------------------
|
||||
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
.\" http://bugs.debian.org/507673
|
||||
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
||||
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
.ie \n(.g .ds Aq \(aq
|
||||
.el .ds Aq '
|
||||
.\" -----------------------------------------------------------------
|
||||
.\" * set default formatting
|
||||
.\" -----------------------------------------------------------------
|
||||
.\" disable hyphenation
|
||||
.nh
|
||||
.\" disable justification (adjust text to left margin only)
|
||||
.ad l
|
||||
.\" -----------------------------------------------------------------
|
||||
.\" * MAIN CONTENT STARTS HERE *
|
||||
.\" -----------------------------------------------------------------
|
||||
.SH "NAME"
|
||||
git-footers \- Extract meta\-information expressed as footers in a commit message\&.
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
.nf
|
||||
\fIgit footers\fR [\-\-key FOOTER] REF
|
||||
\fIgit footers\fR [\-\-position | \-\-position\-ref | \-\-position\-num] REF
|
||||
.fi
|
||||
.sp
|
||||
.SH "DESCRIPTION"
|
||||
.sp
|
||||
git footers extracts information included in commit messages as "footers", which are roughly like HTTP headers except they are at the end\&. For example, a commit might look like:
|
||||
.sp
|
||||
.if n \{\
|
||||
.RS 4
|
||||
.\}
|
||||
.nf
|
||||
This is a fancy commit message\&.
|
||||
.fi
|
||||
.if n \{\
|
||||
.RE
|
||||
.\}
|
||||
.sp
|
||||
.if n \{\
|
||||
.RS 4
|
||||
.\}
|
||||
.nf
|
||||
Cr\-Commit\-Position: refs/heads/master@{#292272}
|
||||
Tech\-Debt\-Introduced: 17 nanoMSOffices
|
||||
.fi
|
||||
.if n \{\
|
||||
.RE
|
||||
.\}
|
||||
.sp
|
||||
git footers knows how to extract this information\&.
|
||||
.sp
|
||||
Footers are order\-independent and can appear more than once\&. Thus they are treated as a multimap\&.
|
||||
.SH "OPTIONS"
|
||||
.sp
|
||||
If no options are given, all footers are printed, with their names case\-normalized\&.
|
||||
.PP
|
||||
\-\-key FOOTER
|
||||
.RS 4
|
||||
Extract all the headers associated with the given key, and print one per line\&. If there are no footers with this key, produces no output and exits successfully\&.
|
||||
.RE
|
||||
.PP
|
||||
\-\-position
|
||||
.RS 4
|
||||
Extract the Chrome commit position from the footers\&. This first attempts to get the value of the
|
||||
Cr\-Commit\-Position
|
||||
footer\&. If that doesn\(cqt exist then it tries a heuristic based on
|
||||
Git\-Svn\-Id\&. Output is in one of the following forms:
|
||||
.sp
|
||||
.if n \{\
|
||||
.RS 4
|
||||
.\}
|
||||
.nf
|
||||
refs/heads/master@{#292272}
|
||||
refs/branch\-heads/branchname
|
||||
.fi
|
||||
.if n \{\
|
||||
.RE
|
||||
.\}
|
||||
.RE
|
||||
.PP
|
||||
\-\-position\-num
|
||||
.RS 4
|
||||
Extracts and prints the Chrome commit position number only (292272 in the example above)\&. Exits with an error if one cannot be found\&.
|
||||
.RE
|
||||
.PP
|
||||
\-\-position\-ref
|
||||
.RS 4
|
||||
Extracts and prints the Chrome commit position ref name only (ref/heads/master
|
||||
or
|
||||
refs/branch\-heads/branchname
|
||||
in the example above)\&.
|
||||
.RE
|
||||
.SH "EXAMPLE"
|
||||
.sp
|
||||
|
||||
.sp
|
||||
.if n \{\
|
||||
.RS 4
|
||||
.\}
|
||||
.nf
|
||||
\fB$ git footers HEAD\fR
|
||||
Tech\-Debt\-Introduced: \-4 microMSOffices
|
||||
Tech\-Debt\-Introduced: 17 microMSOffices
|
||||
Cr\-Commit\-Position: refs/heads/master@{#292272}
|
||||
\fB$ git footers \-\-key Tech\-Debt\-Introduced HEAD\fR
|
||||
\-4 microMSOffices
|
||||
17 microMSOffices
|
||||
\fB$ git footers \-\-position HEAD\fR
|
||||
refs/heads/master@{#292272}
|
||||
\fB$ git footers \-\-position\-num HEAD\fR
|
||||
292272
|
||||
\fB$ git footers \-\-position\-ref HEAD\fR
|
||||
refs/heads/master
|
||||
.fi
|
||||
.if n \{\
|
||||
.RE
|
||||
.\}
|
||||
.sp
|
||||
.SH "SEE ALSO"
|
||||
.sp
|
||||
\fBgit-number\fR(1)
|
||||
.SH "CHROMIUM DEPOT_TOOLS"
|
||||
.sp
|
||||
Part of the chromium \fBdepot_tools\fR(7) suite\&. These tools are meant to assist with the development of chromium and related projects\&. Download the tools from \m[blue]\fBhere\fR\m[]\&\s-2\u[1]\d\s+2\&.
|
||||
.SH "NOTES"
|
||||
.IP " 1." 4
|
||||
here
|
||||
.RS 4
|
||||
\%https://chromium.googlesource.com/chromium/tools/depot_tools.git
|
||||
.RE
|
||||
@ -0,0 +1 @@
|
||||
Extract meta-information expressed as footers in a commit message.
|
||||
@ -0,0 +1,17 @@
|
||||
#!/usr/bin/env bash
|
||||
. demo_repo.sh
|
||||
|
||||
add deleted_file
|
||||
add unstaged_deleted_file
|
||||
add modified_file
|
||||
c 'I commited this and am proud of it.
|
||||
|
||||
Cr-Commit-Position: refs/heads/master@{#292272}
|
||||
Tech-Debt-Introduced: 17 microMSOffices
|
||||
Tech-Debt-Introduced: -4 microMSOffices'
|
||||
|
||||
run git footers HEAD
|
||||
run git footers --key Tech-Debt-Introduced HEAD
|
||||
run git footers --position HEAD
|
||||
run git footers --position-num HEAD
|
||||
run git footers --position-ref HEAD
|
||||
@ -0,0 +1,71 @@
|
||||
git-freeze(1)
|
||||
=============
|
||||
|
||||
NAME
|
||||
----
|
||||
git-footers -
|
||||
include::_git-footers_desc.helper.txt[]
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
[verse]
|
||||
'git footers' [--key FOOTER] REF
|
||||
'git footers' [--position | --position-ref | --position-num] REF
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
|
||||
`git footers` extracts information included in commit messages as "footers",
|
||||
which are roughly like HTTP headers except they are at the end. For example, a
|
||||
commit might look like:
|
||||
|
||||
This is a fancy commit message.
|
||||
|
||||
Cr-Commit-Position: refs/heads/master@{#292272}
|
||||
Tech-Debt-Introduced: 17 nanoMSOffices
|
||||
|
||||
`git footers` knows how to extract this information.
|
||||
|
||||
Footers are order-independent and can appear more than once. Thus they are
|
||||
treated as a multimap.
|
||||
|
||||
OPTIONS
|
||||
-------
|
||||
|
||||
If no options are given, all footers are printed, with their names
|
||||
case-normalized.
|
||||
|
||||
--key FOOTER::
|
||||
Extract all the headers associated with the given key, and print one per
|
||||
line. If there are no footers with this key, produces no output and exits
|
||||
successfully.
|
||||
|
||||
--position::
|
||||
Extract the Chrome commit position from the footers. This first attempts
|
||||
to get the value of the `Cr-Commit-Position` footer. If that doesn't exist
|
||||
then it tries a heuristic based on `Git-Svn-Id`. Output is in one of the
|
||||
following forms:
|
||||
|
||||
refs/heads/master@{#292272}
|
||||
refs/branch-heads/branchname
|
||||
|
||||
--position-num::
|
||||
Extracts and prints the Chrome commit position number only (292272 in the
|
||||
example above). Exits with an error if one cannot be found.
|
||||
|
||||
--position-ref::
|
||||
Extracts and prints the Chrome commit position ref name only
|
||||
(`ref/heads/master` or `refs/branch-heads/branchname` in the example above).
|
||||
|
||||
|
||||
EXAMPLE
|
||||
-------
|
||||
demo:1[]
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
linkgit:git-number[1]
|
||||
|
||||
include::_footer.txt[]
|
||||
|
||||
// vim: ft=asciidoc:
|
||||
@ -0,0 +1,70 @@
|
||||
#!/usr/bin/env python
|
||||
|
||||
"""Tests for git_footers."""
|
||||
|
||||
import os
|
||||
import sys
|
||||
import unittest
|
||||
|
||||
sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
|
||||
|
||||
import git_footers
|
||||
|
||||
class GitFootersTest(unittest.TestCase):
|
||||
_message = """
|
||||
This is my commit message. There are many like it, but this one is mine.
|
||||
|
||||
My commit message is my best friend. It is my life. I must master it.
|
||||
|
||||
"""
|
||||
|
||||
_position = 'refs/heads/master@{#292272}'
|
||||
|
||||
_position_footer = 'Cr-Commit-Position: %s\n' % _position
|
||||
|
||||
_git_svn_id = ('svn://svn.chromium.org/chrome/trunk/src@290386'
|
||||
' 0039d316-1c4b-4281-b951-d872f2087c98')
|
||||
|
||||
_git_svn_id_footer = 'git-svn-id: %s\n' % _git_svn_id
|
||||
|
||||
_git_svn_id_branch = (
|
||||
'svn://svn.chromium.org/chrome/branches/blabble/src@177288')
|
||||
|
||||
_git_svn_id_footer_branch = 'git-svn-id: %s\n' % _git_svn_id_branch
|
||||
|
||||
|
||||
def testFootersBasic(self):
|
||||
self.assertEqual(
|
||||
git_footers.parse_footers(self._message), {})
|
||||
self.assertEqual(
|
||||
git_footers.parse_footers(self._message + self._position_footer),
|
||||
{ 'Cr-Commit-Position': [ self._position ] })
|
||||
self.assertEqual(
|
||||
git_footers.parse_footers(self._message + self._git_svn_id_footer),
|
||||
{ 'Git-Svn-Id': [ self._git_svn_id ] })
|
||||
self.assertEqual(
|
||||
git_footers.parse_footers(self._message + self._position_footer
|
||||
+ self._position_footer),
|
||||
{ 'Cr-Commit-Position': [ self._position, self._position ] })
|
||||
|
||||
def testTrunkHeuristic(self):
|
||||
footers = git_footers.parse_footers(self._message + self._git_svn_id_footer)
|
||||
self.assertEqual(
|
||||
footers,
|
||||
{ 'Git-Svn-Id': [ self._git_svn_id ] })
|
||||
self.assertEqual(
|
||||
git_footers.get_position(footers),
|
||||
('refs/heads/master', '290386'))
|
||||
|
||||
def testBranchHeuristic(self):
|
||||
footers = git_footers.parse_footers(self._message +
|
||||
self._git_svn_id_footer_branch)
|
||||
self.assertEqual(
|
||||
footers,
|
||||
{ 'Git-Svn-Id': [ self._git_svn_id_branch ] })
|
||||
self.assertEqual(
|
||||
git_footers.get_position(footers),
|
||||
('refs/branch-heads/blabble', None))
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main()
|
||||
Loading…
Reference in New Issue