Manpages als reStructuredText erstellt
Unsere Manpages wurden mit einem LPC-Tool in
reStructuredText konvertiert und liegen jetzt
in diesem Verzeichnis als Quelldaten.
Aus diesen reStructuredText sollen dann per
Script die ASCII-Manpages und per Sphinx HTML u.a.
erzeugt werden.
Change-Id: I75d659a7b3f9863aecb11dbeb0037e6cae227c36
diff --git a/doc/sphinx/sefun/broken_count_bits.rst b/doc/sphinx/sefun/broken_count_bits.rst
new file mode 100644
index 0000000..06f2bc8
--- /dev/null
+++ b/doc/sphinx/sefun/broken_count_bits.rst
@@ -0,0 +1,48 @@
+broken_count_bits()
+===================
+
+SYNOPSIS
+--------
+::
+
+ int count_bits (string str)
+
+DESTRIPTION
+-----------
+::
+
+ Count the number of set bits in bitstring <str> and return the number
+ as result.
+
+NOTE
+----
+::
+
+ Bitstrings store 6 Bits per Character. Consequently, the functions for
+ manipulating bitstrings (see below) do generally not work on most
+ strings. An exception is this (s)efun. It accepts strings which are
+ not correct bitstrings (like getuid(PL)), BUT: It does NOT work
+ correctly on them! The results are NOT the correct number of bits!
+ Additionally, count_bits() in LDMud rejects such strings with an error
+ instead of returning false results, as all the other functions for
+ bitstrings do as well.
+
+EXAMPLES
+--------
+::
+
+ string s;
+
+ s = set_bit("", 3); s = set_bit(s, 15);
+
+ count_bits(s) --> returns 2
+
+SEE ALSO
+--------
+::
+
+ clear_bit(E), set_bit(E), test_bit(E), next_bit(E), last_bit(E),
+ or_bits(E), xor_bits(E), invert_bits(E), copy_bits(E)
+
+19.12.2006, Zesstra
+