-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathpatching.html
More file actions
267 lines (241 loc) · 16.2 KB
/
patching.html
File metadata and controls
267 lines (241 loc) · 16.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Making a patch — Matplotlib 2.0.0 documentation</title>
<link rel="stylesheet" href="../../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css"
type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '2.0.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 2.0.0 documentation"
href="../../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
<link rel="index" title="Index" href="../../genindex.html"
/>
<link rel="search" title="Search" href="../../search.html"
/>
<link rel="top" title="Matplotlib 2.0.0 documentation" href="../../index.html" />
<link rel="up" title="Working with matplotlib source code" href="index.html" />
<link rel="next" title="Reviewers guideline" href="../coding_guide.html" />
<link rel="prev" title="git resources" href="git_resources.html" />
<link rel="canonical" href="https://matplotlib.org/stable/devel/gitwash/patching.html" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head>
<body>
<div id="unreleased-message"> You are reading an old version of the documentation (v2.0.0). For the latest version see <a href="https://matplotlib.org/stable/devel/gitwash/patching.html">https://matplotlib.org/stable/devel/gitwash/patching.html</a></div>
<!-- The "Fork me on github" ribbon -->
<img style="float: right; margin-bottom: -40px; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" usemap="#ribbonmap"/>
<map name="ribbonmap">
<area shape="poly" coords="15,0,148,-1,148,135" href="https://github.com/matplotlib/matplotlib" title="Fork me on GitHub" />
</map>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="../../index.html"><img src="../../_static/logo2.svg" width="540px" border="0" alt="matplotlib"/></a>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="../coding_guide.html" title="Reviewers guideline"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="git_resources.html" title="git resources"
accesskey="P">previous</a> |</li>
<li><a href="../../index.html">home</a>| </li>
<li><a href="../../examples/index.html">examples</a>| </li>
<li><a href="../../gallery.html">gallery</a>| </li>
<li><a href="../../api/pyplot_summary.html">pyplot</a>| </li>
<li><a href="../../contents.html">docs</a> »</li>
<li><a href="../index.html" >The Matplotlib Developers’ Guide</a> »</li>
<li><a href="index.html" accesskey="U">Working with <em>matplotlib</em> source code</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<a href="http://depsy.org/package/python/matplotlib">
<img src="http://depsy.org/api/package/pypi/matplotlib/badge.svg">
</a>
<br/>
Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">
<img src="https://travis-ci.org/matplotlib/matplotlib.svg?branch=master"/>
</a>
<br/>
<h3><a href="../../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Making a patch</a><ul>
<li><a class="reference internal" href="#making-patches">Making patches</a><ul>
<li><a class="reference internal" href="#overview">Overview</a></li>
<li><a class="reference internal" href="#in-detail">In detail</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../contents.html">Documentation overview</a><ul>
<li><a href="../index.html">The Matplotlib Developers’ Guide</a><ul>
<li><a href="index.html">Working with <em>matplotlib</em> source code</a><ul>
<li>Previous: <a href="git_resources.html" title="previous chapter">git resources</a></li>
<li>Next: <a href="../coding_guide.html" title="next chapter">Reviewers guideline</a></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/devel/gitwash/patching.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="making-a-patch">
<h1>Making a patch<a class="headerlink" href="#making-a-patch" title="Permalink to this headline">¶</a></h1>
<div class="section" id="making-patches">
<span id="id1"></span><h2>Making patches<a class="headerlink" href="#making-patches" title="Permalink to this headline">¶</a></h2>
<div class="section" id="overview">
<h3>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h3>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># tell git who you are</span>
<span class="n">git</span> <span class="n">config</span> <span class="o">--</span><span class="k">global</span> <span class="n">user</span><span class="o">.</span><span class="n">email</span> <span class="n">you</span><span class="nd">@yourdomain</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span>
<span class="n">git</span> <span class="n">config</span> <span class="o">--</span><span class="k">global</span> <span class="n">user</span><span class="o">.</span><span class="n">name</span> <span class="s2">"Your Name Comes Here"</span>
<span class="c1"># get the repository if you don't have it</span>
<span class="n">git</span> <span class="n">clone</span> <span class="n">git</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">matplotlib</span><span class="o">/</span><span class="n">matplotlib</span><span class="o">.</span><span class="n">git</span>
<span class="c1"># make a branch for your patching</span>
<span class="n">cd</span> <span class="n">matplotlib</span>
<span class="n">git</span> <span class="n">branch</span> <span class="n">the</span><span class="o">-</span><span class="n">fix</span><span class="o">-</span><span class="n">im</span><span class="o">-</span><span class="n">thinking</span><span class="o">-</span><span class="n">of</span>
<span class="n">git</span> <span class="n">checkout</span> <span class="n">the</span><span class="o">-</span><span class="n">fix</span><span class="o">-</span><span class="n">im</span><span class="o">-</span><span class="n">thinking</span><span class="o">-</span><span class="n">of</span>
<span class="c1"># hack, hack, hack</span>
<span class="c1"># Tell git about any new files you've made</span>
<span class="n">git</span> <span class="n">add</span> <span class="n">somewhere</span><span class="o">/</span><span class="n">tests</span><span class="o">/</span><span class="n">test_my_bug</span><span class="o">.</span><span class="n">py</span>
<span class="c1"># commit work in progress as you go</span>
<span class="n">git</span> <span class="n">commit</span> <span class="o">-</span><span class="n">am</span> <span class="s1">'BF - added tests for Funny bug'</span>
<span class="c1"># hack hack, hack</span>
<span class="n">git</span> <span class="n">commit</span> <span class="o">-</span><span class="n">am</span> <span class="s1">'BF - added fix for Funny bug'</span>
<span class="c1"># make the patch files</span>
<span class="n">git</span> <span class="nb">format</span><span class="o">-</span><span class="n">patch</span> <span class="o">-</span><span class="n">M</span> <span class="o">-</span><span class="n">C</span> <span class="n">master</span>
</pre></div>
</div>
<p>Then, send the generated patch files to the <a class="reference external" href="https://mail.python.org/mailman/listinfo/matplotlib-devel">matplotlib
mailing list</a> — where we will thank you warmly.</p>
</div>
<div class="section" id="in-detail">
<h3>In detail<a class="headerlink" href="#in-detail" title="Permalink to this headline">¶</a></h3>
<ol class="arabic">
<li><p class="first">Tell <a class="reference external" href="https://git-scm.com/">git</a> who you are so it can label the commits you’ve
made:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">config</span> <span class="o">--</span><span class="k">global</span> <span class="n">user</span><span class="o">.</span><span class="n">email</span> <span class="n">you</span><span class="nd">@yourdomain</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span>
<span class="n">git</span> <span class="n">config</span> <span class="o">--</span><span class="k">global</span> <span class="n">user</span><span class="o">.</span><span class="n">name</span> <span class="s2">"Your Name Comes Here"</span>
</pre></div>
</div>
</li>
<li><p class="first">If you don’t already have one, clone a copy of the
<a class="reference external" href="http://matplotlib.org">matplotlib</a> repository:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">git</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">matplotlib</span><span class="o">/</span><span class="n">matplotlib</span><span class="o">.</span><span class="n">git</span>
<span class="n">cd</span> <span class="n">matplotlib</span>
</pre></div>
</div>
</li>
<li><p class="first">Make a ‘feature branch’. This will be where you work on
your bug fix. It’s nice and safe and leaves you with
access to an unmodified copy of the code in the main
branch:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">branch</span> <span class="n">the</span><span class="o">-</span><span class="n">fix</span><span class="o">-</span><span class="n">im</span><span class="o">-</span><span class="n">thinking</span><span class="o">-</span><span class="n">of</span>
<span class="n">git</span> <span class="n">checkout</span> <span class="n">the</span><span class="o">-</span><span class="n">fix</span><span class="o">-</span><span class="n">im</span><span class="o">-</span><span class="n">thinking</span><span class="o">-</span><span class="n">of</span>
</pre></div>
</div>
</li>
<li><p class="first">Do some edits, and commit them as you go:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># hack, hack, hack</span>
<span class="c1"># Tell git about any new files you've made</span>
<span class="n">git</span> <span class="n">add</span> <span class="n">somewhere</span><span class="o">/</span><span class="n">tests</span><span class="o">/</span><span class="n">test_my_bug</span><span class="o">.</span><span class="n">py</span>
<span class="c1"># commit work in progress as you go</span>
<span class="n">git</span> <span class="n">commit</span> <span class="o">-</span><span class="n">am</span> <span class="s1">'BF - added tests for Funny bug'</span>
<span class="c1"># hack hack, hack</span>
<span class="n">git</span> <span class="n">commit</span> <span class="o">-</span><span class="n">am</span> <span class="s1">'BF - added fix for Funny bug'</span>
</pre></div>
</div>
<p>Note the <code class="docutils literal"><span class="pre">-am</span></code> options to <code class="docutils literal"><span class="pre">commit</span></code>. The <code class="docutils literal"><span class="pre">m</span></code> flag just
signals that you’re going to type a message on the command
line. The <code class="docutils literal"><span class="pre">a</span></code> flag — you can just take on faith —
or see <a class="reference external" href="http://gitready.com/beginner/2009/01/18/the-staging-area.html">why the -a flag?</a>.</p>
</li>
<li><p class="first">When you have finished, check you have committed all your
changes:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">status</span>
</pre></div>
</div>
</li>
<li><p class="first">Finally, make your commits into patches. You want all the
commits since you branched from the <code class="docutils literal"><span class="pre">master</span></code> branch:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="nb">format</span><span class="o">-</span><span class="n">patch</span> <span class="o">-</span><span class="n">M</span> <span class="o">-</span><span class="n">C</span> <span class="n">master</span>
</pre></div>
</div>
<p>You will now have several files named for the commits:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mi">0001</span><span class="o">-</span><span class="n">BF</span><span class="o">-</span><span class="n">added</span><span class="o">-</span><span class="n">tests</span><span class="o">-</span><span class="k">for</span><span class="o">-</span><span class="n">Funny</span><span class="o">-</span><span class="n">bug</span><span class="o">.</span><span class="n">patch</span>
<span class="mi">0002</span><span class="o">-</span><span class="n">BF</span><span class="o">-</span><span class="n">added</span><span class="o">-</span><span class="n">fix</span><span class="o">-</span><span class="k">for</span><span class="o">-</span><span class="n">Funny</span><span class="o">-</span><span class="n">bug</span><span class="o">.</span><span class="n">patch</span>
</pre></div>
</div>
<p>Send these files to the <a class="reference external" href="https://mail.python.org/mailman/listinfo/matplotlib-devel">matplotlib mailing list</a>.</p>
</li>
</ol>
<p>When you are done, to switch back to the main copy of the
code, just return to the <code class="docutils literal"><span class="pre">master</span></code> branch:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">checkout</span> <span class="n">master</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2016 The Matplotlib development team.
Last updated on Feb 20, 2017.
Created using <a
href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
</div>
</body>
<footer>
</footer>
</html>