~ubuntu-branches/ubuntu/oneiric/eggdrop/oneiric

« back to all changes in this revision

Viewing changes to doc/PATCH-HOWTO

  • Committer: Bazaar Package Importer
  • Author(s): Guilherme de S. Pastore
  • Date: 2004-06-17 09:15:28 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20040617091528-64rrw1sa33lkfhmh
Tags: 1.6.16-2
* Fixed typo on README.Debian
* Fixed hyphens in manual page
* Converted debian/rules to CDBS
* Set path to binary on example config file
* Changed LANGDIR on src/eggdrop.h (Closes: #254824)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Patch Howto
 
2
Last revised: December 07, 2003
 
3
     _________________________________________________________________
 
4
 
 
5
                               Patch Howto
 
6
 
 
7
 
 
8
  The purpose of this document is to show you what a patch is and how you
 
9
  can create, apply, download, and submit a patch.
 
10
 
 
11
  Contents:
 
12
    1. Terms
 
13
    2. Applying a patch
 
14
    3. Creating and submitting a patch
 
15
    4. Downloading a patch
 
16
 
 
17
 
 
18
  1. Terms
 
19
 
 
20
    The following are some common terms used in this document:
 
21
 
 
22
      Patch
 
23
        A patch is an update to the source code of a program (here Eggdrop).
 
24
        Be careful, every patch is designed for a special Eggdrop version
 
25
        and cannot be applied on every bot!
 
26
 
 
27
 
 
28
  2. Applying a patch
 
29
 
 
30
    To apply a patch to an Eggdrop, you have to first obtain the Eggdrop
 
31
    source code. You should always keep a tar.gz archive with the source of
 
32
    your current Eggdrop on your shell. In the next step, you have to change
 
33
    to your source directory (i.e.: /home/user/eggdrop1.6.16/) and type
 
34
    the following command:
 
35
 
 
36
      patch -p1 < ../path.to.the/patch
 
37
 
 
38
    Once this is complete, execute the following command:
 
39
 
 
40
      find . -name "*.rej" -print
 
41
 
 
42
    If it returns a list with filenames ending with .rej extension, then the
 
43
    patch didn't apply properly. Ensure that the patch is intended for your
 
44
    version and that you have the original source. You should also try to
 
45
    re-download the patch to ensure that the patch is not corrupted.
 
46
 
 
47
    If the patch applied properly, the only thing left to do is to recompile
 
48
    your Eggdrop and install the new modules and binaries.
 
49
 
 
50
 
 
51
  3. Creating and submitting a patch
 
52
 
 
53
    If you fixed a bug and/or changed something in Eggdrop's source code, it
 
54
    would be really nice to let the dev team know about it, so they can
 
55
    possibly apply it to next release of Eggdrop.
 
56
 
 
57
    There are several steps to submit a patch to the eggdev team:
 
58
 
 
59
      1. Create a directory with original source tree and one with modified
 
60
         source tree.
 
61
 
 
62
      2. Run the following:
 
63
 
 
64
           diff -urN eggdrop1.6.original eggdrop1.6.modified > patchname.patch
 
65
 
 
66
         DO NOT add any other diff options.
 
67
 
 
68
      3. Send an e-mail to patches@eggheads.org with the patch attached. The
 
69
         body should contain a detailed description of what you changed and
 
70
         why you changed it. Don't forget to include the Eggdrop version for
 
71
         which your patch was created.
 
72
 
 
73
         You should also include the nick/handle/name you would like to be used
 
74
         in the UPDATES1.6 file (if applicable).
 
75
 
 
76
      Never modify src/patch.h or one of the UPDATES files. We will do it. If
 
77
      your patch includes changes related to autotools (./configure, etc), do
 
78
      NOT run autoconf, autoheader, etc; we will do this as well.
 
79
 
 
80
      Also, please don't add credit lines all over the source when patching.
 
81
      Patch contributors will receive credit in UPDATES1.6 and ChangeLog.
 
82
 
 
83
 
 
84
  4. Downloading a patch
 
85
 
 
86
    Many patches for eggdrop1.6.x can be found at the following location:
 
87
 
 
88
      ftp://ftp.eggheads.org/pub/eggdrop/patches/1.6
 
89
     _________________________________________________________________
 
90
 
 
91
   Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004 Eggheads Development Team