get_bit etc.

Brian Minton <bminton@efn.org> writes:

Is there any documentation for the functions get_bit(bytea,integer),
get_byte(bytea,integer), set_bit(bytea,integer,integer), and
set_byte(bytea,integer,integer)?

I don't see any :-(

A documentation patch would be welcomed.

regards, tom lane

Tom Lane wrote:

Brian Minton <bminton@efn.org> writes:

Is there any documentation for the functions get_bit(bytea,integer),
get_byte(bytea,integer), set_bit(bytea,integer,integer), and
set_byte(bytea,integer,integer)?

I don't see any :-(

A documentation patch would be welcomed.

ok, how do I do that? They are simple enough functions, and it was easy
to figure out what they did, but there is no mention of them, I guess
maybe they are "unofficial" functions.

Brian Minton <bminton@efn.org> writes:

Tom Lane wrote:

A documentation patch would be welcomed.

ok, how do I do that?

Ideally, send a patch diff against the appropriate .sgml file in the doc
source tree to pgsql-patches. If you're not up for patching SGML, write
some plain ASCII text that would fit into the docs and send it to
pgsql-docs; somebody will take care of marking it up in SGML and
committing it where it belongs.

They are simple enough functions, and it was easy
to figure out what they did, but there is no mention of them, I guess
maybe they are "unofficial" functions.

No, they're clearly intended as user-accessible functions. I'd say the
author was too dern lazy to include any documentation when he submitted
the code patch :-(. We have a lot of that disease goin' round.

regards, tom lane

I have added documentation for all the bit/byte get/set functions, and
added a pg_description comment for each of them --- patch attached.

---------------------------------------------------------------------------

Tom Lane wrote:

Brian Minton <bminton@efn.org> writes:

Tom Lane wrote:

A documentation patch would be welcomed.

ok, how do I do that?

Ideally, send a patch diff against the appropriate .sgml file in the doc
source tree to pgsql-patches. If you're not up for patching SGML, write
some plain ASCII text that would fit into the docs and send it to
pgsql-docs; somebody will take care of marking it up in SGML and
committing it where it belongs.

They are simple enough functions, and it was easy
to figure out what they did, but there is no mention of them, I guess
maybe they are "unofficial" functions.

No, they're clearly intended as user-accessible functions. I'd say the
author was too dern lazy to include any documentation when he submitted
the code patch :-(. We have a lot of that disease goin' round.

regards, tom lane

---------------------------(end of broadcast)---------------------------
TIP 6: Have you searched our list archives?

http://archives.postgresql.org

-- 
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 359-1001
  +  If your life is a hard drive,     |  13 Roberts Road
  +  Christ can be your backup.        |  Newtown Square, Pennsylvania 19073