Bug 254466 - sysutils/beadm manual page in sections 1 and 8
Summary: sysutils/beadm manual page in sections 1 and 8
Status: New
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Many People
Assignee: freebsd-ports-bugs (Nobody)
URL: https://www.freebsd.org/cgi/man.cgi?q...
Keywords:
Depends on:
Blocks:
 
Reported: 2021-03-21 16:25 UTC by Graham Perrin
Modified: 2021-06-30 06:13 UTC (History)
2 users (show)

See Also:
bugzilla: maintainer-feedback? (vermaden)


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Graham Perrin 2021-03-21 16:25:11 UTC
<https://www.freebsd.org/cgi/man.cgi?beadm(1)> works …

<https://www.freebsd.org/cgi/man.cgi?beadm(8)> does not …

man 8 beadm                                    works …

man 1 beadm                                    does not; 

% man 1 beadm
No manual entry for beadm
% pkg info -x beadm
beadm-1.3.2
% freebsd-version -kru
14.0-CURRENT
14.0-CURRENT
14.0-CURRENT
% 

Is this a FreeBSD documentation bug? For the FreeBSD website view of the page. 

From the "(8)" at <https://github.com/vermaden/beadm/commit/7c1b1de2a6af28ae3c8dc230a715a3096ecb64ad#commitcomment-48517471> I assume that (8) is correct.
Comment 1 Graham Perrin 2021-03-21 16:33:48 UTC
Sorry, Bugzilla previews are partially broken (a known issue), I couldn't guess that Bugzilla would mangle my angle bracket-enclosed URLs. 

Instead: 

<https://www.freebsd.org/cgi/man.cgi?query=beadm&sektion=1&manpath=FreeBSD+12.2-RELEASE+and+Ports>

> beadm(1)	

<https://www.freebsd.org/cgi/man.cgi?query=beadm&apropos=0&sektion=8&manpath=FreeBSD+12.2-RELEASE+and+Ports&arch=default&format=html>

> … Sorry, no data found for `beadm(8)'.
Comment 2 vermaden 2021-03-21 19:22:23 UTC
Its my fault (man 1 beadm not being present anymore ...).

When I introduced beadm the man page was written as '1' section (beadm.1) but as we know '1' is section for user utilities and '8' is section for sysadmin utils.

So with some version I 'fixed' that and renamed beadm.1 to beadm.8 along with making all references to beadm(8) now as its purely sysadmin tool ...

Sorry for that.

Regards.
Comment 3 Graham Perrin 2021-03-21 19:44:27 UTC
No need to apologise, I'm quite accustomed to using (1) for the web page, although I sometimes forget which one of the two (beadm and bectl) is misplaced :-)
Comment 4 vermaden 2021-04-25 21:09:42 UTC
Is there something to be add here?
Comment 5 Graham Perrin 2021-06-30 06:06:40 UTC
Consistency. 

man beadm

– finds the page in section 8

<https://www.freebsd.org/cgi/man.cgi>

– finds the page in first section 1. 

Using the pull-down menu to switch to section 8 finds a different version of the page in section 8.