From 6684822274f723da5a2bceffd64e386d807d6c8f Mon Sep 17 00:00:00 2001 From: Ian Barwick Date: Fri, 10 May 2019 10:10:14 +0900 Subject: [PATCH] doc: update documentation build instructions Also add an item in the release notes --- doc/appendix-release-notes.sgml | 19 +++++++++++++++++++ doc/install-source.sgml | 5 +++-- 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/doc/appendix-release-notes.sgml b/doc/appendix-release-notes.sgml index 23ab922e..3cb8e459 100644 --- a/doc/appendix-release-notes.sgml +++ b/doc/appendix-release-notes.sgml @@ -78,6 +78,25 @@ + + Other + + + + + The &repmgr; documentation has been converted to DocBook XML format, + as currently used by the main PostgreSQL project. + This means it can now be built against any &repmgr; version + (previously it was not possible to build the documentation against + PostgreSQL 10 or later). + + + For further details see: + + + + + diff --git a/doc/install-source.sgml b/doc/install-source.sgml index c929e7a0..200ba4a9 100644 --- a/doc/install-source.sgml +++ b/doc/install-source.sgml @@ -237,7 +237,7 @@ deb-src http://apt.postgresql.org/pub/repos/apt/ stretch-pgdg main + Building &repmgr; documentation The &repmgr; documentation is (like the main PostgreSQL project) @@ -254,7 +254,8 @@ deb-src http://apt.postgresql.org/pub/repos/apt/ stretch-pgdg main - To build the documentation as a single HTML file, execute: + To build the documentation as a single HTML file, after configuring and building + the main &repmgr; source as described above, execute: cd doc/ && make repmgr.html