Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(2)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: man/html/git-footers.html

Issue 521033002: Added git footers tool to parse conventional metadata from git commits (Closed) Base URL: https://chromium.googlesource.com/chromium/tools/depot_tools.git@master
Patch Set: Review comments Created 6 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « git_footers.py ('k') | man/man1/git-footers.1 » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> 2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> 3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4 <head> 4 <head>
5 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" / > 5 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" / >
6 <meta name="generator" content="AsciiDoc 8.6.9" /> 6 <meta name="generator" content="AsciiDoc 8.6.9" />
7 <title>git-map-branches(1)</title> 7 <title>git-freeze(1)</title>
8 <style type="text/css"> 8 <style type="text/css">
9 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */ 9 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
10 10
11 /* Default font. */ 11 /* Default font. */
12 body { 12 body {
13 font-family: Georgia,serif; 13 font-family: Georgia,serif;
14 } 14 }
15 15
16 /* Title font. */ 16 /* Title font. */
17 h1, h2, h3, h4, h5, h6, 17 h1, h2, h3, h4, h5, h6,
(...skipping 716 matching lines...) Expand 10 before | Expand all | Expand 10 after
734 } 734 }
735 735
736 } 736 }
737 asciidoc.install(); 737 asciidoc.install();
738 /*]]>*/ 738 /*]]>*/
739 </script> 739 </script>
740 </head> 740 </head>
741 <body class="manpage"> 741 <body class="manpage">
742 <div id="header"> 742 <div id="header">
743 <h1> 743 <h1>
744 git-map-branches(1) Manual Page 744 git-freeze(1) Manual Page
745 </h1> 745 </h1>
746 <h2>NAME</h2> 746 <h2>NAME</h2>
747 <div class="sectionbody"> 747 <div class="sectionbody">
748 <p>git-map-branches - 748 <p>git-footers -
749 Helper script to display all local git branches with ‘upstream’ hierarchy in colorized terminal format. 749 Extract meta-information expressed as footers in a commit message.
750 </p> 750 </p>
751 </div> 751 </div>
752 </div> 752 </div>
753 <div id="content"> 753 <div id="content">
754 <div class="sect1"> 754 <div class="sect1">
755 <h2 id="_synopsis">SYNOPSIS</h2> 755 <h2 id="_synopsis">SYNOPSIS</h2>
756 <div class="sectionbody"> 756 <div class="sectionbody">
757 <div class="verseblock"> 757 <div class="verseblock">
758 <pre class="content"><em>git map-branches</em></pre> 758 <pre class="content"><em>git footers</em> [--key FOOTER] REF
759 <em>git footers</em> [--position | --position-ref | --position-num] REF</pre>
759 <div class="attribution"> 760 <div class="attribution">
760 </div></div> 761 </div></div>
761 </div> 762 </div>
762 </div> 763 </div>
763 <div class="sect1"> 764 <div class="sect1">
764 <h2 id="_description">DESCRIPTION</h2> 765 <h2 id="_description">DESCRIPTION</h2>
765 <div class="sectionbody"> 766 <div class="sectionbody">
766 <div class="paragraph"><p>Git map-branches displays all local branches such that :</p></div> 767 <div class="paragraph"><p><code>git footers</code> extracts information included in commit messages as "footers",
767 <div class="ulist"><ul> 768 which are roughly like HTTP headers except they are at the end. For example, a
768 <li> 769 commit might look like:</p></div>
770 <div class="literalblock">
771 <div class="content">
772 <pre><code>This is a fancy commit message.</code></pre>
773 </div></div>
774 <div class="literalblock">
775 <div class="content">
776 <pre><code>Cr-Commit-Position: refs/heads/master@{#292272}
777 Tech-Debt-Introduced: 17 nanoMSOffices</code></pre>
778 </div></div>
779 <div class="paragraph"><p><code>git footers</code> knows how to extract this inf ormation.</p></div>
780 <div class="paragraph"><p>Footers are order-independent and can appear more than once. Thus they are
781 treated as a multimap.</p></div>
782 </div>
783 </div>
784 <div class="sect1">
785 <h2 id="_options">OPTIONS</h2>
786 <div class="sectionbody">
787 <div class="paragraph"><p>If no options are given, all footers are printed, with their names
788 case-normalized.</p></div>
789 <div class="dlist"><dl>
790 <dt class="hdlist1">
791 --key FOOTER
792 </dt>
793 <dd>
769 <p> 794 <p>
770 Current branch is <span class="aqua">cyan</span>. 795 Extract all the headers associated with the given key, and print one per
796 line. If there are no footers with this key, produces no output and exits
797 successfully.
771 </p> 798 </p>
772 <div class="ulist"><ul> 799 </dd>
773 <li> 800 <dt class="hdlist1">
801 --position
802 </dt>
803 <dd>
774 <p> 804 <p>
775 The branch which will be modified with git-commit is denoted with an asterisk 805 Extract the Chrome commit position from the footers. This first attempts
776 (<code>*</code>) after the name. 806 to get the value of the <code>Cr-Commit-Position</code> footer. If that doesn &#8217;t exist
807 then it tries a heuristic based on <code>Git-Svn-Id</code>. Output is in one of the
808 following forms:
777 </p> 809 </p>
778 </li> 810 <div class="literalblock">
779 </ul></div> 811 <div class="content">
780 </li> 812 <pre><code>refs/heads/master@{#292272}
781 <li> 813 refs/branch-heads/branchname</code></pre>
814 </div></div>
815 </dd>
816 <dt class="hdlist1">
817 --position-num
818 </dt>
819 <dd>
782 <p> 820 <p>
783 Local branches are <span class="green">green</span>. 821 Extracts and prints the Chrome commit position number only (292272 in the
822 example above). Exits with an error if one cannot be found.
784 </p> 823 </p>
785 </li> 824 </dd>
786 <li> 825 <dt class="hdlist1">
826 --position-ref
827 </dt>
828 <dd>
787 <p> 829 <p>
788 Remote branches are <span class="red">red</span> (usually, the root of all other branches). 830 Extracts and prints the Chrome commit position ref name only
831 (<code>ref/heads/master</code> or <code>refs/branch-heads/branchname</code> in the example above).
789 </p> 832 </p>
790 </li> 833 </dd>
791 <li> 834 </dl></div>
792 <p>
793 <code>{NO UPSTREAM}</code> is a special placeholder in <span class="fuchsia">mag enta</span>.
794 </p>
795 <div class="ulist"><ul>
796 <li>
797 <p>
798 Branches which have this as their parent are usually misconfigured, and
799 should be assigned a parent by checking out the branch and running git branch
800 --set-upstream-to=&lt;correct parent branch&gt;.
801 </p>
802 </li>
803 </ul></div>
804 </li>
805 </ul></div>
806 <div class="admonitionblock">
807 <table><tr>
808 <td class="icon">
809 <div class="title">Note</div>
810 </td>
811 <td class="content">If multiple branches are on the same commit, they will all b e cyan.</td>
812 </tr></table>
813 </div>
814 </div> 835 </div>
815 </div> 836 </div>
816 <div class="sect1"> 837 <div class="sect1">
817 <h2 id="_example">EXAMPLE</h2> 838 <h2 id="_example">EXAMPLE</h2>
818 <div class="sectionbody"> 839 <div class="sectionbody">
819 <div class="paragraph"><p>Given the hypothetical demo repo in <a href="git-map.h tml">git-map(1)</a>'s EXAMPLE section, and 840 <div class="paragraph"><p></p></div><div class="listingblock"><div class="conten t"><pre><code><span style="font-weight: bold; color: #ffffff">$ git footers HEAD </span>
820 assuming that the <code>frozen_changes</code> branch was currently checked out, running 841 Tech-Debt-Introduced: -4 microMSOffices
821 <em>git map-branches</em> would result in an output like:</p></div> 842 Tech-Debt-Introduced: 17 microMSOffices
822 <div class="paragraph"><p></p></div><div class="listingblock"><div class="conten t"><pre><code><span style="font-weight: bold; color: #ffffff">$ git map-branches </span> 843 Cr-Commit-Position: refs/heads/master@{#292272}
823 <span style="color: #e42e16"></span><span style="color: #e42e16">origin/master 844 <span style="font-weight: bold; color: #ffffff">$ git footers --key Tech-Debt-In troduced HEAD</span>
824 </span><span style="color: #19c518"></span><span style="color: #19c518"> cool_f eature 845 -4 microMSOffices
825 </span><span style="color: #19c518"></span><span style="color: #19c518"> subf eature 846 17 microMSOffices
826 </span><span style="color: #19c518"></span><span style="color: #19c518"> fixit 847 <span style="font-weight: bold; color: #ffffff">$ git footers --position HEAD</s pan>
827 </span><span style="color: #33d6e5"></span><span style="font-weight: bold; color : #33d6e5"> frozen_branch * 848 refs/heads/master@{#292272}
828 </span><span style="font-weight: bold; color: #d338d3"></span><span style="color : #d338d3">{NO UPSTREAM} 849 <span style="font-weight: bold; color: #ffffff">$ git footers --position-num HEA D</span>
829 </span><span style="color: #19c518"></span><span style="color: #19c518"> no_ups tream</span> 850 292272
851 <span style="font-weight: bold; color: #ffffff">$ git footers --position-ref HEA D</span>
852 refs/heads/master
830 </code></pre></div></div><p><div class="paragraph"></p></div> 853 </code></pre></div></div><p><div class="paragraph"></p></div>
831 </div> 854 </div>
832 </div> 855 </div>
833 <div class="sect1"> 856 <div class="sect1">
834 <h2 id="_suggested_aliases">SUGGESTED ALIASES</h2>
835 <div class="sectionbody">
836 <div class="paragraph"><p>Some common short-hand aliases. Feel free to add these to your <em>~/.gitconfig</em>
837 file.</p></div>
838 <div class="listingblock">
839 <div class="content">
840 <pre><code>[alias]
841 git bmap = map-branches</code></pre>
842 </div></div>
843 </div>
844 </div>
845 <div class="sect1">
846 <h2 id="_see_also">SEE ALSO</h2> 857 <h2 id="_see_also">SEE ALSO</h2>
847 <div class="sectionbody"> 858 <div class="sectionbody">
848 <div class="paragraph"><p><a href="git-map.html">git-map(1)</a></p></div> 859 <div class="paragraph"><p><a href="git-number.html">git-number(1)</a></p></div>
849 </div> 860 </div>
850 </div> 861 </div>
851 <div class="sect1"> 862 <div class="sect1">
852 <h2 id="_chromium_depot_tools">CHROMIUM DEPOT_TOOLS</h2> 863 <h2 id="_chromium_depot_tools">CHROMIUM DEPOT_TOOLS</h2>
853 <div class="sectionbody"> 864 <div class="sectionbody">
854 <div class="paragraph"><p>Part of the chromium <a href="depot_tools.html">depot_ tools(7)</a> suite. These tools are meant to 865 <div class="paragraph"><p>Part of the chromium <a href="depot_tools.html">depot_ tools(7)</a> suite. These tools are meant to
855 assist with the development of chromium and related projects. Download the tools 866 assist with the development of chromium and related projects. Download the tools
856 from <a href="https://chromium.googlesource.com/chromium/tools/depot_tools.git"> here</a>.</p></div> 867 from <a href="https://chromium.googlesource.com/chromium/tools/depot_tools.git"> here</a>.</p></div>
857 </div> 868 </div>
858 </div> 869 </div>
859 </div> 870 </div>
860 <div id="footnotes"><hr /></div> 871 <div id="footnotes"><hr /></div>
861 <div id="footer"> 872 <div id="footer">
862 <div id="footer-text"> 873 <div id="footer-text">
863 Last updated 2014-04-10 14:23:11 PDT 874 Last updated 2014-09-02 16:59:41 PDT
864 </div> 875 </div>
865 </div> 876 </div>
866 </body> 877 </body>
867 </html> 878 </html>
OLDNEW
« no previous file with comments | « git_footers.py ('k') | man/man1/git-footers.1 » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698