9.4 documentation: duplicate paragraph in logical decoding example

Started by Christoph Moench-Tegederover 11 years ago5 messages
#1Christoph Moench-Tegeder
cmt@burggraben.net
1 attachment(s)

Hi,

while reading the logical decoding docs, I came across a duplicated
paragraph in doc/src/sgml/logicaldecoding.sgml - in the current
master branch, lines 108 to 115 are the same as lines 117 to 124.
I've attached a patch which removes the second instance of that
paragraph.
In case it is intended to demonstrate that the changes in the stream
were not consumed by pg_logical_slot_peek_changes(), the comment
in line 117 should be removed, or reworded like "the changes have
not been consumed by the previous command", just to avoid making
it look like that paragraph had been duplicated by accident :)

Regards,
Christoph

--
Spare Space

Attachments:

logicaldecoding.sgml.difftext/x-diff; charset=us-asciiDownload
diff --git a/doc/src/sgml/logicaldecoding.sgml b/doc/src/sgml/logicaldecoding.sgml
index a2108d6..5fa2a1e 100644
--- a/doc/src/sgml/logicaldecoding.sgml
+++ b/doc/src/sgml/logicaldecoding.sgml
@@ -114,15 +114,6 @@ postgres=# SELECT * FROM pg_logical_slot_peek_changes('regression_slot', NULL, N
  0/16E0B90 | 690 | COMMIT 690
 (3 rows)
 
-postgres=# -- You can also peek ahead in the change stream without consuming changes
-postgres=# SELECT * FROM pg_logical_slot_peek_changes('regression_slot', NULL, NULL);
- location  | xid |                     data
------------+-----+-----------------------------------------------
- 0/16E09C0 | 690 | BEGIN 690
- 0/16E09C0 | 690 | table public.data: INSERT: id[integer]:3 data[text]:'3'
- 0/16E0B90 | 690 | COMMIT 690
-(3 rows)
-
 postgres=# -- options can be passed to output plugin, to influence the formatting
 postgres=# SELECT * FROM pg_logical_slot_peek_changes('regression_slot', NULL, NULL, 'include-timestamp', 'on');
  location  | xid |                     data
#2Fujii Masao
masao.fujii@gmail.com
In reply to: Christoph Moench-Tegeder (#1)
Re: 9.4 documentation: duplicate paragraph in logical decoding example

On Sun, Jul 6, 2014 at 2:41 AM, Christoph Moench-Tegeder
<cmt@burggraben.net> wrote:

Hi,

while reading the logical decoding docs, I came across a duplicated
paragraph in doc/src/sgml/logicaldecoding.sgml - in the current
master branch, lines 108 to 115 are the same as lines 117 to 124.
I've attached a patch which removes the second instance of that
paragraph.
In case it is intended to demonstrate that the changes in the stream
were not consumed by pg_logical_slot_peek_changes(),

I didn't write that text, but I think that's the reason why the same
texts exist.

reworded like "the changes have
not been consumed by the previous command", just to avoid making
it look like that paragraph had been duplicated by accident :)

I'm OK with this.

Regards,

--
Fujii Masao

--
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers

#3Andres Freund
andres@2ndquadrant.com
In reply to: Fujii Masao (#2)
Re: 9.4 documentation: duplicate paragraph in logical decoding example

On 2014-07-07 12:50:17 +0900, Fujii Masao wrote:

On Sun, Jul 6, 2014 at 2:41 AM, Christoph Moench-Tegeder
<cmt@burggraben.net> wrote:

Hi,

while reading the logical decoding docs, I came across a duplicated
paragraph in doc/src/sgml/logicaldecoding.sgml - in the current
master branch, lines 108 to 115 are the same as lines 117 to 124.
I've attached a patch which removes the second instance of that
paragraph.
In case it is intended to demonstrate that the changes in the stream
were not consumed by pg_logical_slot_peek_changes(),

I didn't write that text, but I think that's the reason why the same
texts exist.

It was me... I was being cute^Wtired^Wuhhh and thought the duplicated
content would demonstrate that nothing has happened due to the decoding
stream.
But since you're now the second person confused by it I guess we better
rephrase it.

reworded like "the changes have
not been consumed by the previous command", just to avoid making
it look like that paragraph had been duplicated by accident :)

I'm OK with this.

Care to submit a patch for it Christoph?

Greetings,

Andres Freund

--
Andres Freund http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Training & Services

--
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers

#4Christoph Moench-Tegeder
cmt@burggraben.net
In reply to: Andres Freund (#3)
1 attachment(s)
Re: 9.4 documentation: duplicate paragraph in logical decoding example

## Andres Freund (andres@2ndquadrant.com):

Care to submit a patch for it Christoph?

There it is.

Regards,
Christoph

--
Spare Space

Attachments:

logicaldecoding.sgml.difftext/x-diff; charset=us-asciiDownload
diff --git a/doc/src/sgml/logicaldecoding.sgml b/doc/src/sgml/logicaldecoding.sgml
index 41b63b4..6c3707c 100644
--- a/doc/src/sgml/logicaldecoding.sgml
+++ b/doc/src/sgml/logicaldecoding.sgml
@@ -114,7 +114,7 @@ postgres=# SELECT * FROM pg_logical_slot_peek_changes('regression_slot', NULL, N
  0/16E0B90 | 690 | COMMIT 690
 (3 rows)
 
-postgres=# -- You can also peek ahead in the change stream without consuming changes
+postgres=# -- The next call to pg_logical_slot_peek_changes() returns the same changes again
 postgres=# SELECT * FROM pg_logical_slot_peek_changes('regression_slot', NULL, NULL);
  location  | xid |                     data
 -----------+-----+-----------------------------------------------
#5Fujii Masao
masao.fujii@gmail.com
In reply to: Christoph Moench-Tegeder (#4)
Re: 9.4 documentation: duplicate paragraph in logical decoding example

On Mon, Jul 14, 2014 at 2:33 PM, Christoph Moench-Tegeder
<cmt@burggraben.net> wrote:

## Andres Freund (andres@2ndquadrant.com):

Care to submit a patch for it Christoph?

There it is.

Thanks! Applied.

Regards,

--
Fujii Masao

--
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers