From: Robert Haas <rhaas@postgresql.org>
Date: Tue, 8 Mar 2016 19:30:12 +0000 (-0500)
Subject: Update GetForeignPlan documentation.
X-Git-Tag: REL9_6_BETA1~565
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=dff7ad3c61473a65ff8f166b1eefd099e68595bb;p=postgresql

Update GetForeignPlan documentation.

Commit 385f337c9f39b21dca96ca4770552a10a6d5af24 added a new argument
to the FDW GetForeignPlan method, but failed to update the documentation
to match.

Etsuro Fujita
---

diff --git a/doc/src/sgml/fdwhandler.sgml b/doc/src/sgml/fdwhandler.sgml
index 279daef2d1..e53458ea43 100644
--- a/doc/src/sgml/fdwhandler.sgml
+++ b/doc/src/sgml/fdwhandler.sgml
@@ -178,7 +178,9 @@ GetForeignPlan (PlannerInfo *root,
      the selected <structname>ForeignPath</> (previously produced by
      <function>GetForeignPaths</> or <function>GetForeignJoinPaths</>),
      the target list to be emitted by the plan node,
-     and the restriction clauses to be enforced by the plan node.
+     the restriction clauses to be enforced by the plan node,
+     and the outer subplan of the <structname>ForeignScan</>,
+     which is used for rechecks performed by <function>RecheckForeignScan</>.
      (If the path is for a join rather than a base
      relation, <literal>foreigntableid</> is <literal>InvalidOid</>.)
     </para>