X-Git-Url: https://git.saurik.com/bison.git/blobdiff_plain/9126263e13ad3dbc5e5863799c31761757813bcf..80d653fd3009223775dbf7c75fb8fdfb0407b968:/HACKING diff --git a/HACKING b/HACKING index fc135e20..82f07bb4 100644 --- a/HACKING +++ b/HACKING @@ -5,7 +5,7 @@ Don't put this file into the distribution. Everything related to the development of Bison is on Savannah: - http://savannah.gnu.org/projects/bison/ + http://savannah.gnu.org/projects/bison/ * Administrivia @@ -25,6 +25,15 @@ The correct response to most actual bugs is to write a new test case which demonstrates the bug. Then fix the bug, re-run the test suite, and check everything in. +** You may find it useful to install the git-merge-changelog merge driver: + + http://git.sv.gnu.org/gitweb/?p=gnulib.git;a=blob;f=lib/git-merge-changelog.c + +When following the generic installation instructions there, keep in mind that +your clone of Bison's git repository already contains appropriate +.gitattributes files, and running Bison's bootstrap script will make the +necessary changes to .git/config. + * Hacking @@ -38,6 +47,118 @@ of the .output file etc. This excludes impossible error messages meant for the maintainers only. +* Working from the repository + +These notes intend to help people working on the checked-out sources. +These requirements do not apply when building from a distribution tarball. + +** Requirements + +We've opted to keep only the highest-level sources in the repository. +This eases our maintenance burden, (fewer merges etc.), but imposes more +requirements on anyone wishing to build from the just-checked-out sources. +For example, you have to use the latest stable versions of the maintainer +tools we depend upon, including: + +- Automake +- Autoconf +- Flex +- Gettext +- Gzip +- Perl +- Rsync +- Tar + +Valgrind is also highly recommended, if +Valgrind supports your architecture. + +Bison is written using Bison grammars, so there are bootstrapping +issues. The bootstrap script attempts to discover when the C code +generated from the grammars is out of date, and to bootstrap with an +out-of-date version of the C code, but the process is not foolproof. +Also, you may run into similar problems yourself if you modify Bison. + +Only building the initial full source tree will be a bit painful. +Later, after synchronizing from the repository a plain `make' should +be sufficient. + +** First checkout + +Obviously, if you are reading these notes, you did manage to check out +this package from the repository. For the record, you will find all the +relevant information on: + + http://savannah.gnu.org/git/?group=bison + +Bison uses Git submodules: subscriptions to other Git repositories. +In particular it uses gnulib, the GNU portability library. To ask Git +to perform the first checkout of the submodules, run + + $ git submodule update --init + +Git submodule support is weak before versions 1.6 and later, you +should probably upgrade Git if your version is older. + +The next step is to get other files needed to build, which are +extracted from other source packages: + + $ ./bootstrap + +And there you are! Just + + $ ./configure + $ make + $ make check + +At this point, there should be no difference between your local copy, +and the master copy: + + $ git diff + +should output no difference. + +Enjoy! + +** Updating + +The use of submodules make things somewhat different because git does +not support recursive operations: submodules must be taken care of +explicitly by the user. + +*** Updating Bison + +If you pull a newer version of a branch, say via `git pull', you might +import requests for updated submodules. A simple `git diff' will +reveal if the current version of the submodule (i.e., the actual +contents of the gnulib directory) and the current request from the +subscriber (i.e., the reference of the version of gnulib that the +Bison reporitory requests) differ. To upgrade the submodules (i.e., +to check out the version that is actually requested by the subscriber, +run `git submodule update'. + + $ git pull + $ git submodule update + +*** Updating a submodule +To update a submodule, say gnulib, do as follows: + +Get the most recent version of the master branch from git. + + $ cd gnulib + $ git fetch + $ git checkout -b master --track origin/master + +Make sure Bison can live with that version of gnulib. + + $ cd .. + $ ./bootstrap + $ make distcheck + +Register your changes. + + $ git checkin ... + + * Test suite ** make check @@ -71,8 +192,7 @@ release: - Change tests/atlocal/CFLAGS to add your preferred options. For instance, `-traditional' to check that the parsers are K&R. Note that it does not make sense for glr.c, which should be ANSI, - but currently is actually GNU C, nor for lalr1.cc, which anyway is - not exercised yet in the test suite. + but currently is actually GNU C, nor for lalr1.cc. * Release Procedure @@ -89,35 +209,130 @@ This covers PO files too. Sometimes a PO file contains problems that causes it to be rejected by recent Gettext releases; please report these to the Translation Project. +** Update README +Make sure the information in this file is current. Most notably, make sure it +recommends a version of GNU M4 that is compatible with the latest Bison +sources. + ** Update NEWS The version number, *and* the date of the release (including for betas). ** Update ChangeLog Should have an entry similar to `Version 1.49b.'. -Check all this in once `make distcheck' passes. + +** Update configure.ac +Be sure PACKAGE_COPYRIGHT_YEAR is up-to-date. + +** Tag the release +Before Bison will build with the right version number, you must tag the release +in git. Do this after all other changes. The command is similar to: + + git tag -a v2.3b + +The log message can be simply: + + Bison 2.3b + +** Push +Once `make distcheck' passes, push your changes and the tag. +`git push' without arguments will not push the tag. ** make alpha +FIXME: `make alpha' is not maintained and is broken. These +instructions need to be replaced or removed. + Running `make alpha' is absolutely perfect for beta releases: it makes the tarballs, the xdeltas, and prepares (in /tmp/) a proto announcement. It is so neat, that that's what I use anyway for genuine releases, but adjusting things by hand (e.g., the urls in the announcement file, the ChangeLog which is not needed etc.). -FIXME: `make alpha' is not maintained and is broken. These -instructions need to be replaced or removed. If it fails, you're on your own... It requires GNU Make. ** Upload -Put the tarballs/xdeltas where they should be. Or put it somewhere, -and send the URL to ftp-upload@gnu.org. +The generic GNU upload procedure is at: -** Bump the version number -In configure.ac. Run `make', check this in. + http://www.gnu.org/prep/maintain/maintain.html#Automated-FTP-Uploads + +Follow the instructions there to register your information so you're permitted +to upload. Make sure your public key has been uploaded at least to +keys.gnupg.net. You can upload it with: + + gpg --keyserver keys.gnupg.net --send-keys F125BDF3 + +where F125BDF3 should be replaced with your key ID. + +Here's a brief reminder of how to roll the tarballs and upload them: + +*** make distcheck +*** gpg -b bison-2.3b.tar.gz +*** In a file named `bison-2.3b.tar.gz.directive', type: + + version: 1.1 + directory: bison + filename: bison-2.3b.tar.gz + +*** gpg --clearsign bison-2.3b.tar.gz.directive +*** ftp ftp-upload.gnu.org # Log in as anonymous. +*** cd /incoming/alpha # cd /incoming/ftp for full release. +*** put bison-2.3b.tar.gz # This can take a while. +*** put bison-2.3b.tar.gz.sig +*** put bison-2.3b.tar.gz.directive.asc +*** Repeat all these steps for bison-2.3b.tar.bz2. + +** Update Bison manual on www.gnu.org. + +*** You need a non-anonymous checkout of the web pages directory. + + $ cvs -d YOUR_USERID@cvs.savannah.gnu.org:/web/bison checkout bison + +*** Get familiar with the instructions for web page maintainers. +http://www.gnu.org/server/standards/readme_index.html +http://www.gnu.org/server/standards/README.software.html +especially the note about symlinks. + +*** Build the web pages. +Assuming BISON_CHECKOUT refers to a checkout of the Bison dir, and +BISON_WWW_CHECKOUT refers to the web directory created above, do: + + $ cd $BISON_CHECKOUT/doc + $ make stamp-vti + $ ../build-aux/gendocs.sh -o "$BISON_WWW_CHECKOUT/manual" \ + bison "Bison - GNU parser generator" + $ cd $BISON_WWW_CHECKOUT + +Verify that the result looks sane. + +*** Commit the modified and the new files. + +*** Remove old files. +Find the files which have not been overwritten (because they belonged to +sections that have been removed or renamed): + + $ cd manual/html_node + $ ls -lt + +Remove these files and commit their removal to CVS. For each of these +files, add a line to the file .symlinks. This will ensure that +hyperlinks to the removed files will redirect to the entire manual; this +is better than a 404 error. + +There is a problem with 'index.html' being written twice (once for POSIX +function 'index', once for the table of contents); you can ignore this +issue. ** Announce +To generate a template announcement file: + + make RELEASE_TYPE=alpha gpg_key_ID=F125BDF3 announcement + +where alpha can be replaced by beta or major and F125BDF3 should be replaced +with your key ID. For an example of how to fill out the template, search the +mailing list archives for the most recent release announcement. + Complete/fix the announcement file, and send it at least to info-gnu@gnu.org (if a real release, or a ``serious beta''), bug-bison@gnu.org, help-bison@gnu.org, bison-patches@gnu.org, @@ -128,10 +343,19 @@ email to compilers@iecc.com. Do not make any Cc as the moderator will throw away anything cross-posted or Cc'ed. It really needs to be a separate message. +** Bump the version number +In configure.ac. Run `make'. So that developers don't accidentally add new +items to the old NEWS entry, create a new empty NEWS entry something like: + + Changes in version ?.? (????-??-??): + +Push these changes. + ----- -Copyright (C) 2002, 2003, 2004, 2005, 2007, 2008 Free Software Foundation, Inc. +Copyright (C) 2002, 2003, 2004, 2005, 2007, 2008, 2009 +Free Software Foundation, Inc. This file is part of GNU Bison.