Update code comment for temporary replication slots

petere · petere · commit 6d242ee98019 · 2017-08-23T14:59:25.000-04:00
Reported-by: Alvaro Herrera &lt;alvherre@2ndquadrant.com&gt;
diff --git a/src/include/replication/slot.h b/src/include/replication/slot.h
@@ -22,9 +22,13 @@
  *
  * Slots marked as PERSISTENT are crash-safe and will not be dropped when
  * released. Slots marked as EPHEMERAL will be dropped when released or after
- * restarts.
+ * restarts.  Slots marked TEMPORARY will be dropped at the end of a session
+ * or on error.
  *
- * EPHEMERAL slots can be made PERSISTENT by calling ReplicationSlotPersist().
+ * EPHEMERAL is used as a not-quite-ready state when creating persistent
+ * slots.  EPHEMERAL slots can be made PERSISTENT by calling
+ * ReplicationSlotPersist().  For a slot that goes away at the end of a
+ * session, TEMPORARY is the appropriate choice.
  */
 typedef enum ReplicationSlotPersistency
 {

Original file line number	Diff line number	Diff line change
`@@ -22,9 +22,13 @@`
`22`	`22`	`*`
`23`	`23`	`* Slots marked as PERSISTENT are crash-safe and will not be dropped when`
`24`	`24`	`* released. Slots marked as EPHEMERAL will be dropped when released or after`
`25`		`- * restarts.`
	`25`	`+ * restarts. Slots marked TEMPORARY will be dropped at the end of a session`
	`26`	`+ * or on error.`
`26`	`27`	`*`
`27`		`- * EPHEMERAL slots can be made PERSISTENT by calling ReplicationSlotPersist().`
	`28`	`+ * EPHEMERAL is used as a not-quite-ready state when creating persistent`
	`29`	`+ * slots. EPHEMERAL slots can be made PERSISTENT by calling`
	`30`	`+ * ReplicationSlotPersist(). For a slot that goes away at the end of a`
	`31`	`+ * session, TEMPORARY is the appropriate choice.`
`28`	`32`	`*/`
`29`	`33`	`typedef enum ReplicationSlotPersistency`
`30`	`34`	`{`