FOR-RELEASE

   1     Copyright 2013-2022 Free Software Foundation, Inc.
   2
   3     Copying and distribution of this file, with or without modification,
   4     are permitted in any medium without royalty provided the copyright
   5     notice and this notice are preserved.
   6
   7 This file describes how to prepare 'groff' for a new release.
   8
   9
  10 ########################################################################
  11
  12 * Update font description files that we generate from external data and
  13   provide with our source distribution.
  14
  15     Directory  Format                  Tool
  16     ---------  ------                  ----
  17     devX*      X11 core/server font    xtotroff
  18
  19   The make(1) target "maintainer-font-descriptions" produces these font
  20   descriptions.
  21
  22 * Retrieve current versions of UnicodeData.txt[1] and the Adobe Glyph
  23   List (AGL)[2], and use them with
  24   src/utils/afmtodit/make-afmtodit-tables to update
  25   src/utils/afmtodit/afmtodit.tables.
  26
  27   [1] E.g., <https://www.unicode.org/Public/15.0.0/ucd/UnicodeData.txt>.
  28       Check for the latest _released_ version of Unicode at the time.
  29       Data for the forthcoming release may be available.
  30   [2] <https://github.com/adobe-type-tools/agl-aglfn/blob/master/\
  31       glyphlist.txt>
  32
  33      (<https://raw.githubusercontent.com/adobe-type-tools/agl-aglfn/\
  34      master/glyphlist.txt> may be more convenient.)
  35
  36 * Update the 'gnulib' sub-module to the latest version and the
  37   corresponding required commit hash identifier in 'INSTALL.REPO'.
  38
  39 * Update the release version number where it is hard-coded.
  40   + NEWS
  41   + BUG-REPORT
  42   + arch/mingw/grap2graph.cmd
  43   + doc/groff.texi (multiple occurrences)
  44   + doc/webpage.ms
  45
  46 * If the major or minor version number is being incremented, split off
  47   a historical ChangeLog file and add it to `EXTRA_DIST` in Makefile.am.
  48
  49 * Update in 'src/roff/groff/groff.cpp' the 'printf' that displays the
  50   copyright.
  51
  52 * Update the copyright year with 'update-copyright.sh'.
  53
  54 * Increment the version number by tagging the release, beta, or release
  55   candidate.  groff requires an explicit three-part version,
  56   major.minor.revision, due to the .Y register.
  57
  58     $ git tag 1.23.0.rc1