Skip to content

Commit c70cc9a

Browse files
committed
doc: In FDW handler docs, mark up scan_clauses with <literal>.
Etsuro Fujita
1 parent 377790f commit c70cc9a

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

doc/src/sgml/fdwhandler.sgml

+3-3
Original file line numberDiff line numberDiff line change
@@ -873,11 +873,11 @@ GetForeignServerByName(const char *name, bool missing_ok);
873873

874874
<para>
875875
In <function>GetForeignPlan</>, generally the passed-in target list can
876-
be copied into the plan node as-is. The passed scan_clauses list
876+
be copied into the plan node as-is. The passed <literal>scan_clauses</> list
877877
contains the same clauses as <literal>baserel-&gt;baserestrictinfo</>,
878878
but may be re-ordered for better execution efficiency. In simple cases
879879
the FDW can just strip <structname>RestrictInfo</> nodes from the
880-
scan_clauses list (using <function>extract_actual_clauses</>) and put
880+
<literal>scan_clauses</> list (using <function>extract_actual_clauses</>) and put
881881
all the clauses into the plan node's qual list, which means that all the
882882
clauses will be checked by the executor at run time. More complex FDWs
883883
may be able to check some of the clauses internally, in which case those
@@ -895,7 +895,7 @@ GetForeignServerByName(const char *name, bool missing_ok);
895895
affect the cost estimate for the path. The path's
896896
<structfield>fdw_private</> field would probably include a pointer to
897897
the identified clause's <structname>RestrictInfo</> node. Then
898-
<function>GetForeignPlan</> would remove that clause from scan_clauses,
898+
<function>GetForeignPlan</> would remove that clause from <literal>scan_clauses</>,
899899
but add the <replaceable>sub_expression</> to <structfield>fdw_exprs</>
900900
to ensure that it gets massaged into executable form. It would probably
901901
also put control information into the plan node's

0 commit comments

Comments
 (0)