diff options
| author | Kristian Evers <kristianevers@gmail.com> | 2018-03-18 22:07:41 +0100 |
|---|---|---|
| committer | Kristian Evers <kristianevers@gmail.com> | 2018-03-18 22:10:04 +0100 |
| commit | b6e2a23585b599910cf7f3f000beab5ecd74ad31 (patch) | |
| tree | 7765692dda1c023f1649f2b21aad18375a1e544e /HOWTO-RELEASE | |
| parent | aa98657fe98c64ba635c1c0b0387f825e9e917f9 (diff) | |
| download | PROJ-b6e2a23585b599910cf7f3f000beab5ecd74ad31.tar.gz PROJ-b6e2a23585b599910cf7f3f000beab5ecd74ad31.zip | |
Setup automatic man page generation
Create man pages from the Sphinx documentation. Ideally the man pages
are updated completely automatic when running make dist and make install
but that is a quite complicated setup. For now a script that builds the
man pages and commits them has been created. This is to be run as part
of the release process so that man pages are aligned with the most
recent version of the docs.
Diffstat (limited to 'HOWTO-RELEASE')
| -rw-r--r-- | HOWTO-RELEASE | 25 |
1 files changed, 16 insertions, 9 deletions
diff --git a/HOWTO-RELEASE b/HOWTO-RELEASE index d862c8ab..3053523b 100644 --- a/HOWTO-RELEASE +++ b/HOWTO-RELEASE @@ -34,38 +34,45 @@ 4.5) Run "autogen.sh" (hopefully on the same machine it was last run on) -5) Add a note to the ChangeLog that a new release is being issued, and what +5) Update man pages: + + ./scripts/update_man.sh + + The script builds man pages from Sphinx docs, copies them to man/ and commits + them to git. + +6) Add a note to the ChangeLog that a new release is being issued, and what the release number is. -6) Update NEWS file with summary of release changes. +7) Update NEWS file with summary of release changes. -7) Update the proj.spec file for the new version: +8) Update the proj.spec file for the new version: - PACKAGE_VERSION - Source0 - %setup line - rm -rf line -8) If this is a major release, prepare a branch. +9) If this is a major release, prepare a branch. git checkout -b 5.0 -9) Tag the release +10) Tag the release git tag 5.0.0 -10) Do a "make dist-all" in the proj root directory. After some grinding +11) Do a "make dist-all" in the proj root directory. After some grinding this should result in files like proj-4.4.3.tar.gz and proj-4.4.3.zip being created. These are full source distributions. -11) Put these in the proj ftp area on /osgeo/download/proj on +12) Put these in the proj ftp area on /osgeo/download/proj on download.osgeo.org. This can be done via scp using a command like the following. scp proj-4.4.3.{tar.gz,zip} warmerdam@download.osgeo.org:/osgeo/download/proj -12) Announce the new release on the PROJ.4 and MetaCRS mailing lists. +13) Announce the new release on the PROJ.4 and MetaCRS mailing lists. -13) Issue a new release report on GitHub: +14) Issue a new release report on GitHub: https://github.com/OSGeo/proj.4/releases/new |