Thread: 8.0.0beta3 release documentation fixes for Tcl unbundling

8.0.0beta3 release documentation fixes for Tcl unbundling

From
ljb
Date:
These corrections against 8.0.0beta3 are for removal of the Tcl interface
from core.  I found two left-over references in the top-level README to be
fixed, several in the top-level INSTALL and Installation chapter of the
manual (both generated from docs/src/sgml/installation.sgml, I think) and
one in the help text in configure.in.

In addition, please delete doc/man1/pgtclsh.1 and doc/man1/pgtksh.1 from
the distribution, since these commands are no longer included.

Here are my suggested changes.  Since the target files are highly
visible, I assume you will check this over very carefully and rewrite as
appropriate...


===========================================================
*** README.bak    Mon Jan 19 16:20:04 2004
--- README    Wed Sep 29 12:44:44 2004
***************
*** 7,18 ****
  PostgreSQL is an advanced object-relational database management system
  that supports an extended subset of the SQL standard, including
  transactions, foreign keys, subqueries, triggers, user-defined types
! and functions.  This distribution also contains several language
! bindings, including C and Tcl.

! The JDBC, ODBC, C++, and Python interfaces have been moved to the PostgreSQL
! Projects Web Site at http://gborg.postgresql.org for separate maintenance.
! A Perl DBI/DBD driver is available from CPAN.

  See the file INSTALL for instructions on how to build and install
  PostgreSQL.  That file also lists supported operating systems and
--- 7,17 ----
  PostgreSQL is an advanced object-relational database management system
  that supports an extended subset of the SQL standard, including
  transactions, foreign keys, subqueries, triggers, user-defined types
! and functions.  This distribution also contains C language bindings.

! The JDBC, ODBC, C++, Python, and Tcl interfaces have been moved to the
! PostgreSQL Projects Web Site at http://gborg.postgresql.org for separate
! maintenance.  A Perl DBI/DBD driver is available from CPAN.

  See the file INSTALL for instructions on how to build and install
  PostgreSQL.  That file also lists supported operating systems and

===========================================================
*** configure.in.bak    Sun Sep 26 22:17:14 2004
--- configure.in    Wed Sep 29 12:57:31 2004
***************
*** 374,380 ****
  # Tcl/Tk
  #
  AC_MSG_CHECKING([whether to build with Tcl])
! PGAC_ARG_BOOL(with, tcl, no, [  --with-tcl              build Tcl and Tk interfaces])
  AC_MSG_RESULT([$with_tcl])
  AC_SUBST([with_tcl])

--- 374,380 ----
  # Tcl/Tk
  #
  AC_MSG_CHECKING([whether to build with Tcl])
! PGAC_ARG_BOOL(with, tcl, no, [  --with-tcl              build Tcl modules (PL/Tcl)])
  AC_MSG_RESULT([$with_tcl])
  AC_SUBST([with_tcl])


===========================================================
*** installation.sgml.bak    Wed Sep 22 20:30:13 2004
--- installation.sgml    Wed Sep 29 12:49:38 2004
***************
*** 209,216 ****

      <listitem>
       <para>
!       If you want to build Tcl or Tk components (clients and the
!       PL/Tcl language) you of course need a Tcl installation.
       </para>
      </listitem>

--- 209,216 ----

      <listitem>
       <para>
!       If you want to build the PL/Tcl language, you of course need a
!       Tcl installation.
       </para>
      </listitem>

***************
*** 741,775 ****
         <term><option>--with-tcl</option></term>
         <listitem>
          <para>
!          Build <application>PL/Tcl</>, which requires Tcl/Tk
!          <option>--without-tk</>.
!         </para>
!        </listitem>
!       </varlistentry>
!
!       <varlistentry>
!        <term><option>--without-tk</option></term>
!        <listitem>
!         <para>
!          If you specify <option>--with-tcl</> and this option, then
!          the program that requires <productname>Tk</>
!          (<application>pgtksh</>) will be
!          excluded.
          </para>
         </listitem>
        </varlistentry>

        <varlistentry>
         <term><option>--with-tclconfig=<replaceable>DIRECTORY</replaceable></option></term>
-        <term><option>--with-tkconfig=<replaceable>DIRECTORY</replaceable></option></term>
         <listitem>
          <para>
!          Tcl/Tk installs the files <filename>tclConfig.sh</filename> and
!          <filename>tkConfig.sh</filename>, which contain
!          configuration information needed to build modules
!          interfacing to Tcl or Tk. These files are normally found
           automatically at their well-known locations, but if you want to
!          use a different version of Tcl or Tk you can specify the
           directory in which to find them.
          </para>
         </listitem>
--- 741,760 ----
         <term><option>--with-tcl</option></term>
         <listitem>
          <para>
!          Build <application>PL/Tcl</>, which requires Tcl.
          </para>
         </listitem>
        </varlistentry>

        <varlistentry>
         <term><option>--with-tclconfig=<replaceable>DIRECTORY</replaceable></option></term>
         <listitem>
          <para>
!          Tcl installs the file <filename>tclConfig.sh</filename>, which
!          contains configuration information needed to build modules
!          interfacing to Tcl. These files are normally found
           automatically at their well-known locations, but if you want to
!          use a different version of Tcl you can specify the
           directory in which to find them.
          </para>
         </listitem>
===========================================================

Re: 8.0.0beta3 release documentation fixes for Tcl

From
Neil Conway
Date:
On Thu, 2004-09-30 at 10:30, ljb wrote:
> These corrections against 8.0.0beta3 are for removal of the Tcl interface
> from core.

Patch applied to HEAD, with some editorializing. autoconf (2.53) re-run.

For future reference, patches should be made with a consistent directory
prefix (i.e. if you're going to make some hunks of the patch relevant to
the top-level of the PG source tree, please do so for all hunks).

Thanks for the patch!

> In addition, please delete doc/man1/pgtclsh.1 and doc/man1/pgtksh.1 from
> the distribution, since these commands are no longer included.

I couldn't see these files in the beta3 distribution.

-Neil



Re: 8.0.0beta3 release documentation fixes for Tcl unbundling

From
L J Bayuk
Date:
On Fri, Oct 01, 2004 at 11:59:56AM +1000, Neil Conway wrote:
> On Thu, 2004-09-30 at 10:30, ljb wrote:
> > These corrections against 8.0.0beta3 are for removal of the Tcl interface
> > from core.
>
> Patch applied to HEAD, with some editorializing. autoconf (2.53) re-run.
>
> For future reference, patches should be made with a consistent directory
> prefix (i.e. if you're going to make some hunks of the patch relevant to
> the top-level of the PG source tree, please do so for all hunks).

Sorry. Yes I should know better.


> > In addition, please delete doc/man1/pgtclsh.1 and doc/man1/pgtksh.1 from
> > the distribution, since these commands are no longer included.
>
> I couldn't see these files in the beta3 distribution.

Sorry again; that should be man/man1 not doc/man1, and that's where they
get installed (which isn't what you want).
They arrive in the distribution inside the man.tar.gz file:
$ tar -tvzf doc/man.tar.gz  | grep pgt
-rw-r--r-- petere/wheel    852 2003-11-02 06:39:09 man1/pgtclsh.1
-rw-r--r-- petere/wheel    963 2003-11-02 06:39:08 man1/pgtksh.1

And they get built from this source file:
   doc/src/sgml/ref/pgtclsh.sgml
I don't think it is explicitly referenced from any Makefile or other sgml
file.