Bug 216755 - syslog(3): string in example code in BUGS section renders without quotes
Summary: syslog(3): string in example code in BUGS section renders without quotes
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Many People
Assignee: Oleksandr Tymoshenko
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2017-02-03 14:50 UTC by Thomas Cort
Modified: 2018-07-16 01:08 UTC (History)
2 users (show)

See Also:


Attachments
screenshot (36.48 KB, image/png)
2017-02-03 14:50 UTC, Thomas Cort
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Thomas Cort 2017-02-03 14:50:55 UTC
Created attachment 179566 [details]
screenshot

The last line is `.Dl syslog(priority, "%s", string);` when viewed with `man` or on the web ( https://www.freebsd.org/cgi/man.cgi?query=syslog&sektion=3 ), the double quotes don't show up.

Using the same code as the other examples in the file seems to make it work...

.Bd -literal -offset indent -compact
syslog(priority, "%s", string);
.Ed

This is present in the latest base HEAD r313159
Comment 1 commit-hook freebsd_committer freebsd_triage 2018-04-12 17:05:41 UTC
A commit references this bug:

Author: gonzo
Date: Thu Apr 12 17:05:28 UTC 2018
New revision: 332439
URL: https://svnweb.freebsd.org/changeset/base/332439

Log:
  Fix quotes in the example code in syslog(3) BUGS section

  mdoc treats verbatim quotes in .Dl as a string delimiter and does
  not pass them to the rendered output. Use special char \*q to specify
  double quote

  PR:		216755
  MFC after:	3 days

Changes:
  head/lib/libc/gen/syslog.3
Comment 2 commit-hook freebsd_committer freebsd_triage 2018-05-14 23:12:45 UTC
A commit references this bug:

Author: gonzo
Date: Mon May 14 23:12:30 UTC 2018
New revision: 333616
URL: https://svnweb.freebsd.org/changeset/base/333616

Log:
  MFC r332317, r332439, r332442

  Approved by:	re

  r332317:
  [man] Fix return type of BUS_ADD_CHILD(9)

  Fix return type of BUS_ADD_CHILD(9) in SYNOPSYS section,
  it should be device_t, not int

  PR:		207389

  r332439:
  Fix quotes in the example code in syslog(3) BUGS section

  mdoc treats verbatim quotes in .Dl as a string delimiter and does
  not pass them to the rendered output. Use special char \*q to specify
  double quote

  PR:		216755

  r332442:
  Bump .Dd value (forgot to do this in r332439)

Changes:
_U  stable/11/
  stable/11/lib/libc/gen/syslog.3
  stable/11/share/man/man9/BUS_ADD_CHILD.9