[CDRIVER-967] basic-troubleshooting manpage not rendering well Created: 27/Oct/15  Updated: 10/Aug/16  Resolved: 26/Apr/16

Status: Closed
Project: C Driver
Component/s: None
Affects Version/s: 1.2.0
Fix Version/s: 1.4.0

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

Issue Links:
Related
related to CDRIVER-976 man pages have stray "\&" Closed

 Description   

man doc/man/basic-troubleshooting.3

BASIC TROUBLESHOOTING(3)                                                                                 Library Functions Manual                                                                                BASIC TROUBLESHOOTING(3)
 
NAME
       Basic Troubleshooting - None
 
TROUBLESHOOTING CHECKLIST
       The following is a short list of things to check when you have a problem.
 
       \[bu]
         Did you call mongoc_init(3) in main(3) ? If not, you will likely see a segfault.
 
       \[bu]
         Have you leaked any clients or cursors as can be found with ?
 
       \[bu]
         Have packets been delivered to the server? See egress bytes from \&.
 
       \[bu]
         Does valgrind show any leaks? Ensure you call mongoc_cleanup(3) at the end of your process to cleanup lingering allocations from the MongoDB C driver.
 
       \[bu]
         If compiling your own copy of MongoDB C driver, consider configuring with ‐‐enable‐tracing to enable function tracing and hex dumps of network packets to STDERR and STDOUT \&.

Not sure what that escape sequence is supposed to do.. A bullet point maybe?
Whatever its doing, its not working.



 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

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