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 e3c1539a1e3bc3c621c422d57e03573cd17a0a9e..d0dbf017a9e1ff8385a525e9e7146b6cbdbb56d6 100644 (file)
--- a/doc/src/sgml/indexam.sgml
+++ b/doc/src/sgml/indexam.sgml
@@ -141,7 +141,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 d3e5e5d59188266710ef8cc17463e47da4e1e908..098014508160e0260b1d0e6936c580b521da3323 100644 (file)
--- a/src/include/access/amapi.h
+++ b/src/include/access/amapi.h
@@ -271,7 +271,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 */