Bug in the mandoc(3) man page

Bug in the mandoc(3) man page

[Abhinav Upadhyay]

Hello,

I think there is some inconsistency in the mandoc(3) man page. The
argument names of mandoc_escape function in the SYNOPSIS section do
not agree with the argument names in the DESCRIPTION section. I
referred to the source file and corrected the argument names in
SYNOPSIS. Following is the diff (taken against mdocml 1.12 in NetBSD
-current), if you think it is ok, then please
fix this :)



Index: mandoc.3
===================================================================
RCS file: /cvsroot/src/external/bsd/mdocml/dist/mandoc.3,v
retrieving revision 1.1.1.2
diff -u -p -r1.1.1.2 mandoc.3
--- mandoc.3    11 Oct 2011 19:09:38 -0000      1.1.1.2
+++ mandoc.3    12 Oct 2011 14:38:56 -0000
@@ -50,9 +50,9 @@
 .In mandoc.h
 .Ft "enum mandoc_esc"
 .Fo mandoc_escape
-.Fa "const char **in"
-.Fa "const char **seq"
-.Fa "int *len"
+.Fa "const char **end"
+.Fa "const char **start"
+.Fa "int *sz"
 .Fc
 .Ft "const struct man_meta *"
 .Fo man_meta


--
Abhinav Upadhyay
--
 To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv

Re: Bug in the mandoc(3) man page

[Kristaps Dzonsons]

On 10/18/11 15:02, Abhinav Upadhyay wrote:
> Hello,
>
> I think there is some inconsistency in the mandoc(3) man page. The
> argument names of mandoc_escape function in the SYNOPSIS section do
> not agree with the argument names in the DESCRIPTION section. I
> referred to the source file and corrected the argument names in
> SYNOPSIS. Following is the diff (taken against mdocml 1.12 in NetBSD
> -current), if you think it is ok, then please
> fix this :)

Abhinav,

Thanks for the report---fixed!

Take care,

Kristaps
--
 To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv