public inbox for [email protected]  
help / color / mirror / Atom feed
broken index references
7+ messages / 4 participants
[nested] [flat]

* broken index references
@ 2013-03-23 03:03 Josh Kupershmidt <[email protected]>
  2013-03-23 18:12 ` Re: broken index references Tom Lane <[email protected]>
  0 siblings, 1 reply; 7+ messages in thread

From: Josh Kupershmidt @ 2013-03-23 03:03 UTC (permalink / raw)
  To: pgsql-docs

If you search through recent 9.2 or 9.3dev PDFs for the string "??"
you should find ten occurrences. Other than the first instance in
Chapter 9, the other nine are all in the index, and indicate an
unknown reference to some index entry. For example, you can see in the
current 9.2-A4 PDF:

"""
deadlock, 349
  timeout during, ??
...

fsync configuration parameter, ??
...

full_page_writes configuration parameter,
??
"""

AFAICT tex is getting confused by <indexterm> entries appearing before
<term>. Or at least, switching the order seems to fix the problem.
Patch attached.

Josh


-- 
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] fix_index_references.patch (6.1K, 2-fix_index_references.patch)
  download | inline diff:
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 6e1b084..93528d5 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -1661,10 +1661,10 @@ include 'filename'
      </varlistentry>
 
      <varlistentry id="guc-fsync" xreflabel="fsync">
+      <term><varname>fsync</varname> (<type>boolean</type>)</term>
       <indexterm>
        <primary><varname>fsync</> configuration parameter</primary>
       </indexterm>
-      <term><varname>fsync</varname> (<type>boolean</type>)</term>
       <listitem>
        <para>
         If this parameter is on, the <productname>PostgreSQL</> server
@@ -1846,10 +1846,10 @@ include 'filename'
      </varlistentry>
 
      <varlistentry id="guc-full-page-writes" xreflabel="full_page_writes">
+      <term><varname>full_page_writes</varname> (<type>boolean</type>)</term>
       <indexterm>
        <primary><varname>full_page_writes</> configuration parameter</primary>
       </indexterm>
-      <term><varname>full_page_writes</varname> (<type>boolean</type>)</term>
       <listitem>
        <para>
         When this parameter is on, the <productname>PostgreSQL</> server
@@ -2920,6 +2920,7 @@ include 'filename'
      <variablelist>
 
      <varlistentry id="guc-geqo" xreflabel="geqo">
+      <term><varname>geqo</varname> (<type>boolean</type>)</term>
       <indexterm>
        <primary>genetic query optimization</primary>
       </indexterm>
@@ -2930,7 +2931,6 @@ include 'filename'
       <indexterm>
        <primary><varname>geqo</> configuration parameter</primary>
       </indexterm>
-      <term><varname>geqo</varname> (<type>boolean</type>)</term>
       <listitem>
        <para>
         Enables or disables genetic query optimization.
@@ -4972,6 +4972,7 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
      </varlistentry>
 
      <varlistentry id="guc-default-transaction-isolation" xreflabel="default_transaction_isolation">
+      <term><varname>default_transaction_isolation</varname> (<type>enum</type>)</term>
       <indexterm>
        <primary>transaction isolation level</primary>
        <secondary>setting default</secondary>
@@ -4979,7 +4980,7 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
       <indexterm>
        <primary><varname>default_transaction_isolation</> configuration parameter</primary>
       </indexterm>
-      <term><varname>default_transaction_isolation</varname> (<type>enum</type>)</term>
+
       <listitem>
        <para>
         Each SQL transaction has an isolation level, which can be
@@ -4998,6 +4999,7 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
      </varlistentry>
 
      <varlistentry id="guc-default-transaction-read-only" xreflabel="default_transaction_read_only">
+      <term><varname>default_transaction_read_only</varname> (<type>boolean</type>)</term>
       <indexterm>
        <primary>read-only transaction</primary>
        <secondary>setting default</secondary>
@@ -5006,7 +5008,6 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
        <primary><varname>default_transaction_read_only</> configuration parameter</primary>
       </indexterm>
 
-      <term><varname>default_transaction_read_only</varname> (<type>boolean</type>)</term>
       <listitem>
        <para>
         A read-only SQL transaction cannot alter non-temporary tables.
@@ -5021,6 +5022,8 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
      </varlistentry>
 
      <varlistentry id="guc-default-transaction-deferrable" xreflabel="default_transaction_deferrable">
+      <term><varname>default_transaction_deferrable</varname> (<type>boolean</type>)</term>
+
       <indexterm>
        <primary>deferrable transaction</primary>
        <secondary>setting default</secondary>
@@ -5029,7 +5032,6 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
        <primary><varname>default_transaction_deferrable</> configuration parameter</primary>
       </indexterm>
 
-      <term><varname>default_transaction_deferrable</varname> (<type>boolean</type>)</term>
       <listitem>
        <para>
         When running at the <literal>serializable</> isolation level,
@@ -5347,6 +5349,7 @@ SET XML OPTION { DOCUMENT | CONTENT };
      </varlistentry>
 
      <varlistentry id="guc-extra-float-digits" xreflabel="extra_float_digits">
+      <term><varname>extra_float_digits</varname> (<type>integer</type>)</term>
       <indexterm>
        <primary>significant digits</primary>
       </indexterm>
@@ -5358,7 +5361,6 @@ SET XML OPTION { DOCUMENT | CONTENT };
        <primary><varname>extra_float_digits</> configuration parameter</primary>
       </indexterm>
 
-      <term><varname>extra_float_digits</varname> (<type>integer</type>)</term>
       <listitem>
        <para>
         This parameter adjusts the number of digits displayed for
@@ -5634,6 +5636,7 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
      <variablelist>
 
      <varlistentry id="guc-deadlock-timeout" xreflabel="deadlock_timeout">
+      <term><varname>deadlock_timeout</varname> (<type>integer</type>)</term>
       <indexterm>
        <primary>deadlock</primary>
        <secondary>timeout during</secondary>
@@ -5646,7 +5649,6 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
        <primary><varname>deadlock_timeout</> configuration parameter</primary>
       </indexterm>
 
-      <term><varname>deadlock_timeout</varname> (<type>integer</type>)</term>
       <listitem>
        <para>
         This is the amount of time, in milliseconds, to wait on a lock
diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml
index 775d250..1a09c1c 100644
--- a/doc/src/sgml/libpq.sgml
+++ b/doc/src/sgml/libpq.sgml
@@ -2581,11 +2581,11 @@ char *PQresultErrorField(const PGresult *res, int fieldcode);
          </varlistentry>
 
          <varlistentry id="libpq-pg-diag-sqlstate">
+          <term><symbol>PG_DIAG_SQLSTATE</></term>
           <indexterm>
            <primary>error codes</primary>
            <secondary>libpq</secondary>
           </indexterm>
-          <term><symbol>PG_DIAG_SQLSTATE</></term>
           <listitem>
            <para>
             The SQLSTATE code for the error. The SQLSTATE code identifies


^ permalink  raw  reply  [nested|flat] 7+ messages in thread

* Re: broken index references
  2013-03-23 03:03 broken index references Josh Kupershmidt <[email protected]>
@ 2013-03-23 18:12 ` Tom Lane <[email protected]>
  2013-03-29 23:25   ` Re: broken index references Josh Kupershmidt <[email protected]>
  0 siblings, 1 reply; 7+ messages in thread

From: Tom Lane @ 2013-03-23 18:12 UTC (permalink / raw)
  To: Josh Kupershmidt <[email protected]>; +Cc: pgsql-docs

Josh Kupershmidt <[email protected]> writes:
> If you search through recent 9.2 or 9.3dev PDFs for the string "??"
> you should find ten occurrences. Other than the first instance in
> Chapter 9, the other nine are all in the index, and indicate an
> unknown reference to some index entry. ...
> AFAICT tex is getting confused by <indexterm> entries appearing before
> <term>. Or at least, switching the order seems to fix the problem.
> Patch attached.

Great catch, patch applied.

A different PDF-output problem that I've been noticing for awhile is that
certain intra-page links don't work.  The only clue I've found about it
is the warnings in the TeX log, for instance:

pdfTeX warning (dest): name{SQL-CREATETABLE-COMPATIBILITY-TITLE} has been refer
enced but does not exist, replaced by a fixed one

pdfTeX warning (dest): name{SQL-CREATEINDEX-STORAGE-PARAMETERS-TITLE} has been 
referenced but does not exist, replaced by a fixed one

pdfTeX warning (dest): name{SQL-CREATETABLE-STORAGE-PARAMETERS-TITLE} has been 
referenced but does not exist, replaced by a fixed one

pdfTeX warning (dest): name{SQL-CREATEINDEX-CONCURRENTLY-TITLE} has been refere
nced but does not exist, replaced by a fixed one

pdfTeX warning (dest): name{SQL-GROUPBY-TITLE} has been referenced but does not
 exist, replaced by a fixed one

pdfTeX warning (dest): name{SQL-WHERE-TITLE} has been referenced but does not e
xist, replaced by a fixed one

pdfTeX warning (dest): name{SQL-FROM-TITLE} has been referenced but does not ex
ist, replaced by a fixed one

If you look at the relevant intrapage links on these reference pages,
you find that they look right (the text does correspond to the
referenced title item), but the link actually goes to page 1 of the PDF.
(This is with the Fedora 16 PDF toolchain.)  Any idea what's causing that?

			regards, tom lane


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



^ permalink  raw  reply  [nested|flat] 7+ messages in thread

* Re: broken index references
  2013-03-23 03:03 broken index references Josh Kupershmidt <[email protected]>
  2013-03-23 18:12 ` Re: broken index references Tom Lane <[email protected]>
@ 2013-03-29 23:25   ` Josh Kupershmidt <[email protected]>
  2013-11-30 19:53     ` Re: broken index references Bruce Momjian <[email protected]>
  0 siblings, 1 reply; 7+ messages in thread

From: Josh Kupershmidt @ 2013-03-29 23:25 UTC (permalink / raw)
  To: Tom Lane <[email protected]>; +Cc: pgsql-docs

On Sat, Mar 23, 2013 at 11:12 AM, Tom Lane <[email protected]> wrote:
> A different PDF-output problem that I've been noticing for awhile is that
> certain intra-page links don't work.  The only clue I've found about it
> is the warnings in the TeX log, for instance:

I could have overlooked a working example.. but as far as I've seen,
every link of the form:

 <xref linkend="..." endterm="...">

just goes to Page 1 in the PDFs. I checked against a recent 9.2-A4.pdf
from the website and my own 9.3-A4.pdf built on Debian; the psql page
(psql-ref.sgml) has a number of such links. The links seem to work OK
in the HTML version, though.

Josh


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



^ permalink  raw  reply  [nested|flat] 7+ messages in thread

* Re: broken index references
  2013-03-23 03:03 broken index references Josh Kupershmidt <[email protected]>
  2013-03-23 18:12 ` Re: broken index references Tom Lane <[email protected]>
  2013-03-29 23:25   ` Re: broken index references Josh Kupershmidt <[email protected]>
@ 2013-11-30 19:53     ` Bruce Momjian <[email protected]>
  2013-11-30 22:23       ` Re: broken index references Josh Kupershmidt <[email protected]>
  0 siblings, 1 reply; 7+ messages in thread

From: Bruce Momjian @ 2013-11-30 19:53 UTC (permalink / raw)
  To: Josh Kupershmidt <[email protected]>; +Cc: Tom Lane <[email protected]>; pgsql-docs

On Fri, Mar 29, 2013 at 04:25:17PM -0700, Josh Kupershmidt wrote:
> On Sat, Mar 23, 2013 at 11:12 AM, Tom Lane <[email protected]> wrote:
> > A different PDF-output problem that I've been noticing for awhile is that
> > certain intra-page links don't work.  The only clue I've found about it
> > is the warnings in the TeX log, for instance:
> 
> I could have overlooked a working example.. but as far as I've seen,
> every link of the form:
> 
>  <xref linkend="..." endterm="...">
> 
> just goes to Page 1 in the PDFs. I checked against a recent 9.2-A4.pdf
> from the website and my own 9.3-A4.pdf built on Debian; the psql page
> (psql-ref.sgml) has a number of such links. The links seem to work OK
> in the HTML version, though.

Sorry to be looking at this late, but I just tested the 9.3.1 PDF at:

	http://www.postgresql.org/files/documentation/pdf/9.3/postgresql-9.3-US.pdf

and the link on page 1748 that links to section 31.14 worked fine:

	For additional environment variables, see Section 31.14.)

-- 
  Bruce Momjian  <[email protected]>        http://momjian.us
  EnterpriseDB                             http://enterprisedb.com

  + Everyone has their own god. +


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



^ permalink  raw  reply  [nested|flat] 7+ messages in thread

* Re: broken index references
  2013-03-23 03:03 broken index references Josh Kupershmidt <[email protected]>
  2013-03-23 18:12 ` Re: broken index references Tom Lane <[email protected]>
  2013-03-29 23:25   ` Re: broken index references Josh Kupershmidt <[email protected]>
  2013-11-30 19:53     ` Re: broken index references Bruce Momjian <[email protected]>
@ 2013-11-30 22:23       ` Josh Kupershmidt <[email protected]>
  2013-12-01 01:34         ` Re: broken index references Bruce Momjian <[email protected]>
  0 siblings, 1 reply; 7+ messages in thread

From: Josh Kupershmidt @ 2013-11-30 22:23 UTC (permalink / raw)
  To: Bruce Momjian <[email protected]>; +Cc: Tom Lane <[email protected]>; pgsql-docs

On Sat, Nov 30, 2013 at 2:53 PM, Bruce Momjian <[email protected]> wrote:
> On Fri, Mar 29, 2013 at 04:25:17PM -0700, Josh Kupershmidt wrote:
>> On Sat, Mar 23, 2013 at 11:12 AM, Tom Lane <[email protected]> wrote:
>> > A different PDF-output problem that I've been noticing for awhile is that
>> > certain intra-page links don't work.  The only clue I've found about it
>> > is the warnings in the TeX log, for instance:
>>
>> I could have overlooked a working example.. but as far as I've seen,
>> every link of the form:
>>
>>  <xref linkend="..." endterm="...">
>>
>> just goes to Page 1 in the PDFs. I checked against a recent 9.2-A4.pdf
>> from the website and my own 9.3-A4.pdf built on Debian; the psql page
>> (psql-ref.sgml) has a number of such links. The links seem to work OK
>> in the HTML version, though.
>
> Sorry to be looking at this late, but I just tested the 9.3.1 PDF at:
>
>         http://www.postgresql.org/files/documentation/pdf/9.3/postgresql-9.3-US.pdf
>
> and the link on page 1748 that links to section 31.14 worked fine:
>
>         For additional environment variables, see Section 31.14.)

[... jogging my memory ... ] I think the problem was specifically with
links of the form:

 <xref linkend="..." endterm="...">

having the "endterm" attribute specified -- your example didn't have
an "endterm". For an example, see the next page (p. 1749 according to
our page numbering, under the "Meta-Commands" sub-heading), for the
link to "SQL Interpolation" at the end of this paragraph:

    <para>
    If an unquoted colon (<literal>:</literal>) followed by a
    <application>psql</> variable name appears within an argument, it is
    replaced by the variable's value, as described in <xref
    linkend="APP-PSQL-interpolation" endterm="APP-PSQL-interpolation-title">.
    </para>

which at least in my PDF reader just sends one back to Page 1.

Josh


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



^ permalink  raw  reply  [nested|flat] 7+ messages in thread

* Re: broken index references
  2013-03-23 03:03 broken index references Josh Kupershmidt <[email protected]>
  2013-03-23 18:12 ` Re: broken index references Tom Lane <[email protected]>
  2013-03-29 23:25   ` Re: broken index references Josh Kupershmidt <[email protected]>
  2013-11-30 19:53     ` Re: broken index references Bruce Momjian <[email protected]>
  2013-11-30 22:23       ` Re: broken index references Josh Kupershmidt <[email protected]>
@ 2013-12-01 01:34         ` Bruce Momjian <[email protected]>
  2013-12-03 20:47           ` Re: broken index references Peter Eisentraut <[email protected]>
  0 siblings, 1 reply; 7+ messages in thread

From: Bruce Momjian @ 2013-12-01 01:34 UTC (permalink / raw)
  To: Josh Kupershmidt <[email protected]>; +Cc: Tom Lane <[email protected]>; pgsql-docs

On Sat, Nov 30, 2013 at 05:23:14PM -0500, Josh Kupershmidt wrote:
> > Sorry to be looking at this late, but I just tested the 9.3.1 PDF at:
> >
> >         http://www.postgresql.org/files/documentation/pdf/9.3/postgresql-9.3-US.pdf
> >
> > and the link on page 1748 that links to section 31.14 worked fine:
> >
> >         For additional environment variables, see Section 31.14.)
> 
> [... jogging my memory ... ] I think the problem was specifically with
> links of the form:
> 
>  <xref linkend="..." endterm="...">
> 
> having the "endterm" attribute specified -- your example didn't have
> an "endterm". For an example, see the next page (p. 1749 according to
> our page numbering, under the "Meta-Commands" sub-heading), for the
> link to "SQL Interpolation" at the end of this paragraph:
> 
>     <para>
>     If an unquoted colon (<literal>:</literal>) followed by a
>     <application>psql</> variable name appears within an argument, it is
>     replaced by the variable's value, as described in <xref
>     linkend="APP-PSQL-interpolation" endterm="APP-PSQL-interpolation-title">.
>     </para>
> 
> which at least in my PDF reader just sends one back to Page 1.

Yes, I confirm that failure on Debian.  Thank you.  Anyone want to
suggest a cause?

-- 
  Bruce Momjian  <[email protected]>        http://momjian.us
  EnterpriseDB                             http://enterprisedb.com

  + Everyone has their own god. +


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



^ permalink  raw  reply  [nested|flat] 7+ messages in thread

* Re: broken index references
  2013-03-23 03:03 broken index references Josh Kupershmidt <[email protected]>
  2013-03-23 18:12 ` Re: broken index references Tom Lane <[email protected]>
  2013-03-29 23:25   ` Re: broken index references Josh Kupershmidt <[email protected]>
  2013-11-30 19:53     ` Re: broken index references Bruce Momjian <[email protected]>
  2013-11-30 22:23       ` Re: broken index references Josh Kupershmidt <[email protected]>
  2013-12-01 01:34         ` Re: broken index references Bruce Momjian <[email protected]>
@ 2013-12-03 20:47           ` Peter Eisentraut <[email protected]>
  0 siblings, 0 replies; 7+ messages in thread

From: Peter Eisentraut @ 2013-12-03 20:47 UTC (permalink / raw)
  To: Bruce Momjian <[email protected]>; Josh Kupershmidt <[email protected]>; +Cc: Tom Lane <[email protected]>; pgsql-docs

On 11/30/13, 8:34 PM, Bruce Momjian wrote:
>>     <para>
>> >     If an unquoted colon (<literal>:</literal>) followed by a
>> >     <application>psql</> variable name appears within an argument, it is
>> >     replaced by the variable's value, as described in <xref
>> >     linkend="APP-PSQL-interpolation" endterm="APP-PSQL-interpolation-title">.
>> >     </para>
>> > 
>> > which at least in my PDF reader just sends one back to Page 1.
> Yes, I confirm that failure on Debian.  Thank you.  Anyone want to
> suggest a cause?

Apparently a bug in the tool chain.  The link works correctly when built
with FOP, so I think the markup is correct.



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




^ permalink  raw  reply  [nested|flat] 7+ messages in thread


end of thread, other threads:[~2013-12-03 20:47 UTC | newest]

Thread overview: 7+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2013-03-23 03:03 broken index references Josh Kupershmidt <[email protected]>
2013-03-23 18:12 ` Tom Lane <[email protected]>
2013-03-29 23:25   ` Josh Kupershmidt <[email protected]>
2013-11-30 19:53     ` Bruce Momjian <[email protected]>
2013-11-30 22:23       ` Josh Kupershmidt <[email protected]>
2013-12-01 01:34         ` Bruce Momjian <[email protected]>
2013-12-03 20:47           ` Peter Eisentraut <[email protected]>

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