Fix documentation rice partition order
authorMartijn van Beurden <mvanb1@gmail.com>
Wed, 18 Sep 2013 16:51:17 +0000 (18:51 +0200)
committerErik de Castro Lopo <erikd@mega-nerd.com>
Wed, 25 Sep 2013 13:33:55 +0000 (23:33 +1000)
For some reason all documentation lists the max rice partition
order to be 16, while the maximum is 15. This fixes flac -H, the
man page and the HTML source code documentation

Signed-off-by: Erik de Castro Lopo <erikd@mega-nerd.com>
doc/html/documentation_tools_flac.html
man/flac.1
man/flac.sgml

index 935c07d..ea1b8a1 100644 (file)
                                <td>
                                        Set the [min,]max residual partition order.  The min value defaults to 0 if unspecified.<br />
                                        <br />
-                                       By default the encoder uses a single Rice parameter for the subframe's entire residual.  With this option, the residual is iteratively partitioned into 2^min# .. 2^max# pieces, each with its own Rice parameter.  Higher values of max# yield diminishing returns.  The most bang for the buck is usually with <span class="argument">-r 2,2</span> (more for higher block sizes).  This usually shaves off about 1.5%.  The technique tends to peak out about when blocksize/(2^n)=128.  Use <span class="argument">-r 0,16</span> to force the highest degree of optimization.
+                                       By default the encoder uses a single Rice parameter for the subframe's entire residual.  With this option, the residual is iteratively partitioned into 2^min# .. 2^max# pieces, each with its own Rice parameter.  Higher values of max# yield diminishing returns.  The most bang for the buck is usually with <span class="argument">-r 2,2</span> (more for higher block sizes).  This usually shaves off about 1.5%.  The technique tends to peak out about when blocksize/(2^n)=128.  Use <span class="argument">-r 0,15</span> to force the highest degree of optimization.
                                </td>
                        </tr>
                </table>
index b9ec990..aaa9b05 100644 (file)
@@ -3,7 +3,7 @@
 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
 .\" Please send any bug reports, improvements, comments, patches, 
 .\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "FLAC" "1" "2013/04/30" "" ""
+.TH "FLAC" "1" "2013/09/18" "" ""
 
 .SH NAME
 flac \- Free Lossless Audio Codec
@@ -300,7 +300,7 @@ Do exhaustive search of LP coefficient quantization (expensive!).  Overrides -q;
 Precision of the quantized linear-predictor coefficients, 0 => let encoder decide (min is 5, default is 0)
 .TP
 \fB-r [\fI#\fB,]\fI#\fB, --rice-partition-order=[\fI#\fB,]\fI#\fB\fR
-Set the [min,]max residual partition order (0..16). min defaults to 0 if unspecified.  Default is -r 5.
+Set the [min,]max residual partition order (0..15). min defaults to 0 if unspecified.  Default is -r 5.
 .SS "FORMAT OPTIONS"
 .TP
 \fB--endian={\fIbig\fB|\fIlittle\fB}\fR
@@ -378,9 +378,9 @@ Force the decoder to output Wave64 format.  This option is not needed if the out
 These flags can be used to invert the sense of the corresponding normal option.
 .SH "SEE ALSO"
 .PP
-metaflac(1).
+metaflac(1)
 .PP
 The programs are documented fully by HTML format documentation, available in \fI/usr/share/doc/libflac-doc/html\fR on Debian GNU/Linux systems.
 .SH "AUTHOR"
 .PP
-This manual page was written by Matt Zimmerman <mdz@debian.org> for the Debian GNU/Linux system (but may be used by others).
+This manual page was initially written by Matt Zimmerman <mdz@debian.org> for the Debian GNU/Linux system (but may be used by others). It has been kept up-to-date by the Xiph.org Foundation.
index b76722b..7fa410b 100644 (file)
@@ -4,7 +4,7 @@
   <!ENTITY dhfirstname "<firstname>Matt</firstname>">
   <!ENTITY dhsurname   "<surname>Zimmerman</surname>">
   <!-- Please adjust the date whenever revising the manpage. -->
-  <!ENTITY dhdate      "<date>2013/04/30</date>">
+  <!ENTITY dhdate      "<date>2013/09/18</date>">
   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
        allowed: see man(7), man(1). -->
   <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
          <term><option>-r</option> [<replaceable>#</replaceable>,]<replaceable>#</replaceable>, <option>--rice-partition-order</option>=[<replaceable>#</replaceable>,]<replaceable>#</replaceable></term>
 
          <listitem>
-           <para>Set the [min,]max residual partition order (0..16). min defaults to 0 if unspecified.  Default is -r 5.</para>
+           <para>Set the [min,]max residual partition order (0..15). min defaults to 0 if unspecified.  Default is -r 5.</para>
          </listitem>
        </varlistentry>
 
   <refsect1>
     <title>SEE ALSO</title>
 
-    <para>metaflac(1).</para>
+    <para>metaflac(1)</para>
 
     <para>The programs are documented fully by HTML format documentation, available in <filename>/usr/share/doc/libflac-doc/html</filename> on &debian; systems.</para>
   </refsect1>
   <refsect1>
     <title>AUTHOR</title>
 
-    <para>This manual page was written by &dhusername; &dhemail; for the &debian; system (but may be used by others).</para>
+    <para>This manual page was initially written by &dhusername; &dhemail; for the &debian; system (but may be used by others). It has been kept up-to-date by the Xiph.org Foundation.</para>
 
     <!-- <para>Permission is granted to copy, distribute and/or modify this document under the terms of the <acronym>GNU</acronym> Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts and no Back-Cover Texts.  A copy of the license can be found under <filename>/usr/share/common-licenses/FDL</filename>.</para> -->