diff options
Diffstat (limited to 'web/include/instruc.php')
| -rw-r--r-- | web/include/instruc.php | 69 |
1 files changed, 50 insertions, 19 deletions
diff --git a/web/include/instruc.php b/web/include/instruc.php index 8770037..6e67169 100644 --- a/web/include/instruc.php +++ b/web/include/instruc.php @@ -1,6 +1,6 @@ <h2>Check out and build from Subversion</h2> -<p>(This part assumes Windows users are using Cygwin. If you aren't, -<a href="http://tortoisesvn.tigris.org/">TortoiseSVN</a> is a good client.)</p> +<p>( This part assumes Windows users are using Cygwin. If you aren't, +<a href="http://tortoisesvn.tigris.org/">TortoiseSVN</a> is a good client. )</p> <ol> <li>Change into a directory that you want the tree to be kept in.</li> <li>Check out the source tree:<br /> @@ -9,7 +9,8 @@ (You can check out a specific revision with the -r option, like this: <span class="shell">svn co svn://svn.icculus.org/quake3/trunk quake3 -r100</span>) </li> - <li>Read the <a href="http://svn.icculus.org/*checkout*/quake3/trunk/i_o-q3-readme">readme</a> file. Really. Do it.</li> + <li>Read the <a href="http://svn.icculus.org/*checkout*/quake3/trunk/i_o-q3-readme">readme</a> + file. Really. Do it.</li> <li>Compile and install Quake 3: <ul> <li><h3>Linux and friends</h3> @@ -44,21 +45,51 @@ Firstly, <em>try</em> to make sure that the patch breaks less than it fixes. We don't require everyone to be decorated Geniuses, but do attempt to produce a patch that you've tested and at list sort-of understand what you're doing.</p> -<p>Not everyone who knows C knows how to use <span class="shell">diff</span> (the tool -you need to create patches with), and not everyone is making patches against the C code. -That's okay, here's the 10¢ survival guide to making patches:</p> + +<p>The preferred way to get the ball rolling on a patch is to file a +<a href="http://bugs.icculus.org">Bugzilla bug</a> for your request with the patch attached +to it and then send a notice to the mailing list about it. If you're really so lazy that +you can't do this, we would prefer you at least <a href="mailto:zakk@icculus.org">mail +it to zakk@icculus.org</a> rather than not do anything at all.</p> + +<p>Please don't send in patches that you didn't create. You can feel free to alert people +and discuss anything on the mailing list, but please <strong>only submit patches for +inclusion if you are the original creator</strong>!</p> + +<h2>Generating Patches</h2> +<p>If you know how to code, but never made a patch before, that's okay. Here's the 10¢ +survival guide to generating patches.</p> <ul> - <li>Create a patch named <em class="shell">amazing_new_feature.patch</em> between <em class="shell">oldfile</em> and <em class="shell">newfile</em>:<br /> - <span class="shell">diff -u <em>oldfile</em> <em>newfile</em> > <em>amazing_new_feature.patch</em></span></li> - <li>Create a patch named <em class="shell">amazing_new_features.patch</em> between directory <em class="shell">olddir</em> and <em class="shell">newdir</em>:<br /> - <span class="shell">diff -Naur <em>olddir</em> <em>newdir</em> > <em>amazing_new_features.patch</em></span></li> - <li>Apply a patch <em class="shell">amazing_new_feature.patch</em>:<br /> - <span class="shell">patch -p0 -i <em>amazing_new_feature.patch</em></span></li> + <li> + <h3>From <acronym title="Subversion">SVN</acronym></h3> + <p>If you checked the source code out with <acronym title="Subversion">SVN</acronym>, + the client makes it rather easy to generate patches. In fact it's a function + of the client itself. Once you've made a change in your checkout that is + not upstream, here is how you use it:</p> + <ul> + <li>Create a patch named <em class="shell">amazing_new_feature.patch</em>:</li> + <li><span class="shell">svn diff > <em>amazing_new_feature.patch</em></span></li> + <li id="patch">Apply a patch <em class="shell">amazing_new_feature.patch</em>:<br /> + <span class="shell">patch -p0 -i <em>amazing_new_feature.patch</em></span></li> + </ul> + <p>For more information on SVN take a look at the + <a href="http://svnbook.red-bean.com/">SVN book</a> and the info pages for + <span class="shell">svn</span>.</p> + </li> + <li> + <h3>From a tarball or other release</h3> + <p>If you didn't get the source code via <acronym title="Subversion">SVN</acronym>, + or for some reason that doesn't work for your situations, here's how to generate + them using the tried-and-trusted <span class="shell">diff</span> tool between + two files:</p> + <ul> + <li>Create a patch named <em class="shell">amazing_new_feature.patch</em> between <em class="shell">oldfile</em> and <em class="shell">newfile</em>:<br /> + <span class="shell">diff -u <em>oldfile</em> <em>newfile</em> > <em>amazing_new_feature.patch</em></span></li> + <li>Create a patch named <em class="shell">amazing_new_features.patch</em> between directory <em class="shell">olddir</em> and <em class="shell">newdir</em>:<br /> + <span class="shell">diff -Naur <em>olddir</em> <em>newdir</em> > <em>amazing_new_features.patch</em></span></li> + <li>Applying a patch is the same as with SVN, see <a href="#patch">above</a>.</li> + </ul> + <p>For more information on <span class="shell">diff</span> and <span class="shell">patch</span>, + read their man-pages.</p> + </li> </ul> -<p>For more information on <span class="shell">diff</span> and <span class="shell">patch</span>, -read their man-pages.</p> -<p>The prefered way to get the ball rolling on a patch is to file a <a href="http://bugs.icculus.org">bug</a> -for your request with the patch attached to it and then send a notice to the mailing list -about it. If you're really so lazy that you can't do this, we would prefer you at least -<a href="mailto:zakk@icculus.org">mail it to zakk@icculus.org</a> rather than not do -anything.</p> |