From 319c0c8f120c5ad429010d65666a58fec7f0615a Mon Sep 17 00:00:00 2001 From: floam Date: Fri, 4 Nov 2005 23:55:12 +0000 Subject: Bunch of grammar changes and random cleanings. Also some changes by sysrq to explain how to use svn diff. git-svn-id: svn://svn.icculus.org/quake3/trunk@271 edf5b092-35ff-0310-97b2-ce42778d08ea --- web/include/instruc.php | 69 +++++++++++++++++++++++++++++++++++-------------- 1 file changed, 50 insertions(+), 19 deletions(-) (limited to 'web/include/instruc.php') 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 @@

Check out and build from Subversion

-

(This part assumes Windows users are using Cygwin. If you aren't, -TortoiseSVN is a good client.)

+

( This part assumes Windows users are using Cygwin. If you aren't, +TortoiseSVN is a good client. )

  1. Change into a directory that you want the tree to be kept in.
  2. Check out the source tree:
    @@ -9,7 +9,8 @@ (You can check out a specific revision with the -r option, like this: svn co svn://svn.icculus.org/quake3/trunk quake3 -r100)
    3. -
  3. Read the readme file. Really. Do it.
    4. +
  4. Read the readme + file. Really. Do it.
  5. Compile and install Quake 3:

    • Linux and friends

      @@ -44,21 +45,51 @@ Firstly, try 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.

      -

      Not everyone who knows C knows how to use diff (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:

      + +

      The preferred way to get the ball rolling on a patch is to file a +Bugzilla bug 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 mail +it to zakk@icculus.org rather than not do anything at all.

      + +

      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 only submit patches for +inclusion if you are the original creator!

      + +

      Generating Patches

      +

      If you know how to code, but never made a patch before, that's okay. Here's the 10¢ +survival guide to generating patches.

        -
      • Create a patch named amazing_new_feature.patch between oldfile and newfile:
        - diff -u oldfile newfile > amazing_new_feature.patch
        • -
      • Create a patch named amazing_new_features.patch between directory olddir and newdir:
        - diff -Naur olddir newdir > amazing_new_features.patch
        • -
      • Apply a patch amazing_new_feature.patch:
        - patch -p0 -i amazing_new_feature.patch
        • +
      • +

        From SVN

        +

        If you checked the source code out with SVN, + 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:

        +
          +
        • Create a patch named amazing_new_feature.patch:
          • +
        • svn diff > amazing_new_feature.patch
          • +
        • Apply a patch amazing_new_feature.patch:
          + patch -p0 -i amazing_new_feature.patch
          • +
        +

        For more information on SVN take a look at the + SVN book and the info pages for + svn.

        +
        • +
      • +

        From a tarball or other release

        +

        If you didn't get the source code via SVN, + or for some reason that doesn't work for your situations, here's how to generate + them using the tried-and-trusted diff tool between + two files:

        +
          +
        • Create a patch named amazing_new_feature.patch between oldfile and newfile:
          + diff -u oldfile newfile > amazing_new_feature.patch
          • +
        • Create a patch named amazing_new_features.patch between directory olddir and newdir:
          + diff -Naur olddir newdir > amazing_new_features.patch
          • +
        • Applying a patch is the same as with SVN, see above.
          • +
        +

        For more information on diff and patch, + read their man-pages.

        +
      -

      For more information on diff and patch, -read their man-pages.

      -

      The prefered way to get the ball rolling on a patch is to file a bug -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 -mail it to zakk@icculus.org rather than not do -anything.

      -- cgit v1.2.3