Clarify bit numbering in get_bit/set_bit etc. Per gripe from

Boszormenyi Zoltan.
This commit is contained in:
Tom Lane 2010-08-15 21:26:36 +00:00
parent d915a275c1
commit 521c26ebf7

View File

@ -1,4 +1,4 @@
<!-- $PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.527 2010/08/13 18:36:23 tgl Exp $ --> <!-- $PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.528 2010/08/15 21:26:36 tgl Exp $ -->
<chapter id="functions"> <chapter id="functions">
<title>Functions and Operators</title> <title>Functions and Operators</title>
@ -2864,6 +2864,13 @@
</tgroup> </tgroup>
</table> </table>
<para>
<function>get_byte</> and <function>set_byte</> number the first byte
of a binary string as byte 0.
<function>get_bit</> and <function>set_bit</> number bits from the
right within each byte; for example bit 0 is the least significant bit of
the first byte, and bit 15 is the most significant bit of the second byte.
</para>
</sect1> </sect1>
@ -2969,6 +2976,8 @@
strings: strings:
<literal><function>get_bit</function></literal>, <literal><function>get_bit</function></literal>,
<literal><function>set_bit</function></literal>. <literal><function>set_bit</function></literal>.
When working with a bit string, these functions number the first
(leftmost) bit of the string as bit 0.
</para> </para>
<para> <para>