public inbox for [email protected]  

help / color / mirror / Atom feed

From: Amit Langote <[email protected]>
To: [email protected] <[email protected]>
Subject: Link section in custom scan documentation
Date: Fri, 15 May 2015 16:22:42 +0900
Message-ID: <CA+HiwqHaXWcc+2hg1fjLsi+PE7tK-hX_2eLY7vTKGx93E=8yBQ@mail.gmail.com> (raw)
List-Unsubscribe: <mailto:[email protected]?body=unsub%20pgsql-docs>

Hi,

I propose attached which does:

     the <function>BeginCustomScan</> callback will be invoked to give the
-    custom scan provider a chance to do whatever else is needed.
+    custom scan provider a chance to do whatever else is needed. See
+   <xref linkend="custom-scan-execution"> for more details.

It would be similar to how it's done elsewhere in custom-scan.sgml like:

    Convert a custom path to a finished plan.  The return value will generally
    be a <literal>CustomScan</> object, which the callback must allocate and
    initialize.  See <xref linkend="custom-scan-plan"> for more details.

Thanks,
Amit


-- 
Sent via pgsql-docs mailing list ([email protected])
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-docs


Attachments:

  [application/octet-stream] custom-scan-link-section.patch (699B, 2-custom-scan-link-section.patch)
  download | inline diff:
diff --git a/doc/src/sgml/custom-scan.sgml b/doc/src/sgml/custom-scan.sgml
index 62a8a33..4b629b8 100644
--- a/doc/src/sgml/custom-scan.sgml
+++ b/doc/src/sgml/custom-scan.sgml
@@ -208,7 +208,8 @@ Node *(*CreateCustomScanState) (CustomScan *cscan);
     set appropriately, but other fields should be left as zeroes at this
     stage; after <function>ExecInitCustomScan</> performs basic initialization,
     the <function>BeginCustomScan</> callback will be invoked to give the
-    custom scan provider a chance to do whatever else is needed.
+    custom scan provider a chance to do whatever else is needed. See
+	<xref linkend="custom-scan-execution"> for more details.
    </para>
 
    <para>

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected]
  Subject: Re: Link section in custom scan documentation
  In-Reply-To: <CA+HiwqHaXWcc+2hg1fjLsi+PE7tK-hX_2eLY7vTKGx93E=8yBQ@mail.gmail.com>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox