Bug 192520 - Manpage errors with TIMEOUT(9)
Summary: Manpage errors with TIMEOUT(9)
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Gavin Atkinson
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2014-08-08 19:04 UTC by Enji Cooper
Modified: 2015-07-08 17:37 UTC (History)
1 user (show)

See Also:
bugmeister: mfc-stable10?
bugmeister: mfc-stable9?
bugmeister: mfc-stable8?

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Enji Cooper freebsd_committer freebsd_triage 2014-08-08 19:04:29 UTC 
FreeBSD isilon-fuji-current.local 11.0-CURRENT FreeBSD 11.0-CURRENT #16 r268804+343692e(isilon-atf): Mon Jul 14 12:17:25 PDT 2014     root@isilon-fuji-current.local:/usr/obj/usr/src/sys/FUJI  i386
# man callout_init > /dev/null
mdoc error: .It without preceding .Bl (#375)
mdoc warning: extraneous .El call (#379)
mdoc warning: extraneous .El call (#600)

This text looks wrong as well (void() being a void function, instead of the type for callout_init_rm):

     void();

     callout_init_rm(struct callout *c, struct rmlock *rm, int flags);

callout_deactivate is missing a return type too:

     int
     callout_active(struct callout *c);

     callout_deactivate(struct callout *c);
Comment 1 Enji Cooper freebsd_committer freebsd_triage 2014-08-08 19:08:01 UTC 
(sorry, mav@, I CCed the wrong dev :(..)
Comment 2 commit-hook freebsd_committer freebsd_triage 2014-08-20 23:30:09 UTC 
A commit references this bug:

Author: gavin
Date: Wed Aug 20 23:29:35 UTC 2014
New revision: 270251
URL: http://svnweb.freebsd.org/changeset/base/270251

Log:
  Fix return type of callout_init_rm() and add return type to
  callout_deactivate().

  PR:		192520
  Submitted by:	yaneurabeya gmail com
  MFC after:	3 days

Changes:
  head/share/man/man9/timeout.9
Comment 3 Gavin Atkinson freebsd_committer freebsd_triage 2014-08-20 23:33:11 UTC 
I've corrected the two return types, and r268817 had already corrected the mdoc markup issue.  I'll merge the changes to the stable branch next week.  Thanks for your submission!
Comment 4 commit-hook freebsd_committer freebsd_triage 2014-09-03 23:15:05 UTC 
A commit references this bug:

Author: gavin
Date: Wed Sep  3 23:14:27 UTC 2014
New revision: 271064
URL: http://svnweb.freebsd.org/changeset/base/271064

Log:
  Merge r270251 from head:

    Fix return type of callout_init_rm() and add return type to
    callout_deactivate().

  PR:		192520
  Submitted by:	ngie

Changes:
_U  stable/10/
  stable/10/share/man/man9/timeout.9
Comment 5 Glen Barber freebsd_committer freebsd_triage 2015-07-08 17:37:22 UTC 
Close PRs that have a corresponding commit to resolve the issue.