Bug 230573 - [PATCH] heimdal: krb5.3 fills apropos with junk
Summary: [PATCH] heimdal: krb5.3 fills apropos with junk
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: Cy Schubert
URL:
Keywords: patch
Depends on:
Blocks:
 
Reported: 2018-08-12 22:55 UTC by Yuri Pankov
Modified: 2018-09-05 01:36 UTC (History)
4 users (show)

See Also:


Attachments
fix NAME section in krb5.3 (549 bytes, patch)
2018-08-12 22:55 UTC, Yuri Pankov
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Yuri Pankov 2018-08-12 22:55:06 UTC
Created attachment 196138 [details]
fix NAME section in krb5.3

I have tried doing `apropos thread` and in addition to correct results, got a lot of noise from krb5.3.  I understand that it looks to be doxygen output, but still it seems to be untouched for a long time, and the attached patch should amend the issue.
Comment 1 Cy Schubert freebsd_committer freebsd_triage 2018-08-13 01:18:50 UTC
Looks reasonable.
Comment 2 Benjamin Kaduk freebsd_committer freebsd_triage 2018-08-15 03:03:01 UTC
Fundamentally it's "not quite right" to use the library name as the NAME for the man page (as opposed to using function names) in section 3, but it's probably an okay tradeoff here.  Note that kld.3 in base does something of a similar nature with respect to the .Dt, but NAME is reserved for actual function names.
So I'm not sure that this is the best option.  On the other hand, there's no need to let the perfect be the enemy of the good.
Comment 3 Cy Schubert freebsd_committer freebsd_triage 2018-08-29 02:30:15 UTC
The patch is similar to ports/security/heimdal's distributed krb5.3.
Comment 4 commit-hook freebsd_committer freebsd_triage 2018-08-29 06:05:32 UTC
A commit references this bug:

Author: cy
Date: Wed Aug 29 06:04:54 UTC 2018
New revision: 338367
URL: https://svnweb.freebsd.org/changeset/base/338367

Log:
  Avoid printing extraneous function names when searching man page
  database (apropos, man -k). This commit Replaces .SS with .SH,
  similar to the man page provided by original heimdal (as in port).

  PR:		230573
  Submitted by:	yuripv@yuripv.net
  Approved by:	re (rgrimes@)
  MFC after:	3 days

Changes:
  head/crypto/heimdal/doc/doxyout/krb5/man/man3/krb5.3
Comment 5 commit-hook freebsd_committer freebsd_triage 2018-09-05 01:34:15 UTC
A commit references this bug:

Author: cy
Date: Wed Sep  5 01:33:31 UTC 2018
New revision: 338464
URL: https://svnweb.freebsd.org/changeset/base/338464

Log:
  Avoid printing extraneous function names when searching man page
  database (apropos, man -k). This commit Replaces .SS with .SH,
  similar to the man page provided by original heimdal (as in port).

  PR:		230573
  Submitted by:	yuripv@yuripv.net

Changes:
_U  stable/10/
  stable/10/crypto/heimdal/doc/doxyout/krb5/man/man3/krb5.3
_U  stable/11/
  stable/11/crypto/heimdal/doc/doxyout/krb5/man/man3/krb5.3
Comment 6 Cy Schubert freebsd_committer freebsd_triage 2018-09-05 01:36:46 UTC
Fixed.