Doc patch: add RECURSIVE to bookindex

Started by Daniel Veriteover 7 years ago6 messages
#1Daniel Verite
daniel@manitou-mail.org
1 attachment(s)

Hi,

I've noticed that RECURSIVE as a term is not in the index,
and thought it should be.
PFA a patch to add it with references to WITH queries and CREATE VIEW.

Best regards,
--
Daniel Vérité
PostgreSQL-powered mailer: http://www.manitou-mail.org
Twitter: @DanielVerite

Attachments:

recursive-in-bookindex.patchtext/plainDownload
diff --git a/doc/src/sgml/queries.sgml b/doc/src/sgml/queries.sgml
index b72be9b..2254013 100644
--- a/doc/src/sgml/queries.sgml
+++ b/doc/src/sgml/queries.sgml
@@ -1981,6 +1981,9 @@ GROUP BY region, product;
   </para>
 
   <para>
+   <indexterm>
+    <primary>RECURSIVE</primary>
+   </indexterm>
    The optional <literal>RECURSIVE</literal> modifier changes <literal>WITH</literal>
    from a mere syntactic convenience into a feature that accomplishes
    things not otherwise possible in standard SQL.  Using
diff --git a/doc/src/sgml/ref/create_view.sgml b/doc/src/sgml/ref/create_view.sgml
index b325c1b..128ceda 100644
--- a/doc/src/sgml/ref/create_view.sgml
+++ b/doc/src/sgml/ref/create_view.sgml
@@ -82,7 +82,11 @@ CREATE [ OR REPLACE ] [ TEMP | TEMPORARY ] [ RECURSIVE ] VIEW <replaceable class
    </varlistentry>
 
    <varlistentry>
-    <term><literal>RECURSIVE</literal></term>
+    <term><literal>RECURSIVE</literal>
+      <indexterm zone="sql-createview">
+       <primary>RECURSIVE</primary>
+      </indexterm>
+    </term>
     <listitem>
      <para>
       Creates a recursive view.  The syntax
#2Fabien COELHO
coelho@cri.ensmp.fr
In reply to: Daniel Verite (#1)
Re: Doc patch: add RECURSIVE to bookindex

Hello Daniel,

I've noticed that RECURSIVE as a term is not in the index, and thought
it should be. PFA a patch to add it with references to WITH queries and
CREATE VIEW.

Sounds reasonable.

Why referencing only create_view, but not delete, insert, update, select
or select_into where RECURSIVE is also used?

ISTM that at least the select page should be referenced, I'm less sure of
the others because there it appears only in the synopsys.

--
Fabien.

#3Daniel Verite
daniel@manitou-mail.org
In reply to: Fabien COELHO (#2)
Re: Doc patch: add RECURSIVE to bookindex

Fabien COELHO wrote:

Why referencing only create_view, but not delete, insert, update, select
or select_into where RECURSIVE is also used?

ISTM that at least the select page should be referenced, I'm less sure of
the others because there it appears only in the synopsys.

Looking at other occurrences of <indexterm>, it seems
they're used quite sparingly, limiting the references to only
the pages that have the most relevant explanation for the term,
as opposed to trying to be exhaustive.

For instance, select.sgml has only three <indexterm>, and
the entries for WHERE or JOIN don't even refer to it.
ISTM that it's on purpose, to keep the index lean, and it works.

Best regards,
--
Daniel Vérité
PostgreSQL-powered mailer: http://www.manitou-mail.org
Twitter: @DanielVerite

#4Fabien COELHO
coelho@cri.ensmp.fr
In reply to: Daniel Verite (#3)
Re: Doc patch: add RECURSIVE to bookindex

Why referencing only create_view, but not delete, insert, update, select
or select_into where RECURSIVE is also used?

ISTM that at least the select page should be referenced, I'm less sure of
the others because there it appears only in the synopsys.

Looking at other occurrences of <indexterm>, it seems
they're used quite sparingly, limiting the references to only
the pages that have the most relevant explanation for the term,
as opposed to trying to be exhaustive.

For instance, select.sgml has only three <indexterm>, and
the entries for WHERE or JOIN don't even refer to it.
ISTM that it's on purpose, to keep the index lean, and it works.

Ok.

Patch applies cleanly, doc build ok, works for me.

--
Fabien.

#5Fabien COELHO
coelho@cri.ensmp.fr
In reply to: Fabien COELHO (#4)
Re: Doc patch: add RECURSIVE to bookindex

Hello Daniel,

Patch applies cleanly, doc build ok, works for me.

I have added it to the next CF and marked it as ready.

--
Fabien.

#6Alvaro Herrera
alvherre@2ndquadrant.com
In reply to: Fabien COELHO (#5)
Re: Doc patch: add RECURSIVE to bookindex

On 2018-Aug-01, Fabien COELHO wrote:

Hello Daniel,

Patch applies cleanly, doc build ok, works for me.

I have added it to the next CF and marked it as ready.

Pushed, thanks.

I applied it to 11 too. I would have added it even further back, but it
didn't apply cleanly.

How about an index entry for "CSV"?

--
�lvaro Herrera https://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services