maint: consolidate developer debug messages
[platform/upstream/coreutils.git] / README-release
index 6639368..e76adb7 100644 (file)
@@ -7,90 +7,117 @@ Here are most of the steps we (maintainers) follow when making a release.
 * Run ./configure && make maintainer-clean
 
 * Ensure that the desired versions of autoconf, automake, bison, etc.
-  are in your PATH.  See HACKING for the complete list.
+  are in your PATH.  See the buildreq list in bootstrap.conf for
+  the complete list.
 
 * Ensure that you're on "master" with no uncommitted diffs.
   This should produce no output: git checkout master; git diff
 
-* Make sure your local gnulib directory is up to date.
+* Ensure that you've pushed all changes that belong in the release
+  and that the NixOS/Hydra autobuilder is reporting all is well:
 
-* Run bootstrap, (assuming your local copy of gnulib is in /gnulib):
-  ./bootstrap --gnulib-srcdir=/gnulib
+      http://hydra.nixos.org/jobset/gnu/coreutils-master
+
+* Run bootstrap one last time.  This downloads any new translations:
+
+    ./bootstrap
 
 FIXME: enable excluded programs like arch? to get their manual pages?
 
+* Check for new file system types by running the following command on
+  a system with the most recent kernel possible (e.g., Fedora rawhide):
+
+    make -C src fs-magic-compare
+
+  If it finds a new file system magic number, add it to src/stat.c.
+  If it is a remote file system, add the new S_MAGIC_* name you created
+  in stat.c to the list of remote file system types in src/tail.c's
+  fremote function.
+
 * Pre-release testing:
-  On at least one SELinux-enabled (enforcing) and one non-SELinux system,
-    run all tests, both root-only and regular.
-  Run *all* non-root tests, including expensive and very expensive ones i.e.,
-    run this: make -j1 check RUN_VERY_EXPENSIVE_TESTS=yes RUN_EXPENSIVE_TESTS=yes
 
-  Run the root-only tests:
-  sudo env PATH="$PATH" NON_ROOT_USERNAME=$USER make -k check-root
+  Run the following on at least one SELinux-enabled (enforcing) and
+  one non-SELinux system:
+
+    n=$(( ($(nproc) + 1) / 2 ))
+    sudo env PATH="$PATH" NON_ROOT_USERNAME=$USER make -k -j$(nproc) check-root\
+      && make distcheck \
+      && make -j$n check RUN_VERY_EXPENSIVE_TESTS=yes RUN_EXPENSIVE_TESTS=yes
+
+  If testing on systems with a non standard default shell, spurious failures
+  may occur.  Often there are other shells available, and you can select
+  those by using for example, SHELL=bash in the commands above.
+
+  Note that the use of -j$n tells make to use approximately half of the
+  available processing units.  If you use -jN, for larger N, some of the
+  expensive tests are likely to interfere with concurrent performance-measuring
+  or timing-sensitive tests, resulting in spurious failures.
 
-* Run "make distcheck"
+  If "make distcheck" doesn't run "make syntax-check" for you, then run
+  it manually:
 
-* Manually set the date, version number, and [stable/alpha/beta] on
-  line 3 of NEWS, then do e.g.,:
+    make syntax-check
 
-    v=7.3
-    git commit -F <(printf 'version '$v'\n\n* NEWS: Record release date.\n') -a
-    git tag -s -m "coreutils $v" v$v HEAD
+* Set the date, version number, and release type [stable/alpha/beta] on
+  line 3 of NEWS, commit that, and tag the release by running e.g.,
+
+    build-aux/do-release-commit-and-tag X.Y stable
 
 * Run the following to create release tarballs.  Your choice selects the
   corresponding upload-to destination in the emitted gnupload command.
+  The different destinations are specified in cfg.mk.  See the definitions
+  of gnu_ftp_host-{alpha,beta,stable}.
 
-    # "TYPE" must be major, beta or alpha
+    # "TYPE" must be stable, beta or alpha
     make TYPE
 
 * Test the tarball.  copy it to a few odd-ball systems and ensure that
   it builds and passes all tests.
 
 * While that's happening, write the release announcement that you will
-  soon post.
+  soon post.  Start with the template, $HOME/announce-coreutils-X.Y
+  that was just created by that "make" command.
 
 Once all the builds and tests have passed,
 
-* Run the gnupload command suggested by your "XZ_OPT=-9e make major" run above.
+* Run the gnupload command that was suggested by your "make stable" run above.
 
 * Wait a few minutes (maybe up to 30?) and then use the release URLs to
   download all tarball/signature pairs and use gpg --verify to ensure
   that they're all valid.
 
-* Push the new tag:
-  git push origin tag v<JUST_RELEASED_VERSION_NUMBER>
+* Push the NEWS-updating changes and the new tag:
 
-* Send the gpg-signed announcement mail, e.g.,
-    To: info-gnu@gnu.org, coreutils-announce@gnu.org
-    Cc: coordinator@translationproject.org, bug-coreutils@gnu.org
-    Subject: coreutils-7.1 released [stable]
+    v=$(cat .prev-version)
+    git push origin master tag v$v
 
-* Approve the announcement here:
-  http://lists.gnu.org/mailman/admindb/coreutils-announce
+* Announce it on Savannah first, so you can include the preferable
+  savannah.org announcement link in the email message.
 
-* Announce it on Savannah, too:
   From here:
     https://savannah.gnu.org/projects/coreutils/
   click on the "submit news", then write something like the following:
+  (If there is no such button, then enable "News" for the project via
+   the Main -> "Select Features" menu item, or via this link:
+   https://savannah.gnu.org/project/admin/editgroupfeatures.php?group=coreutils)
 
-    Subject: coreutils-7.2 released [stable]
-    The announcement is here:
-      http://article.gmane.org/gmane.comp.gnu.core-utils.announce/49
+    Subject: coreutils-X.Y released [stable]
+    +verbatim+
+    ...paste the announcement here...
+    -verbatim-
 
   Then go here to approve it:
     https://savannah.gnu.org/news/approve.php?group=coreutils
 
-* For non-alpha releases, update the on-line manual at
+* Send the announcement email message.
 
-    http://www.gnu.org/software/coreutils/manual/
+* Approve the announcement here:
+  http://lists.gnu.org/mailman/admindb/coreutils-announce
 
-  Run `make web-manual', then copy the contents of doc/manual
-  into a CVS checkout of the coreutils manual repository.
-  Also edit coreutils.html (FIXME? why?) before doing a CVS commit.
+* After each non-alpha release, update the on-line manual accessible via
+
+    http://www.gnu.org/software/coreutils/manual/
 
-    CVS_RSH=ssh \
-    cvs -d:ext:$USER@cvs.savannah.gnu.org:/web/coreutils co coreutils
+  by running this:
 
-  Be sure to "cvs add -ko" any files that "cvs status" marks with "?".
-  That is necessary whenever a new texinfo node is added.  Each becomes
-  a new file in html_node that must then be "cvs add"ed.
+    build-aux/gnu-web-doc-update