gnupg/README.maint

            Notes for the GnuPG maintainer  (GIT only)
           ============================================

Here are some notes on how to maintain GnuPG.

Release Planning:
=================

If you are planning a new release and strings have changed you should
send a notification to all translators, so that they have time to
update their translations.  scripts/mail-to-translators is useful for
this.  It might need some tweaking and it needs to be armored for
actual sending.  Running it as is to see what will happen is a good
idea, though.


Release process:
================

  * Make sure that all new PO files are checked in.

  * Decide whether you want to update the automake standard files
    (Mainly config.guess and config.sub).

  * [2.0] Copy needed texinfo files from master:
      make -C doc update-source

  * Run:
      make -C po update-po

  * Write NEWS entries and set the release date in NEWS.

  * Commit all changes to GIT with a message of "Release n.m.o."

  * Create a signed tag with the name "gnupg-x.y.z".

  * Run "./autogen.sh --force"
    (--force is required for the git magic in configure.ac and a good
    idea in any case)

  * Run "configure --enable-maintainer-mode".

  * Run "make distcheck".

  * Build and test the new tarball (best on a different machine).

  * Build and test the W32 version.

  * [2.x only] Using the final test build run a "make -C doc online".

  * Sign the tarball

  * Get the previous tarball and run "mkdiff gnupg".
    You might need to set a different signature key than mine.  mkdiff
    has an option for this.

  * Push the git changes and the tag.

  * Copy the files to the FTP server

  * Update the webpages - at least the file swdb.mac needs an update.

  * Add a new headline to NEWS.

  * Bump the version number in configure.ac up, add an empty NEWS
    entry, commit, and push that.

  * Write an announcement.

  * Update https://savannah.gnu.org/projects/gnupg .


Gotchas
=======

- If during "make distcheck" you get an error about a permission
  problem moving foo.new.po to foo.po; this is caused by a check
  whether the po files can be re-created.  Now if the first tarball
  has been created in a different top directory and if there exists a
  no distributed file with the string "GNU gnupg" (e.g. a log file
  from running make) you end up with different comments in the po
  files.  Check out /usr/lib/gettext/project-id for that silliness.
  As a hack we added this string into configure.ac.
Adjust maintainer instructions 2011-01-03 16:25:27 +01:00			`Notes for the GnuPG maintainer (GIT only)`
Add new SVN only file README.maint doc/ * gpg.texi (GPG Configuration): Document envvar LANGUAGE. (GPG Configuration Options): Document show-primary-uid-only. g10/ * gpg.c (main): Add verify option show-primary-uid-only. * options.h (VERIFY_SHOW_PRIMARY_UID_ONLY): New. * mainproc.c (check_sig_and_print): Implement it. * encr-data.c (decrypt_data): Correctly test for unknown algorithm. * import.c (check_prefs): Ditto. * keyedit.c (show_prefs): Ditto. * mainproc.c (proc_symkey_enc): Ditto. 2007-02-26 20:24:29 +00:00			`============================================`

			`Here are some notes on how to maintain GnuPG.`

g10/ and sm/ * call-agent.c (start_agent): Don't use log_error when using the fallback hack to start the agent. This is bug 782. scripts/ * mail-to-translators: Copied from 1.4. and adjusted. tools/ * gpgconf-comp.c: Allow changing of --allow-mark-trusted. * gpg-connect-agent.c (main): New option --decode and commands decode and undecode. (read_and_print_response): Implement option. 2007-04-13 11:45:05 +00:00			`Release Planning:`
			`=================`

			`If you are planning a new release and strings have changed you should`
Preparing a release. 2007-12-20 08:52:40 +00:00			`send a notification to all translators, so that they have time to`
g10/ and sm/ * call-agent.c (start_agent): Don't use log_error when using the fallback hack to start the agent. This is bug 782. scripts/ * mail-to-translators: Copied from 1.4. and adjusted. tools/ * gpgconf-comp.c: Allow changing of --allow-mark-trusted. * gpg-connect-agent.c (main): New option --decode and commands decode and undecode. (read_and_print_response): Implement option. 2007-04-13 11:45:05 +00:00			`update their translations. scripts/mail-to-translators is useful for`
			`this. It might need some tweaking and it needs to be armored for`
			`actual sending. Running it as is to see what will happen is a good`
			`idea, though.`


Add new SVN only file README.maint doc/ * gpg.texi (GPG Configuration): Document envvar LANGUAGE. (GPG Configuration Options): Document show-primary-uid-only. g10/ * gpg.c (main): Add verify option show-primary-uid-only. * options.h (VERIFY_SHOW_PRIMARY_UID_ONLY): New. * mainproc.c (check_sig_and_print): Implement it. * encr-data.c (decrypt_data): Correctly test for unknown algorithm. * import.c (check_prefs): Ditto. * keyedit.c (show_prefs): Ditto. * mainproc.c (proc_symkey_enc): Ditto. 2007-02-26 20:24:29 +00:00
			`Release process:`
			`================`

			`* Make sure that all new PO files are checked in.`
Update the maintenance instructions. -- 2012-03-27 11:21:33 +02:00
Nuked almost all trailing white space. We better do this once and for all instead of cluttering all future commits with diffs of trailing white spaces. In the majority of cases blank or single lines are affected and thus this change won't disturb a git blame too much. For future commits the pre-commit scripts checks that this won't happen again. 2011-02-04 12:57:53 +01:00			`* Decide whether you want to update the automake standard files`
Add new SVN only file README.maint doc/ * gpg.texi (GPG Configuration): Document envvar LANGUAGE. (GPG Configuration Options): Document show-primary-uid-only. g10/ * gpg.c (main): Add verify option show-primary-uid-only. * options.h (VERIFY_SHOW_PRIMARY_UID_ONLY): New. * mainproc.c (check_sig_and_print): Implement it. * encr-data.c (decrypt_data): Correctly test for unknown algorithm. * import.c (check_prefs): Ditto. * keyedit.c (show_prefs): Ditto. * mainproc.c (proc_symkey_enc): Ditto. 2007-02-26 20:24:29 +00:00			`(Mainly config.guess and config.sub).`
Update the maintenance instructions. -- 2012-03-27 11:21:33 +02:00
build: Update README.maint. -- Also fixed some typos. 2014-11-05 08:42:56 +01:00			`* [2.0] Copy needed texinfo files from master:`
Update the maintenance instructions. -- 2012-03-27 11:21:33 +02:00			`make -C doc update-source`

			`* Run:`
			`make -C po update-po`

Add new SVN only file README.maint doc/ * gpg.texi (GPG Configuration): Document envvar LANGUAGE. (GPG Configuration Options): Document show-primary-uid-only. g10/ * gpg.c (main): Add verify option show-primary-uid-only. * options.h (VERIFY_SHOW_PRIMARY_UID_ONLY): New. * mainproc.c (check_sig_and_print): Implement it. * encr-data.c (decrypt_data): Correctly test for unknown algorithm. * import.c (check_prefs): Ditto. * keyedit.c (show_prefs): Ditto. * mainproc.c (proc_symkey_enc): Ditto. 2007-02-26 20:24:29 +00:00			`* Write NEWS entries and set the release date in NEWS.`
Update the maintenance instructions. -- 2012-03-27 11:21:33 +02:00
			`* Commit all changes to GIT with a message of "Release n.m.o."`

build: Update README.maint. -- Also fixed some typos. 2014-11-05 08:42:56 +01:00			`* Create a signed tag with the name "gnupg-x.y.z".`
Switch to the new automagic beta numbering scheme. * configure.ac: Add all the require m4 magic. -- This also removes the hack to allow custom version numbers which are not considered a development version. A custom version number can be done anyway by simply setting the version to it and tag the release with it. 2012-05-11 10:20:29 +02:00
Add new SVN only file README.maint doc/ * gpg.texi (GPG Configuration): Document envvar LANGUAGE. (GPG Configuration Options): Document show-primary-uid-only. g10/ * gpg.c (main): Add verify option show-primary-uid-only. * options.h (VERIFY_SHOW_PRIMARY_UID_ONLY): New. * mainproc.c (check_sig_and_print): Implement it. * encr-data.c (decrypt_data): Correctly test for unknown algorithm. * import.c (check_prefs): Ditto. * keyedit.c (show_prefs): Ditto. * mainproc.c (proc_symkey_enc): Ditto. 2007-02-26 20:24:29 +00:00			`* Run "./autogen.sh --force"`
Switch to the new automagic beta numbering scheme. * configure.ac: Add all the require m4 magic. -- This also removes the hack to allow custom version numbers which are not considered a development version. A custom version number can be done anyway by simply setting the version to it and tag the release with it. 2012-05-11 10:20:29 +02:00			`(--force is required for the git magic in configure.ac and a good`
Add new SVN only file README.maint doc/ * gpg.texi (GPG Configuration): Document envvar LANGUAGE. (GPG Configuration Options): Document show-primary-uid-only. g10/ * gpg.c (main): Add verify option show-primary-uid-only. * options.h (VERIFY_SHOW_PRIMARY_UID_ONLY): New. * mainproc.c (check_sig_and_print): Implement it. * encr-data.c (decrypt_data): Correctly test for unknown algorithm. * import.c (check_prefs): Ditto. * keyedit.c (show_prefs): Ditto. * mainproc.c (proc_symkey_enc): Ditto. 2007-02-26 20:24:29 +00:00			`idea in any case)`
Update the maintenance instructions. -- 2012-03-27 11:21:33 +02:00
Preparing 2.0.7 2007-09-10 15:40:29 +00:00			`* Run "configure --enable-maintainer-mode".`
Update the maintenance instructions. -- 2012-03-27 11:21:33 +02:00
Preparing 2.0.7 2007-09-10 15:40:29 +00:00			`* Run "make distcheck".`
Update the maintenance instructions. -- 2012-03-27 11:21:33 +02:00
Add new SVN only file README.maint doc/ * gpg.texi (GPG Configuration): Document envvar LANGUAGE. (GPG Configuration Options): Document show-primary-uid-only. g10/ * gpg.c (main): Add verify option show-primary-uid-only. * options.h (VERIFY_SHOW_PRIMARY_UID_ONLY): New. * mainproc.c (check_sig_and_print): Implement it. * encr-data.c (decrypt_data): Correctly test for unknown algorithm. * import.c (check_prefs): Ditto. * keyedit.c (show_prefs): Ditto. * mainproc.c (proc_symkey_enc): Ditto. 2007-02-26 20:24:29 +00:00			`* Build and test the new tarball (best on a different machine).`
Update the maintenance instructions. -- 2012-03-27 11:21:33 +02:00
Updated estream. More changes for Windows. 2007-08-22 10:55:07 +00:00			`* Build and test the W32 version.`
Update the maintenance instructions. -- 2012-03-27 11:21:33 +02:00
Preparing a release. 2007-12-20 08:52:40 +00:00			`* [2.x only] Using the final test build run a "make -C doc online".`
Update the maintenance instructions. -- 2012-03-27 11:21:33 +02:00
Add new SVN only file README.maint doc/ * gpg.texi (GPG Configuration): Document envvar LANGUAGE. (GPG Configuration Options): Document show-primary-uid-only. g10/ * gpg.c (main): Add verify option show-primary-uid-only. * options.h (VERIFY_SHOW_PRIMARY_UID_ONLY): New. * mainproc.c (check_sig_and_print): Implement it. * encr-data.c (decrypt_data): Correctly test for unknown algorithm. * import.c (check_prefs): Ditto. * keyedit.c (show_prefs): Ditto. * mainproc.c (proc_symkey_enc): Ditto. 2007-02-26 20:24:29 +00:00			`* Sign the tarball`
Update the maintenance instructions. -- 2012-03-27 11:21:33 +02:00
Nuked almost all trailing white space. We better do this once and for all instead of cluttering all future commits with diffs of trailing white spaces. In the majority of cases blank or single lines are affected and thus this change won't disturb a git blame too much. For future commits the pre-commit scripts checks that this won't happen again. 2011-02-04 12:57:53 +01:00			`* Get the previous tarball and run "mkdiff gnupg".`
Add new SVN only file README.maint doc/ * gpg.texi (GPG Configuration): Document envvar LANGUAGE. (GPG Configuration Options): Document show-primary-uid-only. g10/ * gpg.c (main): Add verify option show-primary-uid-only. * options.h (VERIFY_SHOW_PRIMARY_UID_ONLY): New. * mainproc.c (check_sig_and_print): Implement it. * encr-data.c (decrypt_data): Correctly test for unknown algorithm. * import.c (check_prefs): Ditto. * keyedit.c (show_prefs): Ditto. * mainproc.c (proc_symkey_enc): Ditto. 2007-02-26 20:24:29 +00:00			`You might need to set a different signature key than mine. mkdiff`
			`has an option for this.`
Update the maintenance instructions. -- 2012-03-27 11:21:33 +02:00
Switch to the new automagic beta numbering scheme. * configure.ac: Add all the require m4 magic. -- This also removes the hack to allow custom version numbers which are not considered a development version. A custom version number can be done anyway by simply setting the version to it and tag the release with it. 2012-05-11 10:20:29 +02:00			`* Push the git changes and the tag.`
Update the maintenance instructions. -- 2012-03-27 11:21:33 +02:00
Add new SVN only file README.maint doc/ * gpg.texi (GPG Configuration): Document envvar LANGUAGE. (GPG Configuration Options): Document show-primary-uid-only. g10/ * gpg.c (main): Add verify option show-primary-uid-only. * options.h (VERIFY_SHOW_PRIMARY_UID_ONLY): New. * mainproc.c (check_sig_and_print): Implement it. * encr-data.c (decrypt_data): Correctly test for unknown algorithm. * import.c (check_prefs): Ditto. * keyedit.c (show_prefs): Ditto. * mainproc.c (proc_symkey_enc): Ditto. 2007-02-26 20:24:29 +00:00			`* Copy the files to the FTP server`
Update the maintenance instructions. -- 2012-03-27 11:21:33 +02:00
build: Update README.maint. -- Also fixed some typos. 2014-11-05 08:42:56 +01:00			`* Update the webpages - at least the file swdb.mac needs an update.`
Update the maintenance instructions. -- 2012-03-27 11:21:33 +02:00
Add new SVN only file README.maint doc/ * gpg.texi (GPG Configuration): Document envvar LANGUAGE. (GPG Configuration Options): Document show-primary-uid-only. g10/ * gpg.c (main): Add verify option show-primary-uid-only. * options.h (VERIFY_SHOW_PRIMARY_UID_ONLY): New. * mainproc.c (check_sig_and_print): Implement it. * encr-data.c (decrypt_data): Correctly test for unknown algorithm. * import.c (check_prefs): Ditto. * keyedit.c (show_prefs): Ditto. * mainproc.c (proc_symkey_enc): Ditto. 2007-02-26 20:24:29 +00:00			`* Add a new headline to NEWS.`
Update the maintenance instructions. -- 2012-03-27 11:21:33 +02:00
build: Update README.maint. -- Also fixed some typos. 2014-11-05 08:42:56 +01:00			`* Bump the version number in configure.ac up, add an empty NEWS`
			`entry, commit, and push that.`
Update the maintenance instructions. -- 2012-03-27 11:21:33 +02:00
			`* Write an announcement.`

			`* Update https://savannah.gnu.org/projects/gnupg .`
New scd getinfo subcommand deny_admin 2009-02-12 17:45:40 +00:00
Add new SVN only file README.maint doc/ * gpg.texi (GPG Configuration): Document envvar LANGUAGE. (GPG Configuration Options): Document show-primary-uid-only. g10/ * gpg.c (main): Add verify option show-primary-uid-only. * options.h (VERIFY_SHOW_PRIMARY_UID_ONLY): New. * mainproc.c (check_sig_and_print): Implement it. * encr-data.c (decrypt_data): Correctly test for unknown algorithm. * import.c (check_prefs): Ditto. * keyedit.c (show_prefs): Ditto. * mainproc.c (proc_symkey_enc): Ditto. 2007-02-26 20:24:29 +00:00
Avoid catch-22 with README.main not being distributed but having the project-id marker string. 2009-09-04 17:21:40 +00:00
Add a gotcha section after trapped again. 2009-09-04 17:11:38 +00:00			`Gotchas`
			`=======`

			`- If during "make distcheck" you get an error about a permission`
			`problem moving foo.new.po to foo.po; this is caused by a check`
			`whether the po files can be re-created. Now if the first tarball`
			`has been created in a different top directory and if there exists a`
			`no distributed file with the string "GNU gnupg" (e.g. a log file`
			`from running make) you end up with different comments in the po`
			`files. Check out /usr/lib/gettext/project-id for that silliness.`
Avoid catch-22 with README.main not being distributed but having the project-id marker string. 2009-09-04 17:21:40 +00:00			`As a hack we added this string into configure.ac.`