[CDRIVER-621] typo in libbson man pages Created: 22/Apr/15  Updated: 07/Oct/15  Resolved: 29/May/15

Status: Closed
Project: C Driver
Component/s: docs
Affects Version/s: None
Fix Version/s: 1.2-beta0

Type: Bug Priority: Major - P3
Reporter: Remi Collet Assignee: A. Jesse Jiryu Davis
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:


 Description   

In libbson 1.2.0beta

libbson-devel.x86_64: W: manual-page-warning /usr/share/man/man3/bson_zero_free.3.gz 42: warning: macro `d' not defined
libbson-devel.x86_64: W: manual-page-warning /usr/share/man/man3/bson_json_reader_new_from_fd.3.gz 35: warning: macro `d' not defined
libbson-devel.x86_64: W: manual-page-warning /usr/share/man/man3/bson_oid_t.3.gz 56: warning: macro `s' not defined
libbson-devel.x86_64: W: manual-page-warning /usr/share/man/man3/bson_reader_new_from_fd.3.gz 35: warning: macro `d' not defined

I think ".B .B" is not correct (and thus ".B mem" is displayed)



 Comments   
Comment by Githook User [ 07/Oct/15 ]

Author:

{u'username': u'ajdavis', u'name': u'A. Jesse Jiryu Davis', u'email': u'jesse@mongodb.com'}

Message: CDRIVER-621 fix groff output in synopses
Branch: master
https://github.com/mongodb/libbson/commit/5c94b6527a721b1a910da322d0d97cff684f6cb3

Comment by Githook User [ 07/Oct/15 ]

Author:

{u'username': u'ajdavis', u'name': u'A. Jesse Jiryu Davis', u'email': u'jesse@mongodb.com'}

Message: CDRIVER-621 fix groff output in man pages
Branch: master
https://github.com/mongodb/libbson/commit/90537e091d03686a07ac7987f18be75d5d108f47

Comment by Githook User [ 07/Oct/15 ]

Author:

{u'username': u'ajdavis', u'name': u'A. Jesse Jiryu Davis', u'email': u'jesse@mongodb.com'}

Message: CDRIVER-621 man page markup that confuses groff
Branch: master
https://github.com/mongodb/libbson/commit/a174ef92ad8bce3e96a0967c7b2fccf9f58ceae3

Comment by Githook User [ 29/May/15 ]

Author:

{u'username': u'ajdavis', u'name': u'A. Jesse Jiryu Davis', u'email': u'jesse@mongodb.com'}

Message: CDRIVER-621 fix groff output in man pages
Branch: 1.2.0-dev
https://github.com/mongodb/mongo-c-driver/commit/628d744aac1c5259e7db084521bccae947257e27

Comment by A. Jesse Jiryu Davis [ 29/May/15 ]

Fixed, all the '.B .B' junk is gone and I can run the "gtbl" and "groff" commands you showed me on all man pages without warnings.

https://github.com/mongodb/libbson/commit/a174ef92ad8bce3e96a0967c7b2fccf9f58ceae3

https://github.com/mongodb/libbson/commit/90537e091d03686a07ac7987f18be75d5d108f47

https://github.com/mongodb/libbson/commit/90611c0cdaf5c2f19e87fd11cc9e4cf94598a915

Comment by Remi Collet [ 29/May/15 ]

Yes, this is output from rpmlint, but can also be checked with groff (command extracted from rpmlint sources)

$gunzip -dc /usr/share/man/man3/bson_reader_new_from_fd.3.gz | gtbl | groff -mtty-char -Tutf8 -P-c -mandoc -wmac >/dev/,ull
<standard input>:35: warning: macro `d' not defined

Comment by A. Jesse Jiryu Davis [ 29/May/15 ]

Thanks for the report. What's generating that warning, please? This one:

macro `d' not defined

Is it rpmlint?

Generated at Wed Feb 07 21:10:05 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.