HACKING

   1 -*- mode: text; -*-
   2
   3 $Id: HACKING,v 1.11 2004/11/15 17:29:11 gdt Exp $
   4
   5 GUIDELINES FOR HACKING ON QUAGGA
   6
   7 [this is a draft in progress]
   8
   9 GNU coding standards apply.  Indentation follows the result of
  10 invoking GNU indent (as of 2.2.8a) with no arguments.  Note that this
  11 uses tabs instead of spaces where possible for leading whitespace, and
  12 assumes that tabs are every 8 columns.  Do not attempt to redefine the
  13 location of tab stops.  Note also that some indentation does not
  14 follow GNU style.  This is a historical accident, and we generally
  15 only clean up whitespace when code is unmaintainable due to whitespace
  16 issues, as fewer changes from zebra lead to easier merges.
  17
  18 For GNU emacs, use indentation style "gnu".
  19
  20 For Vim, use the following lines (note that tabs are at 8, and that
  21 softtabstop sets the indentation level):
  22
  23 set tabstop=8
  24 set softtabstop=2
  25 set shiftwidth=2
  26 set noexpandtab
  27
  28 Be particularly careful not to break platforms/protocols that you
  29 cannot test.
  30
  31 New code should have good comments, and changes to existing code
  32 should in many cases upgrade the comments when necessary for a
  33 reviewer to conclude that the change has no unintended consequences.
  34
  35 CHANGELOG
  36
  37 Add a ChangeLog entry whenever changing code, except for minor fixes
  38 to a commit (with a ChangeLog entry) within the last few days.
  39
  40 Most directories have a ChangeLog file; changes to code in that
  41 directory should go in the per-directory ChangeLog.  Global or
  42 structural changes should also be mentioned in the top-level
  43 ChangeLog.
  44
  45 Certain directories do not contain project code, but contain project
  46 meta-data, eg packaging information, changes to files in these directory may
  47 not require the global ChangeLog to be updated (at the discretion of the
  48 maintainer who usually maintains that meta-data). Also, CVS meta-data such
  49 as cvsignore files do not require ChangeLog updates, just a sane commit
  50 message.
  51
  52 TOOL VERSIONS
  53
  54 Require versions of support tools are listed in INSTALL.quagga.txt.
  55 Required versions should only be done with due deliberation, as it can
  56 cause environments to no longer be able to compile quagga.
  57
  58 SHARED LIBRARY VERSIONING
  59
  60 [this section is at the moment just gdt's opinion]
  61
  62 Quagga builds several shared libaries (lib/libzebra, ospfd/libospf,
  63 ospfclient/libsopfapiclient).  These may be used by external programs,
  64 e.g. a new routing protocol that works with the zebra daemon, or
  65 ospfapi clients.  The libtool info pages (node Versioning) explain
  66 when major and minor version numbers should be changed.  These values
  67 are set in Makefile.am near the definition of the library.  If you
  68 make a change that requires changing the shared library version,
  69 please update Makefile.am.
  70
  71 libospf exports far more than it should, and is needed by ospfapi
  72 clients.  Only bump libospf for changes to functions for which it is
  73 reasonable for a user of ospfapi to call, and please err on the side
  74 of not bumping.
  75
  76 There is no support intended for installing part of zebra.  The core
  77 library libzebra and the included daemons should always be built and
  78 installed together.
  79
  80 PATCH SUBMISSION
  81
  82 * Send a clean diff against the head of CVS in unified diff format, eg by:
  83   cvs <cvs opts> diff -uwb ....
  84
  85 * Include ChangeLog and NEWS entries as appropriate before the patch
  86   (or in it if you are 100% up to date).
  87
  88 * Include only one semantic change or group of changes per patch.
  89
  90 * Do not make gratuitous changes to whitespace. See the w and b arguments
  91   to diff.
  92
  93 * State on which platforms and with what daemons the patch has been
  94   tested.  Understand that if the set of testing locations is small,
  95   and the patch might have unforeseen or hard to fix consequences that
  96   there may be a call for testers on quagga-dev, and that the patch
  97   may be blocked until test results appear.
  98
  99   If there are no users for a platform on quagga-dev who are able and
 100   willing to verify -current occasionally, that platform may be
 101   dropped from the "should be checked" list.
 102
 103 PATCH APPLICATION TO CVS
 104
 105 * Only apply patches that meet the submission guidelines.
 106
 107 * If a patch is large (perhaps more than 100 new/changed lines), tag
 108   the repository before and after the change with e.g. before-foo-fix
 109   and after-foo-fix.
 110
 111 * If the patch might break something, issue a call for testing on the
 112   mailinglist.
 113
 114 * Give an appropriate commit message, eg the ChangeLog entry should suffice,
 115   if it does not, then the ChangeLog entry itself needs to be corrected. The
 116   commit message text should be identical to that added to the ChangeLog
 117   message. (One suggestion: when commiting, use your editor to read in the
 118   ChangeLog and delete all previous ChangeLogs.)
 119
 120 * By committing a patch, you are responsible for fixing problems
 121   resulting from it (or backing it out).
 122
 123 STABLE PLATFORMS AND DAEMONS
 124
 125 The list of platforms that should be tested follow.  This is a list
 126 derived from what quagga is thought to run on and for which
 127 maintainers can test or there are people on quagga-dev who are able
 128 and willing to verify that -current does or does not work correctly.
 129
 130   BSD (Free, Net or Open, any platform) # without capabilities
 131   GNU/Linux (any distribution, i386)
 132   Solaris (strict alignment, any platform)
 133   [future: NetBSD/sparc64]
 134
 135 The list of daemons that are thought to be stable and that should be
 136 tested are:
 137
 138   zebra
 139   bgpd
 140   ripd
 141   ospfd
 142   ripngd
 143
 144 Daemons which are in a testing phase are
 145
 146   ospf6d
 147   isisd
 148
 149 IMPORT OR UPDATE VENDOR SPECIFIC ROUTING PROTOCOLS
 150
 151 The source code of Quagga is based on two vendors:
 152
 153    zebra_org (http://www.zebra.org/)
 154    isisd_sf (http://isisd.sf.net/)
 155
 156 [20041105: Is isisd.sf.netf still where isisd word is happening, or is
 157 the quagga repo now the canonical place?  The last tarball on sf is
 158 two years old.  --gdt]
 159
 160 In order to import source code, the following procedure should be used:
 161
 162 * Tag the Current Quagga CVS repository:
 163
 164     cvs tag import_isisd_sf_20031223
 165
 166 * Import the source code into the Quagga's framework. You must not modified
 167   this source code. It will be merged later.
 168
 169     cd dir_isisd
 170     export CVSROOT=:pserver:LOGIN@anoncvs.quagga.net:/var/cvsroot
 171     cvs import quagga/isisd isisd_sf isisd_sf_20031223
 172   ---COMMENTS---
 173     Vendor: [isisd_sf] Sampo's ISISd from Sourceforge
 174     Tag: [isisd_sf_20031217] Current CVS release
 175   ---
 176
 177 * Update your Quagga's directory:
 178
 179     cd dir_quagga
 180     cvs update -dP
 181
 182   or
 183
 184     cvs co -d quagga_isisd quagga
 185
 186 * Merge the code, then commit:
 187
 188     cvs commit
 189