Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / mesa3d / f4e499ec79147f4172f3669ae9dafd941aaeeb65 / . / docs / repository.html
blob: 784ae2cbd8f03bfe173a31cde95fd6b40b859ff4 [file] [log] [blame]
Andreas Bollecd5c7c2012-06-12 09:05:03 +0200[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html lang="en">
3<head>
4 <meta http-equiv="content-type" content="text/html; charset=utf-8">
5 <title>Code Repository</title>
6 <link rel="stylesheet" type="text/css" href="mesa.css">
7</head>
8<body>
Brian464e3632006-12-05 16:14:14 -0700[diff] [blame]9
Andreas Bollb5da52a2012-09-18 18:57:02 +0200[diff] [blame]10<div class="header">
11 <h1>The Mesa 3D Graphics Library</h1>
12</div>
13
14<iframe src="contents.html"></iframe>
15<div class="content">
16
Brian464e3632006-12-05 16:14:14 -0700[diff] [blame]17<h1>Code Repository</h1>
18
19<p>
Andreas Bolla73c59b2012-09-18 19:31:28 +0200[diff] [blame]20Mesa uses <a href="http://git-scm.com">git</a>
Brian464e3632006-12-05 16:14:14 -0700[diff] [blame]21as its source code management system.
Brian464e3632006-12-05 16:14:14 -0700[diff] [blame]22</p>
23
Andreas Bolldf2be222012-06-12 09:05:22 +0200[diff] [blame]24<p>
Brian464e3632006-12-05 16:14:14 -0700[diff] [blame]25The master git repository is hosted on
Andreas Bolla73c59b2012-09-18 19:31:28 +0200[diff] [blame]26<a href="http://www.freedesktop.org">freedesktop.org</a>.
Brian464e3632006-12-05 16:14:14 -0700[diff] [blame]27</p>
28
29<p>
30You may access the repository either as an
31<a href="#anonymous">anonymous user</a> (read-only) or as a
32<a href="#developer">developer</a>
33(read/write).
34</p>
35
36<p>
37You may also
Brian Paulca1b2da2012-02-16 13:35:02 -0700[diff] [blame]38<a href="http://cgit.freedesktop.org/mesa/mesa/"
Andreas Bolla73c59b2012-09-18 19:31:28 +0200[diff] [blame]39>browse the main Mesa git repository</a> and the
Brian Paul7ba1a872010-06-04 17:47:06 -0600[diff] [blame]40<a href="http://cgit.freedesktop.org/mesa/demos"
Andreas Bolla73c59b2012-09-18 19:31:28 +0200[diff] [blame]41>Mesa demos and tests git repository</a>.
Brian464e3632006-12-05 16:14:14 -0700[diff] [blame]42</p>
43
44
Andreas Bollcc418882012-06-12 09:05:33 +0200[diff] [blame]45<h2 id="anonymous">Anonymous git Access</h2>
Brian464e3632006-12-05 16:14:14 -0700[diff] [blame]46
47<p>
48To get the Mesa sources anonymously (read-only):
49</p>
50
51<ol>
52<li>Install the git software on your computer if needed.<br><br>
53<li>Get an initial, local copy of the repository with:
54 <pre>
55 git clone git://anongit.freedesktop.org/git/mesa/mesa
56 </pre>
57<li>Later, you can update your tree from the master repository with:
58 <pre>
59 git pull origin
60 </pre>
Brian Paul7ba1a872010-06-04 17:47:06 -0600[diff] [blame]61<li>If you also want the Mesa demos/tests repository:
62 <pre>
63 git clone git://anongit.freedesktop.org/git/mesa/demos
64 </pre>
Brian464e3632006-12-05 16:14:14 -0700[diff] [blame]65</ol>
66
67
Andreas Bollcc418882012-06-12 09:05:33 +0200[diff] [blame]68<h2 id="developer">Developer git Access</h2>
Brian464e3632006-12-05 16:14:14 -0700[diff] [blame]69
70<p>
Brian Paule9159032016-04-25 10:13:32 -0600[diff] [blame]71If you wish to become a Mesa developer with git-write privilege, please
72follow this procedure:
Brian464e3632006-12-05 16:14:14 -0700[diff] [blame]73</p>
Brian Paule9159032016-04-25 10:13:32 -0600[diff] [blame]74<ol>
75<li>Subscribe to the
76<a href="http://lists.freedesktop.org/mailman/listinfo/mesa-dev">mesa-dev</a>
77mailing list.
78<li>Start contributing to the project by posting patches / review requests to
79the mesa-dev list. Specifically,
80<ul>
81<li>Use <code>git send-mail</code> to post your patches to mesa-dev.
82<li>Wait for someone to review the code and give you a <code>Reviewed-by</code>
83statement.
84<li>You'll have to rely on another Mesa developer to push your initial patches
85after they've been reviewed.
86</ul>
87<li>After you've demonstrated the ability to write good code and have had
88a dozen or so patches accepted you can apply for an account.
89<li>Occasionally, but rarely, someone may be given a git account sooner, but
90only if they're being supervised by another Mesa developer at the same
91organization and planning to work in a limited area of the code or on a
92separate branch.
93<li>To apply for an account, follow
94<a href="http://www.freedesktop.org/wiki/AccountRequests">these directions</a>.
95It's also appreciated if you briefly describe what you intend to do (work
96on a particular driver, add a new extension, etc.) in the bugzilla record.
97</ol>
Brian464e3632006-12-05 16:14:14 -0700[diff] [blame]98
99<p>
100Once your account is established:
101</p>
102
103<ol>
Brian464e3632006-12-05 16:14:14 -0700[diff] [blame]104<li>Get an initial, local copy of the repository with:
105 <pre>
106 git clone git+ssh://username@git.freedesktop.org/git/mesa/mesa
107 </pre>
108 Replace <em>username</em> with your actual login name.<br><br>
109<li>Later, you can update your tree from the master repository with:
110 <pre>
111 git pull origin
112 </pre>
Brian Paul7ba1a872010-06-04 17:47:06 -0600[diff] [blame]113<li>If you also want the Mesa demos/tests repository:
114 <pre>
115 git clone git+ssh://username@git.freedesktop.org/git/mesa/demos
116 </pre>
Brian464e3632006-12-05 16:14:14 -0700[diff] [blame]117</ol>
118
119
Andreas Boll210a27d2012-06-12 09:05:36 +0200[diff] [blame]120<h2>Windows Users</h2>
Brianddbfa8c2008-02-28 08:03:04 -0700[diff] [blame]121
122<p>
Andreas Bolla73c59b2012-09-18 19:31:28 +0200[diff] [blame]123If you're <a href="http://git.wiki.kernel.org/index.php/WindowsInstall">
Brianddbfa8c2008-02-28 08:03:04 -0700[diff] [blame]124using git on Windows</a> you'll want to enable automatic CR/LF conversion in
125your local copy of the repository:
126</p>
127<pre>
128 git config --global core.autocrlf true
129</pre>
130
131<p>
132This will cause git to convert all text files to CR+LF on checkout,
133and to LF on commit.
134</p>
135<p>
136Unix users don't need to set this option.
137</p>
138<br>
139
140
Andreas Bollcc418882012-06-12 09:05:33 +0200[diff] [blame]141<h2>Development Branches</h2>
Brian464e3632006-12-05 16:14:14 -0700[diff] [blame]142
143<p>
144At any given time, there may be several active branches in Mesa's
145repository.
146Generally, the trunk contains the latest development (unstable)
147code while a branch has the latest stable code.
148</p>
149
150<p>
Brian18e9ca52007-02-20 09:24:06 -0700[diff] [blame]151The command <code>git-branch</code> will list all available branches.
152</p>
153
154<p>
155Questions about branch status/activity should be posted to the
156mesa3d-dev mailing list.
Brian464e3632006-12-05 16:14:14 -0700[diff] [blame]157</p>
158
Andreas Boll210a27d2012-06-12 09:05:36 +0200[diff] [blame]159<h2>Developer Git Tips</h2>
Karl Schultz207ad942010-02-11 10:54:18 -0700[diff] [blame]160
161<ol>
162<li>Setting up to edit the master branch
163<p>
164If you try to do a pull by just saying<code> git pull </code>
165and git complains that you have not specified a
166branch, try:
167<pre>
168 git config branch.master.remote origin
169 git config branch.master.merge master
170</pre>
Andreas Bolldf2be222012-06-12 09:05:22 +0200[diff] [blame]171<p>
Karl Schultz207ad942010-02-11 10:54:18 -0700[diff] [blame]172Otherwise, you have to say<code> git pull origin master </code>
173each time you do a pull.
174</p>
175<li>Small changes to master
176<p>
Nathan Kidd0691b372014-01-03 16:44:00 -0700[diff] [blame]177If you are an experienced git user working on substantial modifications,
Karl Schultz207ad942010-02-11 10:54:18 -0700[diff] [blame]178you are probably
179working on a separate branch and would rebase your branch prior to
180merging with master.
181But for small changes to the master branch itself,
182you also need to use the rebase feature in order to avoid an
183unnecessary and distracting branch in master.
184</p>
185<p>
186If it has been awhile since you've done the initial clone, try
187<pre>
188 git pull
189</pre>
Andreas Bolldf2be222012-06-12 09:05:22 +0200[diff] [blame]190<p>
Karl Schultz207ad942010-02-11 10:54:18 -0700[diff] [blame]191to get the latest files before you start working.
192</p>
193<p>
194Make your changes and use
195<pre>
196 git add &lt;files to commit&gt;
197 git commit
198</pre>
Andreas Bolldf2be222012-06-12 09:05:22 +0200[diff] [blame]199<p>
Karl Schultz207ad942010-02-11 10:54:18 -0700[diff] [blame]200to get your changes ready to push back into the fd.o repository.
201</p>
202<p>
203It is possible (and likely) that someone has changed master since
204you did your last pull. Even if your changes do not conflict with
205their changes, git will make a fast-forward
206merge branch, branching from the point in time
207where you did your last pull and merging it to a point after the other changes.
208</p>
209<p>
210To avoid this,
211<pre>
212 git pull --rebase
213 git push
214</pre>
Andreas Bolldf2be222012-06-12 09:05:22 +0200[diff] [blame]215<p>
Karl Schultz207ad942010-02-11 10:54:18 -0700[diff] [blame]216If you are familiar with CVS or similar system, this is similar to doing a
217<code> cvs update </code> in order to update your source tree to
218the current repository state, instead of the time you did the last update.
219(CVS doesn't work like git in this respect, but this is easiest way
220to explain it.)
Andreas Bolldf2be222012-06-12 09:05:22 +0200[diff] [blame]221<br>
Karl Schultz207ad942010-02-11 10:54:18 -0700[diff] [blame]222In any case, your repository now looks like you made your changes after
223all the other changes.
224</p>
225<p>
226If the rebase resulted in conflicts or changes that could affect
227the proper operation of your changes, you'll need to investigate
228those before doing the push.
229</p>
230<p>
231If you want the rebase action to be the default action, then
232<pre>
233 git config branch.master.rebase true
234 git config --global branch.autosetuprebase=always
235</pre>
236<p>
Andreas Bolla73c59b2012-09-18 19:31:28 +0200[diff] [blame]237See <a href="http://www.eecs.harvard.edu/~cduan/technical/git/">Understanding Git Conceptually</a> for a fairly clear explanation about all of this.
Karl Schultz207ad942010-02-11 10:54:18 -0700[diff] [blame]238</p>
239</ol>
Brian464e3632006-12-05 16:14:14 -0700[diff] [blame]240
Andreas Bollb5da52a2012-09-18 18:57:02 +0200[diff] [blame]241</div>
Brian464e3632006-12-05 16:14:14 -0700[diff] [blame]242</body>
243</html>