From 0d9e542858174bc1c841817110d02286d7801729 Mon Sep 17 00:00:00 2001 From: Daniel Gustafsson Date: Fri, 29 Jun 2018 17:04:43 +0200 Subject: [PATCH] Remove support for building docs on Windows After the conversion of the docs to XML, the Windows toolchain for building docs no longer work. As there is no solution in sight at the moment, remove support rather than keeping it broken. Also add a note in the release notes to highlight the removed support. --- doc/src/sgml/install-windows.sgml | 47 --------------- doc/src/sgml/release-11.sgml | 4 ++ src/tools/msvc/README | 1 - src/tools/msvc/builddoc.bat | 7 --- src/tools/msvc/builddoc.pl | 124 -------------------------------------- 5 files changed, 4 insertions(+), 179 deletions(-) delete mode 100755 src/tools/msvc/builddoc.bat delete mode 100644 src/tools/msvc/builddoc.pl diff --git a/doc/src/sgml/install-windows.sgml b/doc/src/sgml/install-windows.sgml index e345471c85..276ea27461 100644 --- a/doc/src/sgml/install-windows.sgml +++ b/doc/src/sgml/install-windows.sgml @@ -486,52 +486,5 @@ $ENV{PERL5LIB}=$ENV{PERL5LIB} . ';c:\IPC-Run-0.94\lib'; - - Building the Documentation - - - Building the PostgreSQL documentation in HTML format requires several tools - and files. Create a root directory for all these files, and store them - in the subdirectories in the list below. - - - OpenJade 1.3.1-2 - - Download from - - and uncompress in the subdirectory openjade-1.3.1. - - - - - DocBook DTD 4.2 - - Download from - - and uncompress in the subdirectory docbook. - - - - - ISO character entities - - Download from - and - uncompress in the subdirectory docbook. - - - - Edit the buildenv.pl file, and add a variable for the - location of the root directory, for example: - -$ENV{DOCROOT}='c:\docbook'; - - To build the documentation, run the command - builddoc.bat. Note that this will actually run the - build twice, in order to generate the indexes. The generated HTML files - will be in doc\src\sgml. - - - diff --git a/doc/src/sgml/release-11.sgml b/doc/src/sgml/release-11.sgml index 53b600b453..b51e7e5828 100644 --- a/doc/src/sgml/release-11.sgml +++ b/doc/src/sgml/release-11.sgml @@ -2612,6 +2612,10 @@ same commits as above The file names still use an sgml extension for compatibility with back branches. + + + Building the documentation on Windows is no longer supported. + diff --git a/src/tools/msvc/README b/src/tools/msvc/README index 48082cab90..bfa98045f2 100644 --- a/src/tools/msvc/README +++ b/src/tools/msvc/README @@ -47,7 +47,6 @@ arguments. - User tools - build.pl tool to build the binaries -builddoc.pl tool to build the docs clean.bat batch file for cleaning up generated files install.pl tool to install the generated files mkvcbuild.pl tool to generate the Visual Studio build files diff --git a/src/tools/msvc/builddoc.bat b/src/tools/msvc/builddoc.bat deleted file mode 100755 index 024706989e..0000000000 --- a/src/tools/msvc/builddoc.bat +++ /dev/null @@ -1,7 +0,0 @@ -@echo off - -REM src/tools/msvc/builddoc.bat -REM all the logic for this now belongs in builddoc.pl. This file really -REM only exists so you don't have to type "perl builddoc.pl" -REM Resist any temptation to add any logic here. -@perl builddoc.pl %* diff --git a/src/tools/msvc/builddoc.pl b/src/tools/msvc/builddoc.pl deleted file mode 100644 index f6eb73db21..0000000000 --- a/src/tools/msvc/builddoc.pl +++ /dev/null @@ -1,124 +0,0 @@ -# -*-perl-*- hey - emacs - this is a perl file - -# Adjust path for your docbook installation in buildenv.pl - -# src/tools/msvc/builddoc.pl -# translated from an earlier .bat file - -use strict; -use File::Copy; -use Cwd qw(abs_path getcwd); - -my $startdir = getcwd(); - -my $openjade = 'openjade-1.3.1'; -my $dsssl = 'docbook-dsssl-1.79'; - -chdir '../../..' if (-d '../msvc' && -d '../../../src'); - -noversion() unless -e 'doc/src/sgml/version.sgml'; - -do 'src/tools/msvc/buildenv.pl' if -e 'src/tools/msvc/buildenv.pl'; - -my $docroot = $ENV{DOCROOT}; -die "bad DOCROOT '$docroot'" unless ($docroot && -d $docroot); - -my @notfound; -foreach my $dir ('docbook', $openjade, $dsssl) -{ - push(@notfound, $dir) unless -d "$docroot/$dir"; -} -missing() if @notfound; - -my $arg = shift; -renamefiles(); - -chdir 'doc/src/sgml'; - -$ENV{SGML_CATALOG_FILES} = - "$docroot/$openjade/dsssl/catalog;" . "$docroot/docbook/docbook.cat"; - -my $cmd; - -# openjade exits below with a harmless non-zero status, so we -# can't die on "failure" - -$cmd = - "perl mk_feature_tables.pl YES " - . "../../../src/backend/catalog/sql_feature_packages.txt " - . "../../../src/backend/catalog/sql_features.txt " - . "> features-supported.sgml"; -system($cmd); -die "features_supported" if $?; -$cmd = - "perl mk_feature_tables.pl NO " - . "\"../../../src/backend/catalog/sql_feature_packages.txt\" " - . "\"../../../src/backend/catalog/sql_features.txt\" " - . "> features-unsupported.sgml"; -system($cmd); -die "features_unsupported" if $?; -$cmd = - "perl generate-errcodes-table.pl \"../../../src/backend/utils/errcodes.txt\" " - . "> errcodes-table.sgml"; -system($cmd); -die "errcodes-table" if $?; - -print "Running first build...\n"; -$cmd = - "\"$docroot/$openjade/bin/openjade\" -V html-index -wall " - . "-wno-unused-param -wno-empty -D . -c \"$docroot/$dsssl/catalog\" " - . "-d stylesheet.dsl -i output-html -t sgml postgres.sgml 2>&1 " - . "| findstr /V \"DTDDECL catalog entries are not supported\" "; -system($cmd); # die "openjade" if $?; -print "Running collateindex...\n"; -$cmd = "perl \"$docroot/$dsssl/bin/collateindex.pl\" -f -g -i bookindex " - . "-o bookindex.sgml HTML.index"; -system($cmd); -die "collateindex" if $?; -mkdir "html"; -print "Running second build...\n"; -$cmd = - "\"$docroot/$openjade/bin/openjade\" -wall -wno-unused-param -wno-empty " - . "-D . -c \"$docroot/$dsssl/catalog\" -d stylesheet.dsl -t sgml " - . "-i output-html -i include-index postgres.sgml 2>&1 " - . "| findstr /V \"DTDDECL catalog entries are not supported\" "; - -system($cmd); # die "openjade" if $?; - -copy "stylesheet.css", "html/stylesheet.css"; - -print "Docs build complete.\n"; - -exit; - -######################################################## - -sub renamefiles -{ - - # Rename ISO entity files - my $savedir = getcwd(); - chdir "$docroot/docbook"; - foreach my $f (glob('ISO*')) - { - next if $f =~ /\.gml$/i; - my $nf = $f; - $nf =~ s/ISO(.*)/ISO-$1.gml/; - move $f, $nf; - } - chdir $savedir; - return; -} - -sub missing -{ - print STDERR "could not find $docroot/$_\n" foreach (@notfound); - exit 1; -} - -sub noversion -{ - print STDERR "Could not find version.sgml. ", - "Please run mkvcbuild.pl first!\n"; - exit 1; -} -- 2.14.1.145.gb3622a4ee