matplotlib.github.com/1.2.1/devel/gitwash/patching.html at main · matplotlib/matplotlib.github.com · GitHub

History

303 lines (286 loc) · 14.5 KB

Raw

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

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>Making a patch — Matplotlib 1.2.1 documentation</title>

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../../',

VERSION: '1.2.1',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true

};

</script>

title="Search within Matplotlib 1.2.1 documentation"

href="../../_static/opensearch.xml"/>

</head>

<body>

<div id="unreleased-message"> You are reading an old version of the documentation (v1.2.1). 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>

if ("matplotlib.sourceforge.net" == document.location.hostname ||

"matplotlib.sf.net" == document.location.hostname) {

var pkBaseURL = (("https:" == document.location.protocol) ? "https://apps.sourceforge.net/piwik/matplotlib/" : "http://apps.sourceforge.net/piwik/matplotlib/");

document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));

}

</script>

if ("matplotlib.sourceforge.net" == document.location.hostname ||

"matplotlib.sf.net" == document.location.hostname) {

piwik_action_name = '';

piwik_idsite = 1;

piwik_url = pkBaseURL + "piwik.php";

piwik_log(piwik_action_name, piwik_idsite, piwik_url);

document.write(unescape('%3Cobject%3E%3Cnoscript%3E%3Cp%3E%3Cimg src="http://apps.sourceforge.net/piwik/matplotlib/piwik.php?idsite=1" alt="piwik"/%3E%3C/p%3E%3C/noscript%3E%3C/object%3E'));

}

</script>

</map>

</div>

<h3>Navigation</h3>

<ul>

<a href="../../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<a href="git_development.html" title="Git for development"

accesskey="N">next</a> |</li>

<a href="following_latest.html" title="Following the latest source"

accesskey="P">previous</a> |</li>

<li><a href="http://www.matplotlib.org/downloads.html">downloads</a>| </li>

<li><a href="../../search.html">search</a>| </li>

<li><a href="../../examples/index.html">examples</a>| </li>

<li><a href="../../gallery.html">gallery</a>| </li>

<li><a href="../../citing.html">citation</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>

<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>

<li><a class="reference internal" href="#moving-from-patching-to-development">Moving from patching to development</a></li>

</ul>

</li>

</ul>

<h4>Previous topic</h4>

<p class="topless"><a href="following_latest.html"

title="previous chapter">Following the latest source</a></p>

<h4>Next topic</h4>

<p class="topless"><a href="git_development.html"

title="next chapter">Git for development</a></p>

<li><a href="../../_sources/devel/gitwash/patching.txt"

rel="nofollow">Show Source</a></li>

</ul>

<h3>Quick search</h3>

</form>

Enter search terms or a module, class or function name.

</p>

</div>

</div>

<h1>Making a patch<a class="headerlink" href="#making-a-patch" title="Permalink to this headline">¶</a></h1>

<p>You’ve discovered a bug or something else you want to change

in <a class="reference external" href="http://matplotlib.org">matplotlib</a> .. — excellent!</p>

<p>You’ve worked out a way to fix it — even better!</p>

<p>You want to tell us about it — best of all!</p>

<p>The easiest way is to make a <em>patch</em> or set of patches. Here

we explain how. Making a patch is the simplest and quickest,

but if you’re going to be doing anything more than simple

quick things, please consider following the

<a class="reference internal" href="git_development.html#git-development"><em>Git for development</em></a> model instead.</p>

<span id="id1"></span><h2>Making patches<a class="headerlink" href="#making-patches" title="Permalink to this headline">¶</a></h2>

<h3>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h3>

<div class="highlight-python"><pre># tell git who you are

git config --global user.email you@yourdomain.example.com

git config --global user.name "Your Name Comes Here"

# get the repository if you don't have it

git clone git://github.com/matplotlib/matplotlib.git

# make a branch for your patching

cd matplotlib

git branch the-fix-im-thinking-of

git checkout the-fix-im-thinking-of

# hack, hack, hack

# Tell git about any new files you've made

git add somewhere/tests/test_my_bug.py

# commit work in progress as you go

git commit -am 'BF - added tests for Funny bug'

# hack hack, hack

git commit -am 'BF - added fix for Funny bug'

# make the patch files

git format-patch -M -C master</pre>

</div>

<p>Then, send the generated patch files to the <a class="reference external" href="https://lists.sourceforge.net/lists/listinfo/matplotlib-devel">matplotlib

mailing list</a> — where we will thank you warmly.</p>

</div>

<h3>In detail<a class="headerlink" href="#in-detail" title="Permalink to this headline">¶</a></h3>

<li><p class="first">Tell <a class="reference external" href="http://git-scm.com/">git</a> who you are so it can label the commits you’ve

made:</p>

<div class="highlight-python"><pre>git config --global user.email you@yourdomain.example.com

git config --global user.name "Your Name Comes Here"</pre>

</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-python"><pre>git clone git://github.com/matplotlib/matplotlib.git

cd matplotlib</pre>

</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-python"><pre>git branch the-fix-im-thinking-of

git checkout the-fix-im-thinking-of</pre>

</div>

</li>

<li><p class="first">Do some edits, and commit them as you go:</p>

<div class="highlight-python"><pre># hack, hack, hack

# Tell git about any new files you've made

git add somewhere/tests/test_my_bug.py

# commit work in progress as you go

git commit -am 'BF - added tests for Funny bug'

# hack hack, hack

git commit -am 'BF - added fix for Funny bug'</pre>

</div>

<p>Note the <tt class="docutils literal"><span class="pre">-am</span></tt> options to <tt class="docutils literal"><span class="pre">commit</span></tt>. The <tt class="docutils literal"><span class="pre">m</span></tt> flag just

signals that you’re going to type a message on the command

line. The <tt class="docutils literal"><span class="pre">a</span></tt> flag — you can just take on faith —

or see <a class="reference external" href="http://www.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-python"><pre>git status</pre>

</div>

</li>

<li><p class="first">Finally, make your commits into patches. You want all the

commits since you branched from the <tt class="docutils literal"><span class="pre">master</span></tt> branch:</p>

<div class="highlight-python"><pre>git format-patch -M -C master</pre>

</div>

<p>You will now have several files named for the commits:</p>

<div class="highlight-python"><pre>0001-BF-added-tests-for-Funny-bug.patch

0002-BF-added-fix-for-Funny-bug.patch</pre>

</div>

<p>Send these files to the <a class="reference external" href="https://lists.sourceforge.net/lists/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 <tt class="docutils literal"><span class="pre">master</span></tt> branch:</p>

<div class="highlight-python"><pre>git checkout master</pre>

</div>

<h2>Moving from patching to development<a class="headerlink" href="#moving-from-patching-to-development" title="Permalink to this headline">¶</a></h2>

<p>If you find you have done some patches, and you have one or

more feature branches, you will probably want to switch to

development mode. You can do this with the repository you

have.</p>

<p>Fork the <a class="reference external" href="http://matplotlib.org">matplotlib</a> repository on <a class="reference external" href="http://github.com">github</a> — <a class="reference internal" href="forking_hell.html#forking"><em>Making your own copy (fork) of matplotlib</em></a>.

Then:</p>

<div class="highlight-python"><pre># checkout and refresh master branch from main repo

git checkout master

git pull origin master

# rename pointer to main repository to 'upstream'

git remote rename origin upstream

# point your repo to default read / write to your fork on github

git remote add origin git@github.com:your-user-name/matplotlib.git

# push up any branches you've made and want to keep

git push origin the-fix-im-thinking-of</pre>

</div>

<p>Then you can, if you want, follow the

<a class="reference internal" href="development_workflow.html#development-workflow"><em>Development workflow</em></a>.</p>

</div>

</div>

<h3>Navigation</h3>

<ul>

<a href="../../genindex.html" title="General Index"

>index</a></li>

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<a href="git_development.html" title="Git for development"

>next</a> |</li>

<a href="following_latest.html" title="Following the latest source"

>previous</a> |</li>

<li><a href="http://www.matplotlib.org/downloads.html">downloads</a>| </li>

<li><a href="../../search.html">search</a>| </li>

<li><a href="../../examples/index.html">examples</a>| </li>

<li><a href="../../gallery.html">gallery</a>| </li>

<li><a href="../../citing.html">citation</a>| </li>

<li><a href="../index.html" >The Matplotlib Developers’ Guide</a> »</li>

<li><a href="index.html" >Working with <em>matplotlib</em> source code</a> »</li>

</ul>

</div>

Last updated on May 29, 2013.

Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.

</div>

</body>

</html>

matplotlib.github.com/1.2.1/devel/gitwash/patching.html at main · matplotlib/matplotlib.github.com · GitHub

Expand file tree

Breadcrumbs

patching.html

Latest commit

History

Breadcrumbs

patching.html

File metadata and controls