doc: Inform about aminsertcleanup optional NULLness

This index AM callback has been introduced in c1ec02be1d79 and it is
optional, currently only being used by BRIN.  Optional callbacks are
documented with NULL as possible value in amapi.h and indexam.sgml, but
this callback has missed this part of the description.

Reported-by: Peter Smith <smithpb2250@gmail.com>
Reviewed-by: Japin Li <japinli@hotmail.com>
Discussion: https://postgr.es/m/CAHut+PvgYcPmPDi1YdHMJY5upnyGRpc0N8pk1xNB11xDSBwNog@mail.gmail.com
Backpatch-through: 17

diff --git a/doc/src/sgml/indexam.sgml b/doc/src/sgml/indexam.sgml
index 1aa4741a8eaeecf7a2a99df09761ea0aeaf6b34a..63d7e376f195e4d3a644c082df1703a43d68ccb1 100644 (file)
--- a/doc/src/sgml/indexam.sgml
+++ b/doc/src/sgml/indexam.sgml
@@ -147,7 +147,7 @@ typedef struct IndexAmRoutine
     ambuild_function ambuild;
     ambuildempty_function ambuildempty;
     aminsert_function aminsert;
-    aminsertcleanup_function aminsertcleanup;
+    aminsertcleanup_function aminsertcleanup;   /* can be NULL */
     ambulkdelete_function ambulkdelete;
     amvacuumcleanup_function amvacuumcleanup;
     amcanreturn_function amcanreturn;   /* can be NULL */

diff --git a/src/include/access/amapi.h b/src/include/access/amapi.h
index 52916bab7a31f3dfd0512d96566c72fc9acd39f6..70949de56ac700d17e2b414b54c1bca3cb935373 100644 (file)
--- a/src/include/access/amapi.h
+++ b/src/include/access/amapi.h
@@ -293,7 +293,7 @@ typedef struct IndexAmRoutine
        ambuild_function ambuild;
        ambuildempty_function ambuildempty;
        aminsert_function aminsert;
-       aminsertcleanup_function aminsertcleanup;
+       aminsertcleanup_function aminsertcleanup;       /* can be NULL */
        ambulkdelete_function ambulkdelete;
        amvacuumcleanup_function amvacuumcleanup;
        amcanreturn_function amcanreturn;       /* can be NULL */