[CDRIVER-1926] Entire sentences missing after links in manpages Created: 17/Nov/16  Updated: 21/Dec/16  Resolved: 21/Dec/16

Status: Closed
Project: C Driver
Component/s: docs, python
Affects Version/s: None
Fix Version/s: 1.6.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


 Description   

There are entire sentences missing in our generated man pages.

    <p>The most recent release of libbson is 1.4.1 and can be <link href="https://github.com/mongodb/libbson/releases/download/1.4.1/libbson-1.4.1.tar.gz">downloaded here</link>. The following snippet will download and extract the current release of the driver.</p>
 
    <screen><output style="prompt">$ </output><input>wget https://github.com/mongodb/libbson/releases/download/1.4.1/libbson-1.4.1.tar.gz</input>
<output style="prompt">$ </output><input>tar -xzf libbson-1.4.1.tar.gz</input>
<output style="prompt">$ </output><input>cd libbson-1.4.1/</input></screen>

becomes

The most recent release of libbson is 1.4.1 and can be    
.B downloaded here                        
. The following snippet will download and extract the current release of the driver.
                               
.B $                                      
.B wget https://github.com/mongodb/libbson/releases/download/1.4.1/libbson-1.4.1.tar.gz
.B $                           
.B tar -xzf libbson-1.4.1.tar.gz    
.B $                                    
.B cd libbson-1.4.1/    

which is rendered as:

       The most recent release of libbson is 1.4.1 and can be downloaded here
 
       $ wget https://github.com/mongodb/libbson/releases/download/1.4.1/libbson-1.4.1.tar.gz $ tar -xzf libbson-1.4.1.tar.gz $ cd libbson-1.4.1/
 

The

The following snippet will download and extract the current release of the driver.

is missing, and the code sample is all in one line.



 Comments   
Comment by Githook User [ 21/Dec/16 ]

Author:

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

Message: CDRIVER-1926 more man page syntax fixes

Don't replace all "()" with "(3)", and fix some <output> formatting.
Branch: master
https://github.com/mongodb/libbson/commit/88080077d72b86b33248ff7bcbb136d91c1be249

Comment by Githook User [ 21/Dec/16 ]

Author:

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

Message: CDRIVER-1926 fix truncated man page lines

Mallard lines like "Optional <code>bson_t</code>. Might be NULL." was output as:

Optional
.B bson_t
. Might be NULL.

Groff misinterprets, and truncates at the first period. Escape the dot:

Optional
.B bson_t
[char46] Might be NULL.

Fix some other layout and formatting issues too.
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/be603f929a4a4643a26314b2a07e943597c07c42

Comment by Githook User [ 20/Dec/16 ]

Author:

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

Message: CDRIVER-1926 fix truncated man page lines

Mallard lines like "Optional <code>bson_t</code>. Might be NULL." was
output as:

Optional
.B bson_t
. Might be NULL.

Groff misinterprets, and truncates at the first period. Escape the dot:

Optional
.B bson_t
[char46] Might be NULL.
Branch: master
https://github.com/mongodb/libbson/commit/3544764324e7278efbde7e5513107d855aeeb064

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