Commit 34ae1828 authored by Peter Eisentraut's avatar Peter Eisentraut

doc: Make function synopsis formatting more uniform

Whitespace use was inconsistent in the same chapter.
parent 1c53f612
......@@ -101,7 +101,7 @@
<para>
<programlisting>
void
GetForeignRelSize (PlannerInfo *root,
GetForeignRelSize(PlannerInfo *root,
RelOptInfo *baserel,
Oid foreigntableid);
</programlisting>
......@@ -132,7 +132,7 @@ GetForeignRelSize (PlannerInfo *root,
<para>
<programlisting>
void
GetForeignPaths (PlannerInfo *root,
GetForeignPaths(PlannerInfo *root,
RelOptInfo *baserel,
Oid foreigntableid);
</programlisting>
......@@ -163,7 +163,7 @@ GetForeignPaths (PlannerInfo *root,
<para>
<programlisting>
ForeignScan *
GetForeignPlan (PlannerInfo *root,
GetForeignPlan(PlannerInfo *root,
RelOptInfo *baserel,
Oid foreigntableid,
ForeignPath *best_path,
......@@ -199,7 +199,7 @@ GetForeignPlan (PlannerInfo *root,
<para>
<programlisting>
void
BeginForeignScan (ForeignScanState *node,
BeginForeignScan(ForeignScanState *node,
int eflags);
</programlisting>
......@@ -227,7 +227,7 @@ BeginForeignScan (ForeignScanState *node,
<para>
<programlisting>
TupleTableSlot *
IterateForeignScan (ForeignScanState *node);
IterateForeignScan(ForeignScanState *node);
</programlisting>
Fetch one row from the foreign source, returning it in a tuple table slot
......@@ -264,7 +264,7 @@ IterateForeignScan (ForeignScanState *node);
<para>
<programlisting>
void
ReScanForeignScan (ForeignScanState *node);
ReScanForeignScan(ForeignScanState *node);
</programlisting>
Restart the scan from the beginning. Note that any parameters the
......@@ -275,7 +275,7 @@ ReScanForeignScan (ForeignScanState *node);
<para>
<programlisting>
void
EndForeignScan (ForeignScanState *node);
EndForeignScan(ForeignScanState *node);
</programlisting>
End the scan and release resources. It is normally not important
......@@ -297,7 +297,7 @@ EndForeignScan (ForeignScanState *node);
<para>
<programlisting>
void
GetForeignJoinPaths (PlannerInfo *root,
GetForeignJoinPaths(PlannerInfo *root,
RelOptInfo *joinrel,
RelOptInfo *outerrel,
RelOptInfo *innerrel,
......@@ -356,7 +356,7 @@ GetForeignJoinPaths (PlannerInfo *root,
<para>
<programlisting>
void
GetForeignUpperPaths (PlannerInfo *root,
GetForeignUpperPaths(PlannerInfo *root,
UpperRelationKind stage,
RelOptInfo *input_rel,
RelOptInfo *output_rel);
......@@ -404,7 +404,7 @@ GetForeignUpperPaths (PlannerInfo *root,
<para>
<programlisting>
void
AddForeignUpdateTargets (Query *parsetree,
AddForeignUpdateTargets(Query *parsetree,
RangeTblEntry *target_rte,
Relation target_relation);
</programlisting>
......@@ -451,7 +451,7 @@ AddForeignUpdateTargets (Query *parsetree,
<para>
<programlisting>
List *
PlanForeignModify (PlannerInfo *root,
PlanForeignModify(PlannerInfo *root,
ModifyTable *plan,
Index resultRelation,
int subplan_index);
......@@ -490,7 +490,7 @@ PlanForeignModify (PlannerInfo *root,
<para>
<programlisting>
void
BeginForeignModify (ModifyTableState *mtstate,
BeginForeignModify(ModifyTableState *mtstate,
ResultRelInfo *rinfo,
List *fdw_private,
int subplan_index,
......@@ -536,7 +536,7 @@ BeginForeignModify (ModifyTableState *mtstate,
<para>
<programlisting>
TupleTableSlot *
ExecForeignInsert (EState *estate,
ExecForeignInsert(EState *estate,
ResultRelInfo *rinfo,
TupleTableSlot *slot,
TupleTableSlot *planSlot);
......@@ -582,7 +582,7 @@ ExecForeignInsert (EState *estate,
<para>
<programlisting>
TupleTableSlot *
ExecForeignUpdate (EState *estate,
ExecForeignUpdate(EState *estate,
ResultRelInfo *rinfo,
TupleTableSlot *slot,
TupleTableSlot *planSlot);
......@@ -628,7 +628,7 @@ ExecForeignUpdate (EState *estate,
<para>
<programlisting>
TupleTableSlot *
ExecForeignDelete (EState *estate,
ExecForeignDelete(EState *estate,
ResultRelInfo *rinfo,
TupleTableSlot *slot,
TupleTableSlot *planSlot);
......@@ -672,7 +672,7 @@ ExecForeignDelete (EState *estate,
<para>
<programlisting>
void
EndForeignModify (EState *estate,
EndForeignModify(EState *estate,
ResultRelInfo *rinfo);
</programlisting>
......@@ -689,7 +689,7 @@ EndForeignModify (EState *estate,
<para>
<programlisting>
int
IsForeignRelUpdatable (Relation rel);
IsForeignRelUpdatable(Relation rel);
</programlisting>
Report which update operations the specified foreign table supports.
......@@ -729,7 +729,7 @@ IsForeignRelUpdatable (Relation rel);
<para>
<programlisting>
bool
PlanDirectModify (PlannerInfo *root,
PlanDirectModify(PlannerInfo *root,
ModifyTable *plan,
Index resultRelation,
int subplan_index);
......@@ -771,7 +771,7 @@ PlanDirectModify (PlannerInfo *root,
<para>
<programlisting>
void
BeginDirectModify (ForeignScanState *node,
BeginDirectModify(ForeignScanState *node,
int eflags);
</programlisting>
......@@ -805,7 +805,7 @@ BeginDirectModify (ForeignScanState *node,
<para>
<programlisting>
TupleTableSlot *
IterateDirectModify (ForeignScanState *node);
IterateDirectModify(ForeignScanState *node);
</programlisting>
When the <command>INSERT</>, <command>UPDATE</> or <command>DELETE</>
......@@ -851,7 +851,7 @@ IterateDirectModify (ForeignScanState *node);
<para>
<programlisting>
void
EndDirectModify (ForeignScanState *node);
EndDirectModify(ForeignScanState *node);
</programlisting>
Clean up following a direct modification on the remote server. It is
......@@ -879,7 +879,7 @@ EndDirectModify (ForeignScanState *node);
<para>
<programlisting>
RowMarkType
GetForeignRowMarkType (RangeTblEntry *rte,
GetForeignRowMarkType(RangeTblEntry *rte,
LockClauseStrength strength);
</programlisting>
......@@ -911,7 +911,7 @@ GetForeignRowMarkType (RangeTblEntry *rte,
<para>
<programlisting>
HeapTuple
RefetchForeignRow (EState *estate,
RefetchForeignRow(EState *estate,
ExecRowMark *erm,
Datum rowid,
bool *updated);
......@@ -970,7 +970,8 @@ RefetchForeignRow (EState *estate,
<para>
<programlisting>
bool
RecheckForeignScan (ForeignScanState *node, TupleTableSlot *slot);
RecheckForeignScan(ForeignScanState *node,
TupleTableSlot *slot);
</programlisting>
Recheck that a previously-returned tuple still matches the relevant
scan and join qualifiers, and possibly provide a modified version of
......@@ -1011,7 +1012,7 @@ RecheckForeignScan (ForeignScanState *node, TupleTableSlot *slot);
<para>
<programlisting>
void
ExplainForeignScan (ForeignScanState *node,
ExplainForeignScan(ForeignScanState *node,
ExplainState *es);
</programlisting>
......@@ -1033,7 +1034,7 @@ ExplainForeignScan (ForeignScanState *node,
<para>
<programlisting>
void
ExplainForeignModify (ModifyTableState *mtstate,
ExplainForeignModify(ModifyTableState *mtstate,
ResultRelInfo *rinfo,
List *fdw_private,
int subplan_index,
......@@ -1059,7 +1060,7 @@ ExplainForeignModify (ModifyTableState *mtstate,
<para>
<programlisting>
void
ExplainDirectModify (ForeignScanState *node,
ExplainDirectModify(ForeignScanState *node,
ExplainState *es);
</programlisting>
......@@ -1087,7 +1088,7 @@ ExplainDirectModify (ForeignScanState *node,
<para>
<programlisting>
bool
AnalyzeForeignTable (Relation relation,
AnalyzeForeignTable(Relation relation,
AcquireSampleRowsFunc *func,
BlockNumber *totalpages);
</programlisting>
......@@ -1109,8 +1110,10 @@ AnalyzeForeignTable (Relation relation,
If provided, the sample collection function must have the signature
<programlisting>
int
AcquireSampleRowsFunc (Relation relation, int elevel,
HeapTuple *rows, int targrows,
AcquireSampleRowsFunc(Relation relation,
int elevel,
HeapTuple *rows,
int targrows,
double *totalrows,
double *totaldeadrows);
</programlisting>
......@@ -1132,7 +1135,7 @@ AcquireSampleRowsFunc (Relation relation, int elevel,
<para>
<programlisting>
List *
ImportForeignSchema (ImportForeignSchemaStmt *stmt, Oid serverOid);
ImportForeignSchema(ImportForeignSchemaStmt *stmt, Oid serverOid);
</programlisting>
Obtain a list of foreign table creation commands. This function is
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment