Mantis Bug Tracker

View Issue Details Jump to Notes ] Issue History ] Print ]
IDProjectCategoryView StatusDate SubmittedLast Update
0007281OCamlocamldocpublic2016-06-29 17:462017-07-24 18:13
Reporterolh 
Assigned Tooctachron 
PrioritynormalSeverityminorReproducibilityalways
StatusresolvedResolutionfixed 
PlatformLinuxOSopenSUSEOS VersionTumbleweed
Product Version4.03.0 
Target VersionlaterFixed in Version4.06.0 +dev/beta1/beta2/rc1 
Summary0007281: Incorrect .TH macro in Arg(3o)
DescriptionThe troff .TH macro takes up to three extra args, according to the groff documentation at gnu.org. ocamldoc inserts a fourth argument "source:".

Steps To Reproduce $ man Arg | sed -n '1p;$p' | awk '{print $1,$2,$3}'
Arg(3) OCamldoc Arg(3)
2016-06-16 source: Arg(3)

w3m https://www.gnu.org/software/groff/manual/html_node/Man-usage.html [^]
TagsNo tags attached.
Attached Filespatch file icon ocamldoc-man-th.patch [^] (1,963 bytes) 2017-07-21 20:37 [Show Content]

- Relationships

-  Notes
(0018116)
olh (reporter)
2017-07-21 20:38

ocamldoc-man-th.patch is used in openSUSE since a year. It just removes 'source: '. It is not clear to me what the purpose of this extra string is.
(0018117)
octachron (developer)
2017-07-21 22:21

Thanks for the patch. Looking at the history of ocamldoc, this part of ocamldoc was changed at commit a87c3f20e846c00e53d695497dba7038edbd12f0 in order to make the build of the man page reproducible (following a Debian policy). It seems quite probable that "source:" was supposed to be part of the extra-argument, i.e.
"source:"^ "Odoc_mis.current_date". Is there any argument against this choice of extra-argument?
(0018118)
olh (reporter)
2017-07-21 22:43

Since "Source:" is an extra argument, and thus invalid syntax. The plain date is enough, whatever its exact value is.

With the patch it comes out as:

.TH "Arg" 3 2017-07-17 OCamldoc "OCaml library"
(0018119)
octachron (developer)
2017-07-21 22:50
edited on: 2017-07-21 22:51

According to https://www.gnu.org/software/groff/manual/html_node/Request-and-Macro-Arguments.html, [^] arguments are space separated, therefore
"source:2017-07-17" counts as a single argument. Am I missing something?

(0018120)
olh (reporter)
2017-07-21 23:04

Without the patch it comes out as:

.TH "Arg" 3 source: 2017-07-17 OCamldoc "OCaml library"

No other man page has the "source:" string. What information does it carry anyway?
(0018129)
octachron (developer)
2017-07-23 14:24

You are right that this source prefix is not very informative and does not seem common at all. Would you mind sending your patch as a Github PR at https://github.com/ocaml/ocaml [^] ? Otherwise, I would send a slightly reworked patch myself.
(0018133)
olh (reporter)
2017-07-24 18:12

This was merged via https://github.com/ocaml/ocaml/pull/1259 [^]

- Issue History
Date Modified Username Field Change
2016-06-29 17:46 olh New Issue
2016-09-07 17:03 shinwell Target Version => 4.05.0 +dev/beta1/beta2/beta3/rc1
2017-02-22 15:37 xleroy Status new => acknowledged
2017-02-22 15:37 xleroy Target Version 4.05.0 +dev/beta1/beta2/beta3/rc1 => later
2017-02-23 16:46 doligez Category OCamldoc => ocamldoc
2017-07-21 20:37 olh File Added: ocamldoc-man-th.patch
2017-07-21 20:38 olh Note Added: 0018116
2017-07-21 22:21 octachron Note Added: 0018117
2017-07-21 22:43 olh Note Added: 0018118
2017-07-21 22:50 octachron Note Added: 0018119
2017-07-21 22:51 octachron Note Edited: 0018119 View Revisions
2017-07-21 23:04 olh Note Added: 0018120
2017-07-23 14:24 octachron Note Added: 0018129
2017-07-23 14:24 octachron Assigned To => octachron
2017-07-23 14:24 octachron Status acknowledged => assigned
2017-07-24 18:12 olh Note Added: 0018133
2017-07-24 18:13 octachron Status assigned => resolved
2017-07-24 18:13 octachron Fixed in Version => 4.06.0 +dev/beta1/beta2/rc1
2017-07-24 18:13 octachron Resolution open => fixed


Copyright © 2000 - 2011 MantisBT Group
Powered by Mantis Bugtracker