[CDRIVER-1077] Man page names are too generic Created: 29/Jan/16  Updated: 16/Nov/16  Resolved: 27/Mar/16

Status: Closed
Project: C Driver
Component/s: docs, libbson, libmongoc
Affects Version/s: None
Fix Version/s: 1.4.0

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

Issue Links:
Related
is related to CDRIVER-1039 libbson 1.3.0 man pages (distribute m... Closed
is related to CDRIVER-1923 libbson install memory.3 and clock.3 ... Closed

 Description   

Man page names like "index" or "installing" make it impossible to cleanly install libbson's and libmongoc's man pages side-by-side on some systems, and violate Debian (and other) packaging guidelines. Should probably prefix everything with "bson_" or "mongoc_".



 Comments   
Comment by Githook User [ 26/Apr/16 ]

Author:

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

Message: mallard2man fixes

CDRIVER-976 stray ampersands in man pages, and CDRIVER-967, badly
rendered bullet points, and CDRIVER-1077 rename error-api.3 to
mongoc-error-api.3.

Silence warnings about <info>, <steps>, <desc>, <links>, and <thead>
elements. Handle <example>. Remove extra indentation from paragraphs,
and fix rendering of titles that contain double quotes.
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/d71d82bf5a79bf4b0e12cd5171302e04d499d291

Comment by Githook User [ 27/Mar/16 ]

Author:

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

Message: CDRIVER-1077 prefix all man pages with "mongoc_"
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/a7e41b2772f159993123cdd3d5f34de34446b950

Comment by Githook User [ 25/Mar/16 ]

Author:

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

Message: CDRIVER-1077 prefix all man pages with "bson_"

Also fix structure of some page files that had no <section>.
Branch: master
https://github.com/mongodb/libbson/commit/0fab012f623c3e087a45b6732ad194cca49e2014

Comment by Peng Xie [ 10/Feb/16 ]

"clock.3" in libbson-1.3.3 makes another collision with clock_t clock(void) in time.h.

Comment by A. Jesse Jiryu Davis [ 29/Jan/16 ]

Debian Bug Tracking System reports:

libbson: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=812948

libmongoc: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=812949

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