Bug 85986

Summary: FreeBSD keyword missing if you display security(7) with apropos(1)
Product: Documentation Reporter: Matthias Schmidt <schmidtm>
Component: Books & ArticlesAssignee: Giorgos Keramidas <keramida>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description Matthias Schmidt 2005-09-11 21:20:08 UTC
If you type apropos security to get the security(7) man page the word "FreeBSD" is missing,

matthias@c0re:/ % apropos security
security(7)              - introduction to security under
                                                         ^^^^

How-To-Repeat: Type apropos security
Comment 1 Simon L. B. Nielsen freebsd_committer freebsd_triage 2005-09-11 21:54:09 UTC
On 2005.09.11 20:12:46 +0000, Matthias Schmidt wrote:

> If you type apropos security to get the security(7) man page the word "Fr=
eeBSD" is missing,
>=20
> matthias@c0re:/ % apropos security
> security(7)              - introduction to security under
>                                                          ^^^^

I would say this should be fixed in apropos rather than adding a
workaround to a specific manual page, especially since I would suspect
that other manual pages are also affected.

That said, I have no idea how complicated it would be to fix it in
apropos.

-- 
Simon L. Nielsen
Comment 2 Murray Stokely 2006-01-29 02:41:54 UTC
On Sun, Sep 11, 2005 at 09:00:36PM +0000, Simon L. Nielsen wrote:
>  On 2005.09.11 20:12:46 +0000, Matthias Schmidt wrote:
>  
>  > If you type apropos security to get the security(7) man page the word "Fr=
>  eeBSD" is missing,
>  >=20
>  > matthias@c0re:/ % apropos security
>  > security(7)              - introduction to security under
>  >                                                          ^^^^
>  
>  I would say this should be fixed in apropos rather than adding a
>  workaround to a specific manual page, especially since I would suspect
>  that other manual pages are also affected.
>  
>  That said, I have no idea how complicated it would be to fix it in
>  apropos.

I think we should just submit the patch as is rather than fixing
makewhatis(1).  tuning(7) written by the same author just uses
'FreeBSD' instead of .Fx and therefore shows up properly.

I could not find any other examples of man pages that have this
problem, leading me to conclude that hacking up makewhatis would be
overengineering the solution.

     - Murray
Comment 3 Giorgos Keramidas freebsd_committer freebsd_triage 2006-05-10 20:58:40 UTC
> --- /usr/src/share/man/man7/security.7  Sun Jul 24 12:42:21 2005
> +++ security.7  Sun Sep 11 22:05:38 2005
> @@ -28,8 +28,7 @@
>  .Os
>  .Sh NAME
>  .Nm security
> -.Nd introduction to security under
> -.Fx
> +.Nd introduction to security under FreeBSD

> From: Murray Stokely <murray@freebsdmall.com>
> To: "Simon L. Nielsen" <simon@FreeBSD.org>
> Cc: freebsd-doc@FreeBSD.org, bug-followup@freebsd.org
> Subject: docs/85986: Re: docs/85986: FreeBSD keyword missing if you display security(7) with apropos
> Date: Sat, 28 Jan 2006 18:41:54 -0800
>
> I think we should just submit the patch as is rather than fixing
> makewhatis(1).  tuning(7) written by the same author just uses
> 'FreeBSD' instead of .Fx and therefore shows up properly.
>
> I could not find any other examples of man pages that have this
> problem, leading me to conclude that hacking up makewhatis would be
> overengineering the solution.

Yes, please.  I'd prefer just submitting the patch too.

If there's no objection to committing it and nobody else beats me to it,
I'd like to commit it in a couple of days...
Comment 4 Giorgos Keramidas freebsd_committer freebsd_triage 2006-05-12 18:43:20 UTC
State Changed
From-To: open->patched

Fixed in HEAD.  Thanks :-) 


Comment 5 Giorgos Keramidas freebsd_committer freebsd_triage 2006-05-12 18:43:20 UTC
Responsible Changed
From-To: freebsd-doc->keramida

I'll handle the MFC for this.
Comment 6 Giorgos Keramidas freebsd_committer freebsd_triage 2006-07-12 12:39:52 UTC
State Changed
From-To: patched->closed

No MFC needed.  This page has no RELENG_6 vs. HEAD diff