OpenBSD src/sbin was used as a tool to hunt bugs in mandoc.

[mandoc.git] / roff.3

diff --git a/roff.3 b/roff.3
index fcc47395b9cea7cacbdf8179ce32b99c57c8197a..d41deee065d8ec066596cbb73baac243ab0b38c7 100644 (file)
--- a/roff.3
+++ b/roff.3
@@ -1,4 +1,4 @@
-.\"    $Id: roff.3,v 1.1 2010/05/25 22:16:59 kristaps Exp $
+.\"    $Id: roff.3,v 1.7 2010/07/13 23:53:20 schwarze Exp $
 .\"
 .\" Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"
@@ -14,7 +14,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: May 25 2010 $
+.Dd $Mdocdate: July 13 2010 $
 .Dt ROFF 3
 .Os
 .Sh NAME
@@ -29,7 +29,11 @@
 .In mandoc.h
 .In roff.h
 .Ft "struct roff *"
-.Fn roff_alloc "mandocmsg msgs" "void *data"
+.Fo roff_alloc
+.Fa "struct regset *regs"
+.Fa "mandocmsg msgs"
+.Fa "void *data"
+.Fc
 .Ft int
 .Fn roff_endparse "struct roff *roff"
 .Ft void
@@ -154,3 +158,15 @@ The
 .Nm
 library was written by
 .An Kristaps Dzonsons Aq kristaps@bsd.lv .
+.Sh BUGS
+The implementation of user-defined strings needs improvement:
+.Bl -dash
+.It
+String values are taken literally and are not interpreted.
+.It
+Parsing of quoted strings is incomplete.
+.It
+The stings are stored internally using a singly linked list,
+which is fine for small numbers of strings,
+but ineffient when handling many strings.
+.El