summaryrefslogtreecommitdiffstats
path: root/site/download/index.php
blob: 461cc951e020373993cfd3b1698e767d9f33c1b6 (plain)
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
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
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
<?php
/*
    Download page
    Copyright (C) 2015  Francis Rowe <info@gluglug.org.uk>

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as
    published by the Free Software Foundation, either version 3 of the
    License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/
?>
<?php
	include_once "../variables.php";
	include_once "../torrents.php";
	include_once "../functions.php";
?>
<!DOCTYPE html>
<html>
<head>
	<meta charset="utf-8">
	<meta name="viewport" content="width=device-width, initial-scale=1">

	<link rel="stylesheet" type="text/css" href="../css/main.css" />

	<title>Download <?php echo $lbProjectName; ?></title>

</head>

<body>

	<div class="contain">

		<div id="libreboot" class="section intro">
				
				<p>
					<a href="../images/welcome_screen.png"><img class="homepage_logo" src="../images/welcome_screen_small.jpg" alt="" title="<?php include "../images/welcome_screen.png.license.txt"; ?>" /></a>
				</p>
				
			<h1>Download <?php echo $lbProjectName; ?></h1>
			
				<p>
					Information about these releases can be found at <a href="../docs/release.html">../docs/release.html</a>.
					Documentation can be found at <a href="../docs/index.html">../docs/index.html</a>.
					A copy of /docs/ can also be found in the release archives.
				</p>
				
				<!-- <p>
					TODO: set up RSS and Atom feeds for the bittorrent links (but not the HTTP mirrors).
					The main gitweb page (for the main git repository) already generates atom/rss feeds.
				</p> -->
				
				<ul class="ulnav">
					<!-- <li><a href="#torrent">Bittorrent</a></li> -->
					<li><a href="#http">HTTP mirrors</a></li>
					<li><a href="#git">Git repositories (development)</a></li>
				</ul>
				
				<p>
					<a href="../">Back to home page</a>
				</p>

		</div>
		
		<div class="section" id="gpg">
			
			<h1 id="gpg">GPG signing key</h1>

				<p>
					<?php echo $lbProjectGpgKeyInfo; ?>
				</p>
				<p>
					Download the key:<br/>
					$ <b>gpg --recv-keys <?php echo $lbProjectGpgKeyID; ?></b>
				</p>
				<p>
					You can verify the downloaded archives as follows:<br/>
					$ <b>for signature in $(ls *.sig); do gpg --verify $signature; done</b>
				</p>
		
		</div>

<!--
		<div class="section" id="torrent">
			
			<p><b>Torrent links do not work yet. Use the HTTP downloads.</b></p>
			
			<h1>Bittorrent</h1>

			<?php
				/* Show current version */
				echo torrent_list($lbTorrentLink, 0, 1);
			?>

			<?php
				/* Link to old releases */
				if (count($lbTorrentLink)>1) {
			?>
			<p>
				Torrents for older releases can be found at <a href="oldtorrent/">oldtorrent/</a>.
			</p>
<?php
	}
?>
				
			<p><b>Torrent links do not work yet. Use the HTTP downloads.</b></p>
				
		</div>
-->
		
		<div class="section" id="http">
		
			<h1>HTTP mirrors</h1>
<!--
				<p>
					These mirrors are intended mainly for those who cannot use
					bittorrent. Otherwise, the <a href="#torrent">torrent links</a>
					are highly recommended.
				</p>
-->

				<p>
					Download libreboot from one of these mirrors.
				</p>
				
<?php
				/* show HTTP mirrors */
				echo list_items($lbHttpMirror,"HTTP mirrors not added yet.",0,count($lbHttpMirror));
?>
				<h2 id="ftp">FTP mirrors</h2>
<?php
					/* show HTTP mirrors */
					echo list_items($lbFtpMirror,"FTP mirrors not added yet.",0,count($lbFtpMirror));
?>
				

				<h2 id="mirror">Rsync mirrors (for mirroring <?php echo $lbProjectName; ?>)</h2>
					<p>
						Create a directory in your web server document root (e.g. <?php echo $lbProjectName; ?>/),
						and add one of these to your crontab:
					</p>
<?php

	if (count($lbRsyncServer)>0) {
?>
					<h3>Main rsync mirror:</h3>
						<p>
							$ <b>rsync -avxP --delete --stats <?php echo $lbRsyncServer[0]; ?> /path/to/docroot/<?php echo $lbProjectName; ?>/</b>
						</p>
<?php
		if(count($lbRsyncServer)>1) {
?>
					<h3>Backup rsync mirrors:</h3>
						<p>
<?php
			for ($server=1; $server<count($lbRsyncServer); $server++) {
?>
							$ <b>rsync -avxP --delete --stats <?php echo $lbRsyncServer[$server]; ?> /path/to/docroot/<?php echo $lbProjectName; ?>/</b><br/>
<?php
			}
?>
						</p>
<?php
		}
	} else {
?>
					<p>
						<b>No mirrors available yet.</b>
					</p>
<?php
	}
?>

					<p>
						Are you running a mirror? Contact the <?php echo $lbProjectName; ?> project
						(details are on the <a href="../">home page</a>), and the link will be added here.
					</p>
	
		</div>
		
		<div class="section" id="git">
		
			<h1>Git repositories (development)</h1>
			
				<p>
					The git repositories are intended for developing <?php echo $lbProjectName; ?>.
					ROM images built from the git repository are untested, and therefore not
					recommended for general use (you should assume that they will
					brick your computer).
				</p>
				
				<p>
					Snapshots (preview releases) of the git repository can be found at
					<a href="../git/">../git/</a>.
				</p>
				<p>
					Documentation for <?php echo $lbProjectName; ?> from git can be found in
					the git repository itself (under /docs/), or a live version
					can be found at <a href="../gitdocs/index.html">../gitdocs/index.html</a>.
				</p>
			
				<h2>How to download</h2>
					<p>
						Firmware (coreboot distribution):<br/>
						$ <b>git clone <a href="<?php echo $lbFirmwareGitwebAddress; ?>"><?php echo $lbFirmwareGitRepoAddress; ?></a></b>
					</p>
					<p>
						<?php echo $lbProjectNameCapitalized ?> website:<br/>
						$ <b>git clone <a href="<?php echo $lbWebsiteGitwebAddress; ?>"><?php echo $lbWebsiteGitRepoAddress; ?></a></b>
					</p>
					<p>
						Backup repositories can be found at <a href="#gitbackup">#gitbackup</a>.
					</p>
					<ul class="ulnav">
						<li><b><a href="../github/">Please do not use GitHub!</a></b></li>
						<li><b><a href="../gitorious/">Please do not use Gitorious/GitLab!</a></b></li>
						<li><a href="#contrib">How to submit a patch</a></li>
					</ul>
					
				<h2 id="contrib">Submitting patches to <?php echo $lbProjectName; ?></h3>
					<p>
						The <a href="http://git-scm.com/doc">git documentation</a> describes how to use git.
						For a list of current tasks in libreboot, see <a href="../gitdocs/tasks.html">../gitdocs/tasks.html</a>.
					</p>
					<p>
						Make sure that you configured git so that your name and email
						address appear in the commits that you create:<br/>
						$ <b>git config --global user.name &quot;Your Name&quot;</b><br/>
						$ <b>git config --global user.email your@emailaddress.com</b>
					</p>
					<p>
						The following is also useful:<br/>
						$ <b>git config --global core.editor nano</b><br/>
						$ <b>git config --global color.status auto</b><br/>
						$ <b>git config --global color.branch auto</b><br/>
						$ <b>git config --global color.interactive auto</b><br/>
						$ <b>git config --global color.diff auto</b>
					</p>
					<p>
						Clone the git repository, and make your desired changes. You can make one or several commits (as many as you like).
						Generally speaking, you should create separate commits on top of each other, for each kind of change.
					</p>
					<p>
						Once you have made your change(s), you can use this to check the status:<br/>
						$ <b>git status</b>
					</p>
					
					<div class="important">
						
						<p>
							If you are modifying an existing file, make sure to update the copyright license header
							in that file; in source files or scripts, this would usually be at the top, and for documentation
							it is typically at the bottom of the document. It is good practise to use your real name in the
							commit logs.<br/>
							Example: <i>Copyright (C) 20XX John Doe &lt;john@doe.com&gt;</i>
						</p>
						<p>
							Generally speaking, using the same license as the file that you are modifying is much simpler.
							If you are submitting new
							files, please make sure that they are under a free license (copyleft preferred).
							You can find a list on
							<a href="https://www.gnu.org/licenses/license-list.html">https://www.gnu.org/licenses/license-list.html</a>.
						</p>
						<p>
							<i>
								The <?php echo $lbProjectName; ?> project will not accept
								documentation released under the <u>GNU Free Documentation License</u>, because we do not want to endorse
								or support the Invariant clauses that this license allows. Changes submitted under this
								license will be rejected, even if it contains no Invariant sections
							</i>
						</p>
						
					</div>
						
					<p>
						The status command will show any untracked files that you have. Add them using <b>git add path/to/file</b>.
						You should also add any other files that are listed as modified in the git status. If there are deleted
						files in the git status, you can use <b>git rm path/to/file</b>. As long as you have added all the untracked
						files, it is generally easier to use:<br/>
						$ <b>git commit -a</b><br/>
						(instead of <b>git commit</b>)
					</p>
					<p>
						If you need to make a change to the current commit, you can do so with:<br/>
						$ <b>git commit --amend</b><br/>
						or:<br/>
						$ <b>git commit -a --amend</b>
					</p>
					<p>
						In your local git tree, you can use this to check your commits:<br/>
						$ <b>git log</b>
					</p>
					<p>
						Shortened git logs showing the short commit ID and the commit title, plus info about what branch
						you are on, and where all your remotes/heads are:<br/>
						$ <b>git config --global --add alias.lol &quot;log --graph --decorate --pretty=oneline --abbrev-commit --all&quot;</b><br/>
						From then on, you can use:<br/>
						$ <b>git lol</b><br/>
						This is like <b>git log</b>, but on steroids.
					</p>
					<h3>Method 1: host a repository</h3>
						<p>
							One way of contribiting a patch for review is to host a repository containing your modified branch. 
							Give the checkout details to the <?php echo $lbProjectName; ?> project, along with information
							on which commits in what branch contain your changes.
							Contact the <?php echo $lbProjectName; ?> project using the details on the <a href="../">home page</a>.
						</p>
					<h3>Method 2: git format-patch -N</h3>
						<p>
							Use this method (replace N with the number of commits that you made) and send the .patch files to the
							<?php echo $lbProjectName; ?> project, along with details on what branch and revision these were
							made on top of.
							Contact the <?php echo $lbProjectName; ?> project using the details on the <a href="../">home page</a>.
						</p>
					
				<h2 id="gitbackup">Backup repositories</h2>
					<p>
						Generally speaking, you should use the main repositories. These repositories are provided
						as backups, in case the main repositories are down.
					</p>
					
					<h3>Firmware (coreboot distribution)</h3>
						<p>
<?php
	for ($server=0; $server<count($lbFirmwareBackupGitRepoAddress); $server++) {
?>
							$ <b>git clone <?php echo $lbFirmwareBackupGitRepoAddress[$server]; ?></b>
							<?php if ($server!=count($lbFirmwareBackupGitRepoAddress)-1) echo "<br/>"; ?>
<?php
	}
?>
						</p>

					<h3><?php echo $lbProjectNameCapitalized; ?> website</h3>
						<p>
<?php
	for ($server=0; $server<count($lbWebsiteBackupGitRepoAddress); $server++) {
?>
							$ <b>git clone <?php echo $lbWebsiteBackupGitRepoAddress[$server]; ?></b>
							<?php if ($server!=count($lbWebsiteBackupGitRepoAddress)-1) echo "<br/>"; ?>
<?php
	}
?>
						</p>
		
		</div>

		<div class="section footer">

<?php
	include "../footer.php";
?>

		</div>
	
	</div>

</body>
</html>