~ubuntu-branches/ubuntu/utopic/tinymux/utopic

« back to all changes in this revision

Viewing changes to docs/PATCHES

  • Committer: Bazaar Package Importer
  • Author(s): Ervin Hearn III
  • Date: 2008-04-11 23:18:25 UTC
  • mfrom: (1.1.5 upstream) (6.1.1 gutsy)
  • Revision ID: james.westby@ubuntu.com-20080411231825-1pq4trckagyk8roo
Tags: 2.6.5.27-1
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
TinyMUX 2.4:  PATCHES
2
 
Last Update:  January 2006
 
1
TinyMUX 2.6:  PATCHES
 
2
Last Update:  November 2006
3
3
 
4
 
A Word About Patches for TinyMUX 2.4:
 
4
A Word About Patches for TinyMUX 2.6:
5
5
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6
6
 
7
7
Changes are distributed in the form of patches, and these occur
8
 
most-frequently during the Alpha and Beta periods of the server's
9
 
development.  These 'patch' files are applied to your server's
10
 
source code using the 'patch' utility.
 
8
most-frequently during the Alpha and Beta periods of the server's development.
 
9
These 'patch' files are applied to your server's source code using the 'patch'
 
10
utility.
11
11
 
12
12
Keep yourself informed about changes to the server and pay particular
13
 
attention to any serious bugs that may have been corrected by a patch.
14
 
It is in the best interests of your game to make sure that patches are
15
 
applied, as many patches contain fixes for crashing/corrupting bugs, as
16
 
well as correcting weird and dangerous behaviors in the MUX program
17
 
itself.
18
 
 
19
 
Let us state that while patching a vanilla server with a patch released
20
 
by the development team is generally considered to be pretty easy, that
21
 
unless you have done it before and/or taken time to familiarize yourself
22
 
with how the patch utility works (type 'man patch' inside your shell
23
 
account or read the documentation for dopatch.exe provided with Win32
24
 
versions), then we strongly advise having someone either walk you
25
 
through the process or do the work for you.  Improper use of patch can
26
 
cause all kinds of grief that you don't want to deal with.  
 
13
attention to any serious bugs that may have been corrected by a patch.  The
 
14
TinyMUX mailing list is the best way to do this.
 
15
 
 
16
It is in the best interests of your game to make sure all patches are applied.
 
17
Patches distributed after a server has reached released status typically
 
18
contain important fixes for crashing, corrupting, unexpected, or potentially
 
19
dangerous behaviors.  The likelihood of encountering these unwanted behaviors
 
20
may be generally unlikely or perhaps only remotely possible for your specific
 
21
game.  However, if a patch has been released, a determination has been made
 
22
that it warrants the hassle of all games applying it, and once a behavior has
 
23
been described, the unscrupulous may choose to exploit it on your game.  Also,
 
24
patches must be applied in order, so even if a specific fix may not apply
 
25
directly to your game, another fix in the same patch or in the next patch
 
26
probably will.
 
27
 
 
28
Let us state that while patching a vanilla server with a patch released by the
 
29
development team is generally considered to be pretty easy, unless you have
 
30
done it before and/or taken time to familiarize yourself with how the patch
 
31
utility works (type 'man patch' inside your shell account or read the
 
32
documentation for dopatch.exe provided with Win32 versions), then we strongly
 
33
advise having someone either walk you through the process or do the work for
 
34
you.  Improper use of patch can cause all kinds of grief that you don't want
 
35
to deal with.
27
36
 
28
37
Applying a patch:
29
38
~~~~~~~~~~~~~~~~
30
39
 
31
 
Before doing anything else, you should assure yourself that have a
32
 
recent and usable backup of the database, all of your config, text,
33
 
mail, and comsystem.  Shutdown the game and use the provided Backup
34
 
script, or db_load by hand.  See BACKUP.  In most cases, this is
35
 
totally unneeded, but if something goes wrong and you didn't, you won't
36
 
be real happy.
 
40
Before doing anything else, you should assure yourself that have a recent and
 
41
usable backup of the database, all of your config, text, mail, and comsystem.
 
42
Shutdown the game and use the provided Backup script, or db_load by hand.  See
 
43
BACKUP.  In most cases, this is totally unneeded, but if something goes wrong
 
44
and you didn't, you won't be real happy.
37
45
 
38
46
 1. Download the patch file to your local shell account somewhere. The
39
47
    location is not critical.
40
48
 
41
 
    The patch file mux-2.4.1.25-2.4.1.26.unix.patch.gz will patch from
42
 
    version 2.4.1.25 to version 2.4.1.26. This patch file is compress
 
49
    The patch file mux-2.6.1.25-2.6.1.26.unix.patch.gz will patch from
 
50
    version 2.6.1.25 to version 2.6.1.26. This patch file is compressed
43
51
    using gzip.
44
52
 
45
53
 2. Optionally, you can decompress the patch files with 'gzip -d' like
46
54
    so:
47
55
 
48
 
    gzip -d mux-2.4.1.25-2.4.1.26.unix.patch.gz
 
56
    gzip -d mux-2.6.1.25-2.6.1.26.unix.patch.gz
49
57
 
50
 
    This will change the filename to mux-2.4.1.25-2.4.1.26.unix.patch.
 
58
    This will change the filename to mux-2.6.1.25-2.6.1.26.unix.patch.
51
59
 
52
60
 3. Change to your game's top-most directory.  For example,
53
61
 
54
 
    cd mux2.4
 
62
    cd mux2.6
55
63
 
56
64
 4. Apply the patch as follows:
57
65
 
58
 
    zcat < ../mux-2.4.1.25-2.4.1.26.unix.patch.gz | patch -p0
 
66
    zcat < ../mux-2.6.1.25-2.6.1.26.unix.patch.gz | patch -p0
59
67
 
60
68
    Or, if you optionally decompressed the patch as described in step
61
69
    2, apply the patch as follows:
62
70
 
63
 
    patch -p0 < ../mux-2.4.1.25-2.4.1.26.unix.patch
64
 
 
65
 
From here, you will usually get to watch a lot of spam fly by as the patch 
66
 
utility modifies the files to be updated.  You might occasionally get a 
67
 
prompt, asking you for either information, or confirmation that you want 
68
 
really do want something applied.  For the inexperienced, this is where 
69
 
having an experienced person at hand to help you is invaluable.  If, at any 
70
 
point in the process, you feel that you are in over your head, stop and get 
71
 
help before continuing!
72
 
 
73
 
After you have successfully patched the source code, then you recompile the 
 
71
    patch -p0 < ../mux-2.6.1.25-2.6.1.26.unix.patch
 
72
 
 
73
From here, you will usually get to watch a lot of spam fly by as the patch
 
74
utility modifies the files to be updated.  You might occasionally get a
 
75
prompt, asking you for either information, or confirmation that you want
 
76
really do want something applied.  For the inexperienced, this is where having
 
77
an experienced person at hand to help you is invaluable.  If, at any point in
 
78
the process, you feel that you are in over your head, stop and get help before
 
79
continuing!
 
80
 
 
81
After you have successfully patched the source code, then you recompile the
74
82
server as usual.
75
83
 
76
84
If you have problems:
77
85
~~~~~~~~~~~~~~~~~~~~
78
86
 
79
87
If the patch fails and you were applying it to a standard beta or release
80
 
version of TinyMUX 2.4, then collect the error messages and report it to
 
88
version of TinyMUX 2.6, then collect the error messages and report it to
81
89
brazilofmux@gmail.com following the bug reporting procedures in README.