[CDRIVER-2035] bson_api.3 and bson_index.3 man pages include all other pages Created: 06/Feb/17  Updated: 29/Jan/18  Resolved: 04/Mar/17

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

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


 Description   

A bug in the port of our man pages from Mallard to Sphinx: the existing man page bson_index.3 and the new page bson_api.3 now include all other documentation. Same for mongoc. Consider not generating these man pages at all, I don't think they're useful.



 Comments   
Comment by Githook User [ 29/Jan/18 ]

Author:

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

Message: CDRIVER-2035 dead code in man page renderer
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/73098d667ce5e4b4f3a4a5c89c7faf8aada57afe

Comment by Githook User [ 04/Mar/17 ]

Author:

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

Message: CDRIVER-2035 don't build index and API man pages

bson_api.3 and bson_index.3 man pages include all other pages, so
skip them.
Branch: master
https://github.com/mongodb/libbson/commit/2ae77152f5cfe24fe429e81becd87b811677cf8f

Comment by Githook User [ 04/Mar/17 ]

Author:

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

Message: CDRIVER-2035 don't build index and API man pages

mongoc_api.3 and mongoc_index.3 man pages include all other pages, so
skip them.
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/ea5d1cd20092d6eea9fbd8e43903e063d78f94a1

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