Small pod fixes

perl5-dbi · Aug 12, 2024 · 919591e · 919591e
1 parent 0ecfb86
commit 919591e
Show file tree

Hide file tree

Showing 18 changed files with 127 additions and 79 deletions.
diff --git a/DBI.pm b/DBI.pm
@@ -6690,6 +6690,10 @@ fields values for each row are unique.  If multiple rows are returned
 with the same values for the key fields then later rows overwrite
 earlier ones.
 
+=head3 C<more_results>
+
+... not yet documented ...
+
 =head3 C<finish>
 
   $rc  = $sth->finish;

diff --git a/Makefile.PL b/Makefile.PL
@@ -362,6 +362,10 @@ checkkeywords:
 	find . -type f \( -name .svn -prune -o -name \*.pm -o -name \*.PL -o -name \*.pl \) \
             -exec bash -c '[ -z "$$(svn pg svn:keywords {})" ] && echo svn propset svn:keywords \"Id Revision\" {}' \;
 
+.PHONY:	doc
+doc:
+	perl make-doc.pl
+
 checkpod:
 	$(RM_RF) blib
 	find . -type f \( -name .svn -prune -o -name \*.pm -o -name \*.PL -o -name \*.pl \) \

diff --git a/doc/DBD::File.3 b/doc/DBD::File.3
@@ -58,7 +58,7 @@
 .\" ========================================================================
 .\"
 .IX Title "DBD::File 3"
-.TH DBD::File 3 2024-08-08 "perl v5.40.0" "User Contributed Perl Documentation"
+.TH DBD::File 3 2024-08-12 "perl v5.40.0" "User Contributed Perl Documentation"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -137,18 +137,16 @@ affected table has been created in this session.  Valid after
 .PP
 \fIUnsupported DBI attributes and methods\fR
 .IX Subsection "Unsupported DBI attributes and methods"
-.PP
-bind_param_inout
-.IX Subsection "bind_param_inout"
-.PP
-CursorName
-.IX Subsection "CursorName"
-.PP
-LongReadLen
-.IX Subsection "LongReadLen"
-.PP
-LongTruncOk
-.IX Subsection "LongTruncOk"
+.IP bind_param_inout 2
+.IX Item "bind_param_inout"
+.PD 0
+.IP CursorName 2
+.IX Item "CursorName"
+.IP LongReadLen 2
+.IX Item "LongReadLen"
+.IP LongTruncOk 2
+.IX Item "LongTruncOk"
+.PD
 .PP
 \fIDBD::File specific attributes\fR
 .IX Subsection "DBD::File specific attributes"
@@ -367,12 +365,12 @@ releases on
 .Vb 2
 \&  @ary = DBI\->data_sources ($driver);
 \&  @ary = DBI\->data_sources ($driver, \e%attr);
-\&  
+\&
 \&  @ary = $dbh\->data_sources ();
 \&  @ary = $dbh\->data_sources (\e%attr);
 \&
 \&  @names = $dbh\->tables ($catalog, $schema, $table, $type);
-\&  
+\&
 \&  $sth = $dbh\->table_info ($catalog, $schema, $table, $type);
 \&  $sth = $dbh\->table_info ($catalog, $schema, $table, $type, \e%attr);
 \&

diff --git a/doc/DBD::File.html b/doc/DBD::File.html
@@ -28,14 +28,7 @@
               <li><a href="#NULLABLE">NULLABLE</a></li>
             </ul>
           </li>
-          <li><a href="#Unsupported-DBI-attributes-and-methods">Unsupported DBI attributes and methods</a>
-            <ul>
-              <li><a href="#bind_param_inout">bind_param_inout</a></li>
-              <li><a href="#CursorName">CursorName</a></li>
-              <li><a href="#LongReadLen">LongReadLen</a></li>
-              <li><a href="#LongTruncOk">LongTruncOk</a></li>
-            </ul>
-          </li>
+          <li><a href="#Unsupported-DBI-attributes-and-methods">Unsupported DBI attributes and methods</a></li>
           <li><a href="#DBD%3A%3AFile-specific-attributes">DBD::File specific attributes</a>
             <ul>
               <li><a href="#f_dir">f_dir</a></li>
@@ -144,13 +137,25 @@ <h4 id="NULLABLE">NULLABLE</h4>
 
 <h3 id="Unsupported-DBI-attributes-and-methods">Unsupported DBI attributes and methods</h3>
 
-<h4 id="bind_param_inout">bind_param_inout</h4>
+<dl>
 
-<h4 id="CursorName">CursorName</h4>
+<dt id="bind_param_inout">bind_param_inout</dt>
+<dd>
 
-<h4 id="LongReadLen">LongReadLen</h4>
+</dd>
+<dt id="CursorName">CursorName</dt>
+<dd>
 
-<h4 id="LongTruncOk">LongTruncOk</h4>
+</dd>
+<dt id="LongReadLen">LongReadLen</dt>
+<dd>
+
+</dd>
+<dt id="LongTruncOk">LongTruncOk</dt>
+<dd>
+
+</dd>
+</dl>
 
 <h3 id="DBD::File-specific-attributes">DBD::File specific attributes</h3>
 
@@ -286,18 +291,18 @@ <h4 id="sql_table_source">sql_table_source</h4>
 
 <p><code>$dbh-&gt;{sql_table_source}</code> can be set to <i>DBD::File::TableSource::FileSystem</i> (and is the default setting of DBD::File). This provides usual behaviour of previous DBD::File releases on</p>
 
-<pre><code> @ary = DBI-&gt;data_sources ($driver);
- @ary = DBI-&gt;data_sources ($driver, \%attr);
-
- @ary = $dbh-&gt;data_sources ();
- @ary = $dbh-&gt;data_sources (\%attr);
+<pre><code>@ary = DBI-&gt;data_sources ($driver);
+@ary = DBI-&gt;data_sources ($driver, \%attr);
+
+@ary = $dbh-&gt;data_sources ();
+@ary = $dbh-&gt;data_sources (\%attr);
+
+@names = $dbh-&gt;tables ($catalog, $schema, $table, $type);
 
- @names = $dbh-&gt;tables ($catalog, $schema, $table, $type);
-
- $sth = $dbh-&gt;table_info ($catalog, $schema, $table, $type);
- $sth = $dbh-&gt;table_info ($catalog, $schema, $table, $type, \%attr);
+$sth = $dbh-&gt;table_info ($catalog, $schema, $table, $type);
+$sth = $dbh-&gt;table_info ($catalog, $schema, $table, $type, \%attr);
 
- $dbh-&gt;func (&quot;list_tables&quot;);</code></pre>
+$dbh-&gt;func (&quot;list_tables&quot;);</code></pre>
 
 <h4 id="sql_data_source">sql_data_source</h4>
 

diff --git a/doc/DBD::File.md b/doc/DBD::File.md
@@ -67,13 +67,10 @@ affected table has been created in this session.  Valid after
 
 ### Unsupported DBI attributes and methods
 
-#### bind\_param\_inout
-
-#### CursorName
-
-#### LongReadLen
-
-#### LongTruncOk
+- bind\_param\_inout
+- CursorName
+- LongReadLen
+- LongTruncOk
 
 ### DBD::File specific attributes
 
@@ -255,12 +252,12 @@ releases on
 
     @ary = DBI->data_sources ($driver);
     @ary = DBI->data_sources ($driver, \%attr);
-    
+
     @ary = $dbh->data_sources ();
     @ary = $dbh->data_sources (\%attr);
 
     @names = $dbh->tables ($catalog, $schema, $table, $type);
-    
+
     $sth = $dbh->table_info ($catalog, $schema, $table, $type);
     $sth = $dbh->table_info ($catalog, $schema, $table, $type, \%attr);
 

diff --git a/doc/DBD::Mem.3 b/doc/DBD::Mem.3
@@ -58,7 +58,7 @@
 .\" ========================================================================
 .\"
 .IX Title "DBD::Mem 3"
-.TH DBD::Mem 3 2018-01-28 "perl v5.40.0" "User Contributed Perl Documentation"
+.TH DBD::Mem 3 2024-08-12 "perl v5.40.0" "User Contributed Perl Documentation"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -80,8 +80,7 @@ DBD::Mem \- a DBI driver for Mem & MLMem files
 and other variations on \fBconnect()\fR as shown in the DBI docs and 
 <DBI::DBD::SqlEngine metadata|DBI::DBD::SqlEngine/Metadata>.
 .PP
-Use standard DBI prepare, execute, fetch, placeholders, etc.,
-see "QUICK START" for an example.
+Use standard DBI prepare, execute, fetch, placeholders, etc.
 .SH DESCRIPTION
 .IX Header "DESCRIPTION"
 DBD::Mem is a database management system that works right out of the box.

diff --git a/doc/DBD::Mem.html b/doc/DBD::Mem.html
@@ -40,7 +40,7 @@ <h1 id="SYNOPSIS">SYNOPSIS</h1>
 
 <p>and other variations on connect() as shown in the <a>DBI</a> docs and &lt;DBI::DBD::SqlEngine metadata|DBI::DBD::SqlEngine/Metadata&gt;.</p>
 
-<p>Use standard DBI prepare, execute, fetch, placeholders, etc., see <a href="#QUICK-START">&quot;QUICK START&quot;</a> for an example.</p>
+<p>Use standard DBI prepare, execute, fetch, placeholders, etc.</p>
 
 <h1 id="DESCRIPTION">DESCRIPTION</h1>
 

diff --git a/doc/DBD::Mem.md b/doc/DBD::Mem.md
@@ -15,8 +15,7 @@ DBD::Mem - a DBI driver for Mem & MLMem files
 and other variations on connect() as shown in the [DBI](https://metacpan.org/pod/DBI) docs and 
 <DBI::DBD::SqlEngine metadata|DBI::DBD::SqlEngine/Metadata>.
 
-Use standard DBI prepare, execute, fetch, placeholders, etc.,
-see ["QUICK START"](#quick-start) for an example.
+Use standard DBI prepare, execute, fetch, placeholders, etc.
 
 # DESCRIPTION
 

diff --git a/doc/DBI.3 b/doc/DBI.3
@@ -5172,6 +5172,11 @@ fields values for each row are unique.  If multiple rows are returned
 with the same values for the key fields then later rows overwrite
 earlier ones.
 .PP
+\fR\f(CI\*(C`more_results\*(C'\fR\fI\fR
+.IX Subsection "more_results"
+.PP
+\&... not yet documented ...
+.PP
 \fR\f(CI\*(C`finish\*(C'\fR\fI\fR
 .IX Subsection "finish"
 .PP

diff --git a/doc/DBI.html b/doc/DBI.html
@@ -202,6 +202,7 @@
           <li><a href="#fetchrow_hashref">fetchrow_hashref</a></li>
           <li><a href="#fetchall_arrayref">fetchall_arrayref</a></li>
           <li><a href="#fetchall_hashref">fetchall_hashref</a></li>
+          <li><a href="#more_results">more_results</a></li>
           <li><a href="#finish">finish</a></li>
           <li><a href="#rows">rows</a></li>
           <li><a href="#bind_col">bind_col</a></li>
@@ -3387,6 +3388,10 @@ <h3 id="fetchall_hashref"><code>fetchall_hashref</code></h3>
 
 <p>The fetchall_hashref() method is normally used only where the key fields values for each row are unique. If multiple rows are returned with the same values for the key fields then later rows overwrite earlier ones.</p>
 
+<h3 id="more_results"><code>more_results</code></h3>
+
+<p>... not yet documented ...</p>
+
 <h3 id="finish"><code>finish</code></h3>
 
 <pre><code>$rc  = $sth-&gt;finish;</code></pre>

diff --git a/doc/DBI.md b/doc/DBI.md
@@ -4619,6 +4619,10 @@ fields values for each row are unique.  If multiple rows are returned
 with the same values for the key fields then later rows overwrite
 earlier ones.
 
+### `more_results`
+
+... not yet documented ...
+
 ### `finish`
 
     $rc  = $sth->finish;

diff --git a/doc/DBI::DBD::SqlEngine.3 b/doc/DBI::DBD::SqlEngine.3
@@ -58,7 +58,7 @@
 .\" ========================================================================
 .\"
 .IX Title "DBI::DBD::SqlEngine 3"
-.TH DBI::DBD::SqlEngine 3 2022-01-17 "perl v5.40.0" "User Contributed Perl Documentation"
+.TH DBI::DBD::SqlEngine 3 2024-08-12 "perl v5.40.0" "User Contributed Perl Documentation"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -506,7 +506,7 @@ following:
 .Vb 2
 \&  @ary = DBI\->data_sources($driver);
 \&  @ary = DBI\->data_sources($driver, \e%attr);
-\&  
+\&
 \&  @ary = $dbh\->data_sources();
 \&  @ary = $dbh\->data_sources(\e%attr);
 .Ve
@@ -516,7 +516,7 @@ following:
 .PP
 .Vb 1
 \&  @names = $dbh\->tables( $catalog, $schema, $table, $type );
-\&  
+\&
 \&  $sth = $dbh\->table_info( $catalog, $schema, $table, $type );
 \&  $sth = $dbh\->table_info( $catalog, $schema, $table, $type, \e%attr );
 \&

diff --git a/doc/DBI::DBD::SqlEngine.html b/doc/DBI::DBD::SqlEngine.html
@@ -425,20 +425,20 @@ <h3 id="DBI::DBD::SqlEngine::TableSource">DBI::DBD::SqlEngine::TableSource</h3>
 
 <p>The <code>data_sources</code> method is called when the user invokes any of the following:</p>
 
-<pre><code> @ary = DBI-&gt;data_sources($driver);
- @ary = DBI-&gt;data_sources($driver, \%attr);
- 
- @ary = $dbh-&gt;data_sources();
- @ary = $dbh-&gt;data_sources(\%attr);</code></pre>
+<pre><code>@ary = DBI-&gt;data_sources($driver);
+@ary = DBI-&gt;data_sources($driver, \%attr);
+
+@ary = $dbh-&gt;data_sources();
+@ary = $dbh-&gt;data_sources(\%attr);</code></pre>
 
 <p>The <code>avail_tables</code> method is called when the user invokes any of the following:</p>
 
-<pre><code> @names = $dbh-&gt;tables( $catalog, $schema, $table, $type );
- 
- $sth = $dbh-&gt;table_info( $catalog, $schema, $table, $type );
- $sth = $dbh-&gt;table_info( $catalog, $schema, $table, $type, \%attr );
+<pre><code>@names = $dbh-&gt;tables( $catalog, $schema, $table, $type );
+
+$sth = $dbh-&gt;table_info( $catalog, $schema, $table, $type );
+$sth = $dbh-&gt;table_info( $catalog, $schema, $table, $type, \%attr );
 
- $dbh-&gt;func( &quot;list_tables&quot; );</code></pre>
+$dbh-&gt;func( &quot;list_tables&quot; );</code></pre>
 
 <p>Every time where an <code>\%attr</code> argument can be specified, this <code>\%attr</code> object&#39;s <code>sql_table_source</code> attribute is preferred over the <code>$dbh</code> attribute or the driver default, eg.</p>
 

diff --git a/doc/DBI::DBD::SqlEngine.md b/doc/DBI::DBD::SqlEngine.md
@@ -381,15 +381,15 @@ following:
 
     @ary = DBI->data_sources($driver);
     @ary = DBI->data_sources($driver, \%attr);
-    
+
     @ary = $dbh->data_sources();
     @ary = $dbh->data_sources(\%attr);
 
 The `avail_tables` method is called when the user invokes any of the
 following:
 
     @names = $dbh->tables( $catalog, $schema, $table, $type );
-    
+
     $sth = $dbh->table_info( $catalog, $schema, $table, $type );
     $sth = $dbh->table_info( $catalog, $schema, $table, $type, \%attr );
 
@@ -418,7 +418,7 @@ opened (file-)streams (eg. for DBD::CSV).
 
 Derived classes shall be restricted to similar functionality, too (eg.
 opening streams from an archive, transparently compress/uncompress
-log files before parsing them, 
+log files before parsing them,
 
     package DBI::DBD::SqlEngine::DataSource;
 

diff --git a/lib/DBD/File.pm b/lib/DBD/File.pm
@@ -1037,13 +1037,17 @@ C<< $sth->execute >>; undef for non-select statements.
 
 =head3 Unsupported DBI attributes and methods
 
-=head4 bind_param_inout
+=over 2
 
-=head4 CursorName
+=item bind_param_inout
 
-=head4 LongReadLen
+=item CursorName
 
-=head4 LongTruncOk
+=item LongReadLen
+
+=item LongTruncOk
+
+=back
 
 =head3 DBD::File specific attributes
 
@@ -1234,12 +1238,12 @@ releases on
 
   @ary = DBI->data_sources ($driver);
   @ary = DBI->data_sources ($driver, \%attr);
-  
+
   @ary = $dbh->data_sources ();
   @ary = $dbh->data_sources (\%attr);
 
   @names = $dbh->tables ($catalog, $schema, $table, $type);
-  
+
   $sth = $dbh->table_info ($catalog, $schema, $table, $type);
   $sth = $dbh->table_info ($catalog, $schema, $table, $type, \%attr);
 

diff --git a/lib/DBD/Mem.pm b/lib/DBD/Mem.pm
@@ -300,8 +300,7 @@ DBD::Mem - a DBI driver for Mem & MLMem files
 and other variations on connect() as shown in the L<DBI> docs and 
 <DBI::DBD::SqlEngine metadata|DBI::DBD::SqlEngine/Metadata>.
 
-Use standard DBI prepare, execute, fetch, placeholders, etc.,
-see L<QUICK START> for an example.
+Use standard DBI prepare, execute, fetch, placeholders, etc.
 
 =head1 DESCRIPTION