Document "relrewrite" at the top of heap_create_with_catalog()

This parameter has been introduced in 325f2ec5557f, and it was not
documented contrary to all the other arguments of
heap_create_with_catalog().

Reviewed-by: Yugo Nagata <[email protected]>
Reviewed-by: Steven Niu <[email protected]>
Discussion: https://postgr.es/m/[email protected]

diff --git a/src/backend/catalog/heap.c b/src/backend/catalog/heap.c
index fbaed5359ad7c7e6c6e4a50b791f539d920724e2..10f43c51c5af0ec77a067d5b84445714299c2df7 100644 (file)
--- a/src/backend/catalog/heap.c
+++ b/src/backend/catalog/heap.c
@@ -1100,6 +1100,7 @@ AddNewRelationType(const char *typeName,
  *     if false, relacl is always set NULL
  * allow_system_table_mods: true to allow creation in system namespaces
  * is_internal: is this a system-generated catalog?
  *     if false, relacl is always set NULL
  * allow_system_table_mods: true to allow creation in system namespaces
  * is_internal: is this a system-generated catalog?

+ * relrewrite: link to original relation during a table rewrite

  *
  * Output parameters:
  * typaddress: if not null, gets the object address of the new pg_type entry
  *
  * Output parameters:
  * typaddress: if not null, gets the object address of the new pg_type entry