HACKING

   1 -*- outline -*-
   2
   3 This file attempts to describe the maintainer-specific notes to follow
   4 when hacking Autoconf.  Don't put this file into the distribution.
   5 Don't mention it in the ChangeLog.  You may want to first see
   6 README-hacking for more general rules on building Autoconf from
   7 checked-out sources.
   8
   9 * Administrivia
  10
  11 ** If you incorporate a change from somebody on the net:
  12 First, if it is a large change, you must make sure they have signed
  13 the appropriate paperwork.  Second, be sure to add their name and
  14 email address to THANKS.
  15
  16 ** Test fixes
  17 If a change fixes a test, mention the test in the ChangeLog entry.
  18 To this end, the Autotest-mode is handy.
  19
  20 ** Bug reports
  21 If somebody reports a new bug, mention his name in the ChangeLog entry
  22 and in the test case you write.  Put him into THANKS.
  23
  24 The correct response to most actual bugs is to write a new test case
  25 which demonstrates the bug.  Then fix the bug, re-run the test suite,
  26 and check everything in.
  27
  28 ** Visible changes
  29 Which include serious bug fixes, must be mentioned in NEWS.
  30
  31 ** Portability issues
  32 Discoveries in portability matters should be written down in the
  33 documentation (what fails, why it fails, *where* it fails, and what's
  34 to be written instead?).
  35
  36 ** Allow bootstrapping
  37 Make sure that a fresh checkout of Autoconf can be bootstrapped using
  38 the previous stable release of Autoconf.  In other words, do not use
  39 newly-added features in configure.ac if doing so would require an
  40 installed git checkout to rerun `autoreconf -i' successfully.
  41
  42 * Test suite
  43
  44 ** make check
  45 Use liberally.
  46
  47 ** Release checks
  48 Try to run the test suite with more severe conditions before a
  49 release:
  50
  51 - Run `make syntax-check'
  52   This makes sure that the source files follow some consistent rules.
  53   The checks live in maint.mk, shared from gnulib, and customized in
  54   cfg.mk.
  55
  56 - Run `make distcheck'
  57
  58 - Test some unusual environments, such as building and running the
  59   testsuite with POSIXLY_CORRECT=1 CC=g++.
  60
  61 - Try some real world packages
  62   A good example is the coreutils package.
  63
  64 * Release Procedure
  65 These steps describe what a maintainer does to make a release; they
  66 are not needed for ordinary patch submission.
  67
  68 ** Upload Privileges
  69 If you have not yet registered your gpg public key and (preferred)
  70 email address with the FSF in relation to the Autoconf package, send
  71 an email, preferably GPG-signed, to <ftp-upload@gnu.org> that includes
  72 the following:
  73
  74   (a) name of package(s) that you are the maintainer for, and your
  75       preferred email address.
  76
  77   (b) an ASCII armored copy of your GnuPG key, as an attachment.
  78       ("gpg --export -a YOUR_KEY_ID > mykey.asc" should give you
  79       this.)
  80
  81 When you have received acknowledgement of your message, the proper GPG
  82 keys will be registered on ftp-upload.gnu.org and only then will you
  83 be authorized to upload files to the FSF ftp machines.  Beware; this
  84 process can take several days.
  85
  86 ** Mailing list Admin Privileges
  87 If you do not have access to the mailing list administrative
  88 interface, approach the list owners for the password.  Be sure to
  89 check the lists (esp. bug-autoconf) for outstanding bug reports also
  90 in the list of pending moderation requests.  This step is not strictly
  91 necessary, but helps.
  92
  93 ** Preparation for release
  94 Make sure you have GNU make installed.  Make sure your PATH includes a
  95 Automake 1.11 or later (preferably not a development snapshot).  Make
  96 sure your locale is sane, e.g. by exporting LC_ALL=C.  Bootstrap the
  97 checkout, and make sure the testsuite passes.  See above for more
  98 hints on the testsuite.  If needed, update cfg.mk with details
  99 specific to your environment, such as the location of a gnulib checkout.
 100
 101 ** Update the foreign files
 102 Running `make fetch' in the top level should grab it all for you; you
 103 should check the results before committing them in git.
 104
 105 ** Set the version number
 106 Update the version number in NEWS (with version, date, and release
 107 type) and ChangeLog, and mention in README whether the release is
 108 stable.  Make sure all changes are committed, then run `git tag -s -m
 109 <version> -u <gpg_key> v<version>'.  Do not push anything upstream at
 110 this point.
 111
 112 ** Update configure
 113 As much as possible, make sure to release an Autoconf that uses
 114 itself.  That's easy: just be in the top level, and run
 115 `tests/autoconf'.  Or install this autoconf and run `autoreconf -f'.
 116
 117 ** Make the release
 118 Run `make {alpha,beta,stable}' depending on which type of release this
 119 is.  This runs the various checks, creates delta files, creates a
 120 preliminary announcement in ~/announce-autoconf-<version>, prints
 121 out the command to upload the files, and updates the previous version
 122 file.
 123
 124 If it fails, run `git tag -d v<version>', fix the problems, and go
 125 back to the step of setting the version.
 126
 127 ** Upload
 128 Put the tarballs where they should be, using the instructions
 129 regarding gnupload that were printed during the previous step.  Verify
 130 that the files are correctly uploaded before sending a release
 131 announcement.
 132
 133 ** Push the updates
 134 Run `git push origin refs/tags/v<version>' to push the release tag.
 135
 136 ** Announce
 137 Complete/fix the announcement file, and email it at least to
 138 autoconf@gnu.org and autotools-announce@gnu.org.  If this is a stable
 139 release, also mail to info-gnu@gnu.org; if it is a beta release,
 140 also mail to platform-testers@gnu.org.
 141
 142 ** Other web updates
 143 For alpha and beta releases, the process is complete.  For stable
 144 releases, there are several other web pages that need updates.
 145
 146 Update the online manual: Run `make web-manual', then copy the
 147 contents of doc/manual into a CVS checkout of the documentation
 148 repository.  Remember to use `cvs add -ko' so that RCS keywords in the
 149 generated output do not get expanded improperly.
 150   $ export CVS_RSH=ssh
 151   $ cvs -z3 -d:ext:<user>@cvs.sv.gnu.org:/web/autoconf co autoconf
 152
 153 Post a news blurb on https://savannah.gnu.org/projects/autoconf.
 154
 155 Update the Free Software Directory: browse to:
 156   https://directory.fsf.org/project/autoconf/
 157 and send an email to <bug-directory@gnu.org> mentioning any content
 158 that needs to be updated.
 159
 160 -----
 161
 162 Copyright (C) 2002, 2008-2017 Free Software Foundation, Inc.
 163
 164 Copying and distribution of this file, with or without modification,
 165 are permitted in any medium without royalty provided the copyright
 166 notice and this notice are preserved.  This file is offered as-is,
 167 without warranty of any kind.