From: Abhinav Upadhyay <er.abhinav.upadhyay@gmail.com>
To: discuss@mdocml.bsd.lv
Subject: Bug in the mandoc(3) man page
Date: Tue, 18 Oct 2011 18:32:39 +0530 [thread overview]
Message-ID: <CAHwRYJ=2dBM4Y2V7R4t1wF2drhHrx7uvvV=-4xiGaj4hpwBX-A@mail.gmail.com> (raw)
In-Reply-To: <CAHwRYJ=STvxAt4PWoJOMzHpGQuNGKtyUUwHV9AWVm0mBV+tp6Q@mail.gmail.com>
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
next parent reply other threads:[~2011-10-18 13:02 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <CAHwRYJ=STvxAt4PWoJOMzHpGQuNGKtyUUwHV9AWVm0mBV+tp6Q@mail.gmail.com>
2011-10-18 13:02 ` Abhinav Upadhyay [this message]
2011-10-18 13:25 ` Kristaps Dzonsons
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAHwRYJ=2dBM4Y2V7R4t1wF2drhHrx7uvvV=-4xiGaj4hpwBX-A@mail.gmail.com' \
--to=er.abhinav.upadhyay@gmail.com \
--cc=discuss@mdocml.bsd.lv \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).