Skip to content

Commit 7ceec34

Browse files
tglsfdctglsfdc
committed
Improve documentation of configure's readline/libedit switches.
1 parent db2dcf5 commit 7ceec34

File tree

3 files changed

+49
-43
lines changed

3 files changed

+49
-43
lines changed

‎configure

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -892,8 +892,8 @@ Optional Packages:
892892
--with-ldap build with LDAP support
893893
--with-bonjour build with Bonjour support
894894
--with-openssl build with OpenSSL support
895+
--without-readline do not use GNU Readline nor BSD Libedit for editing
895896
--with-libedit-preferred prefer BSD Libedit over GNU Readline
896-
--without-readline do not use GNU Readline / BSD Libedit line editing
897897
--without-zlib do not use Zlib
898898
--with-gnu-ld assume the C compiler uses GNU ld [default=no]
899899

@@ -4087,15 +4087,15 @@ echo "${ECHO_T}$with_openssl" >&6
40874087

40884088

40894089
#
4090-
# Prefer libedit
4090+
# Readline
40914091
#
40924092

40934093

40944094

40954095

4096-
# Check whether --with-libedit-preferred or --without-libedit-preferred was given.
4097-
if test "${with_libedit_preferred+set}" = set; then
4098-
withval="$with_libedit_preferred"
4096+
# Check whether --with-readline or --without-readline was given.
4097+
if test "${with_readline+set}" = set; then
4098+
withval="$with_readline"
40994099

41004100
case $withval in
41014101
yes)
@@ -4105,29 +4105,39 @@ if test "${with_libedit_preferred+set}" = set; then
41054105
:
41064106
;;
41074107
*)
4108-
{ { echo "$as_me:$LINENO: error: no argument expected for --with-libedit-preferred option" >&5
4109-
echo "$as_me: error: no argument expected for --with-libedit-preferred option" >&2;}
4108+
{ { echo "$as_me:$LINENO: error: no argument expected for --with-readline option" >&5
4109+
echo "$as_me: error: no argument expected for --with-readline option" >&2;}
41104110
{ (exit 1); exit 1; }; }
41114111
;;
41124112
esac
41134113

41144114
else
4115-
with_libedit_preferred=no
4115+
with_readline=yes
41164116

41174117
fi;
41184118

4119+
# readline on MinGW has problems with backslashes in psql and other bugs.
4120+
# This is particularly a problem with non-US code pages.
4121+
# Therefore disable its use until we understand the cause. 2004-07-20
4122+
if test "$PORTNAME" = "win32"; then
4123+
if test "$with_readline" = yes; then
4124+
{ echo "$as_me:$LINENO: WARNING: *** Readline does not work on MinGW --- disabling" >&5
4125+
echo "$as_me: WARNING: *** Readline does not work on MinGW --- disabling" >&2;}
4126+
with_readline=no
4127+
fi
4128+
fi
41194129

41204130

41214131
#
4122-
# Readline
4132+
# Prefer libedit
41234133
#
41244134

41254135

41264136

41274137

4128-
# Check whether --with-readline or --without-readline was given.
4129-
if test "${with_readline+set}" = set; then
4130-
withval="$with_readline"
4138+
# Check whether --with-libedit-preferred or --without-libedit-preferred was given.
4139+
if test "${with_libedit_preferred+set}" = set; then
4140+
withval="$with_libedit_preferred"
41314141

41324142
case $withval in
41334143
yes)
@@ -4137,27 +4147,17 @@ if test "${with_readline+set}" = set; then
41374147
:
41384148
;;
41394149
*)
4140-
{ { echo "$as_me:$LINENO: error: no argument expected for --with-readline option" >&5
4141-
echo "$as_me: error: no argument expected for --with-readline option" >&2;}
4150+
{ { echo "$as_me:$LINENO: error: no argument expected for --with-libedit-preferred option" >&5
4151+
echo "$as_me: error: no argument expected for --with-libedit-preferred option" >&2;}
41424152
{ (exit 1); exit 1; }; }
41434153
;;
41444154
esac
41454155

41464156
else
4147-
with_readline=yes
4157+
with_libedit_preferred=no
41484158

41494159
fi;
41504160

4151-
# readline on MinGW has problems with backslashes in psql and other bugs.
4152-
# This is particularly a problem with non-US code pages.
4153-
# Therefore disable its use until we understand the cause. 2004-07-20
4154-
if test "$PORTNAME" = "win32"; then
4155-
if test "$with_readline" = yes; then
4156-
{ echo "$as_me:$LINENO: WARNING: *** Readline does not work on MinGW --- disabling" >&5
4157-
echo "$as_me: WARNING: *** Readline does not work on MinGW --- disabling" >&2;}
4158-
with_readline=no
4159-
fi
4160-
fi
41614161

41624162

41634163
#
@@ -22955,8 +22955,8 @@ with_pam) ;;
2295522955
with_ldap) ;;
2295622956
with_bonjour) ;;
2295722957
with_openssl) ;;
22958-
with_libedit_preferred) ;;
2295922958
with_readline) ;;
22959+
with_libedit_preferred) ;;
2296022960
with_zlib) ;;
2296122961

2296222962
with_gnu_ld) ;;

‎configure.in

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
dnl Process this file with autoconf to produce a configure script.
2-
dnl $PostgreSQL: pgsql/configure.in,v 1.476 2006/09/27 16:29:45 tgl Exp $
2+
dnl $PostgreSQL: pgsql/configure.in,v 1.477 2006/10/01 23:47:16 tgl Exp $
33
dnl
44
dnl Developers, please strive to achieve this order:
55
dnl
@@ -508,18 +508,11 @@ AC_MSG_RESULT([$with_openssl])
508508
AC_SUBST(with_openssl)
509509

510510

511-
#
512-
# Prefer libedit
513-
#
514-
PGAC_ARG_BOOL(with, libedit-preferred, no,
515-
[ --with-libedit-preferred prefer BSD Libedit over GNU Readline])
516-
517-
518511
#
519512
# Readline
520513
#
521514
PGAC_ARG_BOOL(with, readline, yes,
522-
[ --without-readline do not use GNU Readline / BSD Libedit line editing])
515+
[ --without-readline do not use GNU Readline nor BSD Libedit for editing])
523516
# readline on MinGW has problems with backslashes in psql and other bugs.
524517
# This is particularly a problem with non-US code pages.
525518
# Therefore disable its use until we understand the cause. 2004-07-20
@@ -531,6 +524,13 @@ if test "$PORTNAME" = "win32"; then
531524
fi
532525

533526

527+
#
528+
# Prefer libedit
529+
#
530+
PGAC_ARG_BOOL(with, libedit-preferred, no,
531+
[ --with-libedit-preferred prefer BSD Libedit over GNU Readline])
532+
533+
534534
#
535535
# Zlib
536536
#

‎doc/src/sgml/installation.sgml

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/installation.sgml,v 1.262 2006/09/16 00:30:14 momjian Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/installation.sgml,v 1.263 2006/10/01 23:47:16 tgl Exp $ -->
22

33
<chapter id="installation">
44
<title><![%standalone-include[<productname>PostgreSQL</>]]>
@@ -105,6 +105,9 @@ su - postgres
105105
<indexterm>
106106
<primary>readline</primary>
107107
</indexterm>
108+
<indexterm>
109+
<primary>libedit</primary>
110+
</indexterm>
108111

109112
The <acronym>GNU</> <productname>Readline</> library (for
110113
simple line editing and command history retrieval) is
@@ -866,22 +869,25 @@ su - postgres
866869
</varlistentry>
867870

868871
<varlistentry>
869-
<term><option>--with-libedit-preferred</option></term>
872+
<term><option>--without-readline</option></term>
870873
<listitem>
871874
<para>
872-
Favors the use of the BSD-licensed <application>libedit</> library
873-
rather than GPL-licensed <application>Readline</>.
875+
Prevents use of the <application>Readline</> library
876+
(and <application>libedit</> as well). This option disables
877+
command-line editing and history in
878+
<application>psql</application>, so it is not recommended.
874879
</para>
875880
</listitem>
876881
</varlistentry>
877882

878883
<varlistentry>
879-
<term><option>--without-readline</option></term>
884+
<term><option>--with-libedit-preferred</option></term>
880885
<listitem>
881886
<para>
882-
Prevents use of the <application>Readline</> library. This disables
883-
command-line editing and history in
884-
<application>psql</application>, so it is not recommended.
887+
Favors the use of the BSD-licensed <application>libedit</> library
888+
rather than GPL-licensed <application>Readline</>. This option
889+
is significant only if you have both libraries installed; the
890+
default in that case is to use <application>Readline</>.
885891
</para>
886892
</listitem>
887893
</varlistentry>

0 commit comments

Comments
 (0)