Fix the way GetExistingLocalJoinPath is documented.

The old approach made it look like it was an FDW callback, which it
is not.

Per a gripe from Stephen Frost.  Patch by me, reviewed by Ashutosh
Bapat.

diff --git a/doc/src/sgml/fdwhandler.sgml b/doc/src/sgml/fdwhandler.sgml
index 9eec3c8da740163696de9fbf084759ff116826e0..9ad4e1c9601787cbb96122814fc3575b27b98537 100644 (file)
--- a/doc/src/sgml/fdwhandler.sgml
+++ b/doc/src/sgml/fdwhandler.sgml
@@ -340,21 +340,6 @@ GetForeignJoinPaths (PlannerInfo *root,
     
      See  for additional information.
     
-
-    
-
-void
-GetExistingLocalJoinPath(RelOptInfo *joinrel)
-
-     The function returns copy of a local join path, which can be converted
-     into an alternative local join plan, which may be useful when
-     implementing a RecheckForeignScan method.  The function
-     searches for an unparameterized path in the pathlist of given
-     joinrel. If it does not find such a path, it returns NULL, in
-     which case a foreign data wrapper may build the local path by itself or
-     may choose not to create access paths for that join.
-    
-
    
 
    
@@ -808,9 +793,13 @@ RecheckForeignScan (ForeignScanState *node, TupleTableSlot *slot);
      can be executed and the resulting tuple can be stored in the slot.
      This plan need not be efficient since no base table will return more
      than one row; for example, it may implement all joins as nested loops.
-     GetExistingLocalJoinPath may be used to search existing paths
-     for a suitable local join path, which can be used as the alternative
-     local join plan.
+     The function GetExistingLocalJoinPath may be used to search
+     existing paths for a suitable local join path, which can be used as the
+     alternative local join plan.  GetExistingLocalJoinPath
+     searches for an unparameterized path in the path list of the specified
+     join relation.  (If it does not find such a path, it returns NULL, in
+     which case a foreign data wrapper may build the local path by itself or
+     may choose not to create access paths for that join.)