Bug 162 - Some man pages have an incorrect syntax
Some man pages have an incorrect syntax
Status: RESOLVED FIXED
Product: NSD
Classification: Unclassified
Component: Documentation
3.0.x
All Linux
: P2 normal
Assigned To: NSD team
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2007-11-04 16:16 CET by Simon Vallet
Modified: 2007-11-13 09:52 CET (History)
1 user (show)

See Also:


Attachments
Patch against 3.0.6 (27.84 KB, patch)
2007-11-04 16:16 CET, Simon Vallet
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Simon Vallet 2007-11-04 16:16:15 CET
Created attachment 58 [details]
Patch against 3.0.6

Hi,

the man pages for several utilities in NSD 3.0.6 break man on Linux. The attached patch fixes the syntax, and includes some minor corrections.

Fixes include:
* replace empty lines by comments where necessary
* switching to 'mdoc' syntax for the man pages which weren't

Simon
Comment 1 Matthijs Mekking 2007-11-13 09:50:40 CET
Reviewed the patch and modified most changes. However did not change the following:
* BIND8-statistics > BIND-statistics. The man specifically means BIND8 stats, since BIND9 stats are different in style
* No escapes for the '-' character, since in the patch this was changed inconsistently, and not escaping the '-' character does not produce warnings. 

Furthermore, made the OPTIONS section consistent with the other man pages, that is, modified 'The available options are' into '.Sh OPTIONS'. 
Comment 2 Matthijs Mekking 2007-11-13 09:52:22 CET
Reviewed the patch and modified most changes. However did not change the following:
* BIND8-statistics > BIND-statistics. The man specifically means BIND8 stats, since BIND9 stats are different in style
* No escapes for the '-' character, since in the patch this was changed inconsistently, and not escaping the '-' character does not produce warnings. 

Furthermore, made the OPTIONS section consistent with the other man pages, that is, modified 'The available options are' into '.Sh OPTIONS'. 

This change will be visible in version 3.0.7.