1
0
mirror of https://github.com/postgres/postgres.git synced 2025-12-21 05:21:08 +03:00
Files
postgres/doc/src/sgml
Tom Lane 750c5ee6ce Fix psql \s to work with recent libedit, and add pager support.
psql's \s (print command history) doesn't work at all with recent libedit
versions when printing to the terminal, because libedit tries to do an
fchmod() on the target file which will fail if the target is /dev/tty.
(We'd already noted this in the context of the target being /dev/null.)
Even before that, it didn't work pleasantly, because libedit likes to
encode the command history file (to ensure successful reloading), which
renders it nigh unreadable, not to mention significantly different-looking
depending on exactly which libedit version you have.  So let's forget using
write_history() for this purpose, and instead print the data ourselves,
using logic similar to that used to iterate over the history for newline
encoding/decoding purposes.

While we're at it, insert the ability to use the pager when \s is printing
to the terminal.  This has been an acknowledged shortcoming of \s for many
years, so while you could argue it's not exactly a back-patchable bug fix
it still seems like a good improvement.  Anyone who's seriously annoyed
at this can use "\s /dev/tty" or local equivalent to get the old behavior.

Experimentation with this showed that the history iteration logic was
actually rather broken when used with libedit.  It turns out that with
libedit you have to use previous_history() not next_history() to advance
to more recent history entries.  The easiest and most robust fix for this
seems to be to make a run-time test to verify which function to call.
We had not noticed this because libedit doesn't really need the newline
encoding logic: its own encoding ensures that command entries containing
newlines are reloaded correctly (unlike libreadline).  So the effective
behavior with recent libedits was that only the oldest history entry got
newline-encoded or newline-decoded.  However, because of yet other bugs in
history_set_pos(), some old versions of libedit allowed the existing loop
logic to reach entries besides the oldest, which means there may be libedit
~/.psql_history files out there containing encoded newlines in more than
just the oldest entry.  To ensure we can reload such files, it seems
appropriate to back-patch this fix, even though that will result in some
incompatibility with older psql versions (ie, multiline history entries
written by a psql with this fix will look corrupted to a psql without it,
if its libedit is reasonably up to date).

Stepan Rutz and Tom Lane
2014-09-08 16:09:45 -04:00
..
2014-05-06 21:28:58 -04:00
2014-07-16 22:48:11 -04:00
2014-07-16 22:48:11 -04:00
2013-07-02 20:32:09 -04:00
2014-03-03 16:32:18 -05:00
2014-08-30 10:52:36 -05:00
2014-02-23 21:31:08 -05:00
2014-06-28 21:46:15 +02:00
2013-11-27 11:03:59 +01:00
2014-07-16 22:48:11 -04:00
2014-07-08 23:29:25 -04:00
2014-07-16 22:48:11 -04:00
2014-07-16 22:48:11 -04:00
2014-07-08 14:55:09 -04:00
2014-01-07 16:05:30 -05:00
2014-08-07 20:46:41 -04:00
2014-07-16 22:48:11 -04:00
2014-08-30 10:52:36 -05:00
2014-07-16 22:48:11 -04:00
2014-08-30 10:52:36 -05:00
2014-09-04 14:11:23 -04:00
2014-07-08 23:29:25 -04:00
2014-07-16 22:48:11 -04:00
2014-05-06 21:28:58 -04:00
2014-05-06 21:28:58 -04:00
2014-08-30 10:52:36 -05:00
2014-08-30 10:52:36 -05:00
2014-07-16 22:48:11 -04:00
2014-05-06 21:28:58 -04:00
2014-07-16 22:48:11 -04:00
2014-05-06 21:28:58 -04:00
2014-08-30 10:52:36 -05:00
2014-03-23 02:16:34 -04:00
2014-07-16 22:48:11 -04:00
2014-07-16 22:48:11 -04:00
2014-08-30 10:52:36 -05:00
2014-08-30 10:52:36 -05:00
2014-01-06 21:30:26 -05:00

<!-- doc/src/sgml/README.links -->

Linking within SGML documents can be confusing, so here is a summary:


Intra-document Linking
----------------------

<xref>
	use to get chapter/section number from the title of the target
	link, or xreflabel if defined at the target, or refentrytitle if target
        is a refentry;  has no close tag
	http://www.oasis-open.org/docbook/documentation/reference/html/xref.html

<link>
	use to supply text for the link, requires </link>
	http://www.oasis-open.org/docbook/documentation/reference/html/link.html

linkend=
	controls the target of the link/xref, required

endterm=
	for <xref>, allows the text of the link/xref to be taken from a
	different link target title


External Linking
----------------

<ulink>
	like <link>, but uses a URL (not a document target);  requires
	</ulink>; if no text is specified, the URL appears as the link
	text
	http://www.oasis-open.org/docbook/documentation/reference/html/ulink.html

url=
	used by <ulink> to specify the URL, required


Guidelines
----------

o  If you want to supply text, use <link>, else <xref>
o  Do not use text with <ulink> so the URL appears in printed output
o  Specific nouns like GUC variables, SQL commands, and contrib modules
   usually have xreflabels