Bug 256676 - manpage of poudriere-bulk(8) claims features which aren't available in 3.3.6
Summary: manpage of poudriere-bulk(8) claims features which aren't available in 3.3.6
Status: Closed Works As Intended
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Wolfram Schneider
URL:
Keywords:
Depends on: 254466
Blocks:
  Show dependency treegraph
 
Reported: 2021-06-17 16:40 UTC by Michael Osipov
Modified: 2021-12-25 05:20 UTC (History)
6 users (show)

See Also:
linimon: maintainer-feedback? (bdrewery)


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Michael Osipov 2021-06-17 16:40:59 UTC
This https://www.freebsd.org/cgi/man.cgi?query=poudriere-bulk&apropos=0&sektion=8& manpath=FreeBSD+12.2-RELEASE+and+Ports&arch=default&format=html says that "-O overlays" is supported, but overlays are not in 3.3.6, but only in master of poudriere. See: https://github.com/freebsd/poudriere/blob/32cebc1a2896b314842199e3695b2fac1403c701/src/share/poudriere/bulk.sh#L37-L71
Comment 1 Bryan Drewery freebsd_committer freebsd_triage 2021-06-17 19:44:30 UTC
Why do you think that's a 3.3.6 manpage?

The whole poudriere manpage upload on freebsd.org is wrong and shouldn't be used. I don't know who did it.

The official manpage can be found at https://github.com/freebsd/poudriere/wiki/poudriere.8
Comment 2 Michael Osipov 2021-06-17 19:47:03 UTC
(In reply to Bryan Drewery from comment #1)

manpath says: "FreeBSD+12.2-RELEASE+and+Ports" and ports contains 3.3.6 only.
As you said, something is fishly. It either needs to go or be consistent with the latest port, not master from repo.
Comment 3 Bryan Drewery freebsd_committer freebsd_triage 2021-06-17 19:49:11 UTC
I think assuming "FreeBSD+12.2-RELEASE+and+Ports" means what you think is fair but as far as I know that entire manpage system is manually maintained and shouldn't be trusted to be accurate to expected versions, for Poudriere or anything else.
Comment 4 Michael Osipov 2021-06-17 19:52:33 UTC
(In reply to Bryan Drewery from comment #3)

That's quite a disappointment. If this is truly the case the webmaster should take it down.
Comment 5 Bryan Drewery freebsd_committer freebsd_triage 2021-06-17 20:03:08 UTC
@Wosch please delete the Poudriere manpages. It's giving people the wrong information.
Comment 6 Graham Perrin freebsd_committer freebsd_triage 2021-11-20 05:56:54 UTC
Gentle bump: 

(In reply to Bryan Drewery from comment #5)

> … giving people the wrong information.

+1

<https://forums.freebsd.org/threads/82819/post-542868>, for example. 

----

Also, please, can someone add the customary prefix to this bug? 

ports-mgmt/poudriere
Comment 7 Pau Amma 2021-11-20 06:03:09 UTC
(In reply to Graham Perrin from comment #6)
Isn't that's for ports only? This looks like a doc (or maybe website) bug instead.
Comment 8 Graham Perrin freebsd_committer freebsd_triage 2021-11-20 15:01:00 UTC
(In reply to PauAmma from comment #7)

Good point, thank you. 

(I was disoriented by knowing of this bug, but _not_ finding it by clicking the first of the two bug icons at <https://www.freshports.org/ports-mgmt/poudriere/>. Compare with the summary of 254466, if you like; and I'm in #freebsd-bugs on IRC.)
Comment 9 Wolfram Schneider freebsd_committer freebsd_triage 2021-12-01 16:26:43 UTC
There are two poudriere ports

https://cgit.freebsd.org/ports/tree/ports-mgmt/poudriere
https://cgit.freebsd.org/ports/tree/ports-mgmt/poudriere-devel

pkg search poudriere
poudriere-3.3.7_1              Port build and test system
poudriere-devel-3.3.99.20211017_2 Port build and test system

pkg fetch poudriere-3.3.7_1
tar tfv /var/cache/pkg/poudriere-3.3.7_1.pkg | grep /man/man
-rw-r--r--  0 root   wheel    4635 Nov 21 06:13 /usr/local/man/man8/poudriere.8.gz
-rw-r--r--  0 root   wheel    3165 Nov 21 06:13 /usr/local/man/man8/poudriere-bulk.8.gz
-rw-r--r--  0 root   wheel    1520 Nov 21 06:13 /usr/local/man/man8/poudriere-distclean.8.gz
-rw-r--r--  0 root   wheel    1784 Nov 21 06:13 /usr/local/man/man8/poudriere-image.8.gz
-rw-r--r--  0 root   wheel    4215 Nov 21 06:13 /usr/local/man/man8/poudriere-jail.8.gz
-rw-r--r--  0 root   wheel    1482 Nov 21 06:13 /usr/local/man/man8/poudriere-logclean.8.gz
-rw-r--r--  0 root   wheel    1606 Nov 21 06:13 /usr/local/man/man8/poudriere-options.8.gz
-rw-r--r--  0 root   wheel    1609 Nov 21 06:13 /usr/local/man/man8/poudriere-pkgclean.8.gz
-rw-r--r--  0 root   wheel    2416 Nov 21 06:13 /usr/local/man/man8/poudriere-ports.8.gz
-rw-r--r--  0 root   wheel    1146 Nov 21 06:13 /usr/local/man/man8/poudriere-queue.8.gz
-rw-r--r--  0 root   wheel    1550 Nov 21 06:13 /usr/local/man/man8/poudriere-status.8.gz
-rw-r--r--  0 root   wheel    2366 Nov 21 06:13 /usr/local/man/man8/poudriere-testport.8.gz
-rw-r--r--  0 root   wheel    1071 Nov 21 06:13 /usr/local/man/man8/poudriere-version.8.gz

pkg fetch poudriere-devel-3.3.99.20211017_2
tar tfv /var/cache/pkg/poudriere-devel-3.3.99.20211017_2.pkg | grep /man/man
-rw-r--r--  0 root   wheel    4493 Nov 21 16:47 /usr/local/man/man8/poudriere.8.gz
-rw-r--r--  0 root   wheel    4115 Nov 21 16:47 /usr/local/man/man8/poudriere-bulk.8.gz
-rw-r--r--  0 root   wheel    1535 Nov 21 16:47 /usr/local/man/man8/poudriere-distclean.8.gz
-rw-r--r--  0 root   wheel    2521 Nov 21 16:47 /usr/local/man/man8/poudriere-image.8.gz
-rw-r--r--  0 root   wheel    4176 Nov 21 16:47 /usr/local/man/man8/poudriere-jail.8.gz
-rw-r--r--  0 root   wheel    1497 Nov 21 16:47 /usr/local/man/man8/poudriere-logclean.8.gz
-rw-r--r--  0 root   wheel    1658 Nov 21 16:47 /usr/local/man/man8/poudriere-options.8.gz
-rw-r--r--  0 root   wheel    1694 Nov 21 16:47 /usr/local/man/man8/poudriere-pkgclean.8.gz
-rw-r--r--  0 root   wheel    2400 Nov 21 16:47 /usr/local/man/man8/poudriere-ports.8.gz
-rw-r--r--  0 root   wheel    1133 Nov 21 16:47 /usr/local/man/man8/poudriere-queue.8.gz
-rw-r--r--  0 root   wheel    1543 Nov 21 16:47 /usr/local/man/man8/poudriere-status.8.gz
-rw-r--r--  0 root   wheel    2767 Nov 21 16:47 /usr/local/man/man8/poudriere-testport.8.gz
-rw-r--r--  0 root   wheel    1063 Nov 21 16:47 /usr/local/man/man8/poudriere-version.8.gz

both contain the same manual pages files from nearly the same time 21-Nov-2021 (12.3-STABLE).

In that case, the package poudriere-devel wins because it is alphabetically last. man.freebsd.org will show the manual pages from poudriere-devel and not poudriere.

This is a common problem with the ports and several dozen packages are affected. I don't think there is an easy solution for this. But I also think that it is fine that the higher version number or the devel packages wins. Our users want to use the latest and best version, aren't they?

If you think that  poudriere-devel is stale or outdated, please fix the port.
Comment 10 ari 2021-12-19 01:47:32 UTC
Assuming this is an issue whenever two ports install the same binaries (and manpages to go with them), this is going to be a very common problem. Not just all the -devel ports but also things like mariadb and mysql installing binaries with the same name.

Perhaps the FreeBSD online man pages (which are really useful and well indexed by Google, so are a good advertisement for FreeBSD) could have another URL param allowing you to switch the origin port. There might be a drop down on the top of the page allowing you to switch the origin port just like you can switch section.

Ideally, the non -devel port would be shown by default since that's more likely to represent what the user is looking for.
Comment 11 Pau Amma 2021-12-25 05:20:51 UTC
(In reply to ari from comment #10)

See https://lists.freebsd.org/archives/freebsd-doc/2021-December/000914.html, where I tried to start a discussion about either what you're suggesting or something very close.