Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / mesa3d / 0691b37732e3b032fbd354537b20090a3ee8e122 / . / docs / repository.html
blob: bb0ae008e5c2276acbcee9041b54b2c4eda25aa9 [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>
71Mesa developers need to first have an account on
Andreas Bolla73c59b2012-09-18 19:31:28 +0200[diff] [blame]72<a href="http://www.freedesktop.org">freedesktop.org</a>.
Brian464e3632006-12-05 16:14:14 -0700[diff] [blame]73To get an account, please ask Brian or the other Mesa developers for
74permission.
75Then, if there are no objections, follow this
Andreas Bolla73c59b2012-09-18 19:31:28 +0200[diff] [blame]76<a href="http://www.freedesktop.org/wiki/AccountRequests">
Brian464e3632006-12-05 16:14:14 -0700[diff] [blame]77procedure</a>.
78</p>
79
80<p>
81Once your account is established:
82</p>
83
84<ol>
85<li>Install the git software on your computer if needed.<br><br>
86<li>Get an initial, local copy of the repository with:
87 <pre>
88 git clone git+ssh://username@git.freedesktop.org/git/mesa/mesa
89 </pre>
90 Replace <em>username</em> with your actual login name.<br><br>
91<li>Later, you can update your tree from the master repository with:
92 <pre>
93 git pull origin
94 </pre>
Brian Paul7ba1a872010-06-04 17:47:06 -0600[diff] [blame]95<li>If you also want the Mesa demos/tests repository:
96 <pre>
97 git clone git+ssh://username@git.freedesktop.org/git/mesa/demos
98 </pre>
Brian464e3632006-12-05 16:14:14 -0700[diff] [blame]99</ol>
100
101
Andreas Boll210a27d2012-06-12 09:05:36 +0200[diff] [blame]102<h2>Windows Users</h2>
Brianddbfa8c2008-02-28 08:03:04 -0700[diff] [blame]103
104<p>
Andreas Bolla73c59b2012-09-18 19:31:28 +0200[diff] [blame]105If you're <a href="http://git.wiki.kernel.org/index.php/WindowsInstall">
Brianddbfa8c2008-02-28 08:03:04 -0700[diff] [blame]106using git on Windows</a> you'll want to enable automatic CR/LF conversion in
107your local copy of the repository:
108</p>
109<pre>
110 git config --global core.autocrlf true
111</pre>
112
113<p>
114This will cause git to convert all text files to CR+LF on checkout,
115and to LF on commit.
116</p>
117<p>
118Unix users don't need to set this option.
119</p>
120<br>
121
122
Andreas Bollcc418882012-06-12 09:05:33 +0200[diff] [blame]123<h2>Development Branches</h2>
Brian464e3632006-12-05 16:14:14 -0700[diff] [blame]124
125<p>
126At any given time, there may be several active branches in Mesa's
127repository.
128Generally, the trunk contains the latest development (unstable)
129code while a branch has the latest stable code.
130</p>
131
132<p>
Brian18e9ca52007-02-20 09:24:06 -0700[diff] [blame]133The command <code>git-branch</code> will list all available branches.
134</p>
135
136<p>
137Questions about branch status/activity should be posted to the
138mesa3d-dev mailing list.
Brian464e3632006-12-05 16:14:14 -0700[diff] [blame]139</p>
140
Andreas Boll210a27d2012-06-12 09:05:36 +0200[diff] [blame]141<h2>Developer Git Tips</h2>
Karl Schultz207ad942010-02-11 10:54:18 -0700[diff] [blame]142
143<ol>
144<li>Setting up to edit the master branch
145<p>
146If you try to do a pull by just saying<code> git pull </code>
147and git complains that you have not specified a
148branch, try:
149<pre>
150 git config branch.master.remote origin
151 git config branch.master.merge master
152</pre>
Andreas Bolldf2be222012-06-12 09:05:22 +0200[diff] [blame]153<p>
Karl Schultz207ad942010-02-11 10:54:18 -0700[diff] [blame]154Otherwise, you have to say<code> git pull origin master </code>
155each time you do a pull.
156</p>
157<li>Small changes to master
158<p>
Nathan Kidd0691b372014-01-03 16:44:00 -0700[diff] [blame^]159If you are an experienced git user working on substantial modifications,
Karl Schultz207ad942010-02-11 10:54:18 -0700[diff] [blame]160you are probably
161working on a separate branch and would rebase your branch prior to
162merging with master.
163But for small changes to the master branch itself,
164you also need to use the rebase feature in order to avoid an
165unnecessary and distracting branch in master.
166</p>
167<p>
168If it has been awhile since you've done the initial clone, try
169<pre>
170 git pull
171</pre>
Andreas Bolldf2be222012-06-12 09:05:22 +0200[diff] [blame]172<p>
Karl Schultz207ad942010-02-11 10:54:18 -0700[diff] [blame]173to get the latest files before you start working.
174</p>
175<p>
176Make your changes and use
177<pre>
178 git add &lt;files to commit&gt;
179 git commit
180</pre>
Andreas Bolldf2be222012-06-12 09:05:22 +0200[diff] [blame]181<p>
Karl Schultz207ad942010-02-11 10:54:18 -0700[diff] [blame]182to get your changes ready to push back into the fd.o repository.
183</p>
184<p>
185It is possible (and likely) that someone has changed master since
186you did your last pull. Even if your changes do not conflict with
187their changes, git will make a fast-forward
188merge branch, branching from the point in time
189where you did your last pull and merging it to a point after the other changes.
190</p>
191<p>
192To avoid this,
193<pre>
194 git pull --rebase
195 git push
196</pre>
Andreas Bolldf2be222012-06-12 09:05:22 +0200[diff] [blame]197<p>
Karl Schultz207ad942010-02-11 10:54:18 -0700[diff] [blame]198If you are familiar with CVS or similar system, this is similar to doing a
199<code> cvs update </code> in order to update your source tree to
200the current repository state, instead of the time you did the last update.
201(CVS doesn't work like git in this respect, but this is easiest way
202to explain it.)
Andreas Bolldf2be222012-06-12 09:05:22 +0200[diff] [blame]203<br>
Karl Schultz207ad942010-02-11 10:54:18 -0700[diff] [blame]204In any case, your repository now looks like you made your changes after
205all the other changes.
206</p>
207<p>
208If the rebase resulted in conflicts or changes that could affect
209the proper operation of your changes, you'll need to investigate
210those before doing the push.
211</p>
212<p>
213If you want the rebase action to be the default action, then
214<pre>
215 git config branch.master.rebase true
216 git config --global branch.autosetuprebase=always
217</pre>
218<p>
Andreas Bolla73c59b2012-09-18 19:31:28 +0200[diff] [blame]219See <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]220</p>
221</ol>
Brian464e3632006-12-05 16:14:14 -0700[diff] [blame]222
Andreas Bollb5da52a2012-09-18 18:57:02 +0200[diff] [blame]223</div>
Brian464e3632006-12-05 16:14:14 -0700[diff] [blame]224</body>
225</html>