Bug 253179
| Summary: | ports(7) man page description of 'packages' target is out of date | ||
|---|---|---|---|
| Product: | Documentation | Reporter: | Robert Watson <rwatson> |
| Component: | Manual Pages | Assignee: | Daniel Ebdrup Jensen <debdrup> |
| Status: | Closed FIXED | ||
| Severity: | Affects Some People | CC: | 0mp, debdrup, doc |
| Priority: | --- | ||
| Version: | Latest | ||
| Hardware: | Any | ||
| OS: | Any | ||
I'll take a look. Thanks for the report. I'm not yet set up to work on the new docs/src trees. Return to the pool for the time being. Yoink. I opened review D28781, mostly because I wanted to ensure I got the phrasing correct. A commit in branch main references this bug: URL: https://cgit.FreeBSD.org/src/commit/?id=248a47a4c2fb229ae815fa61875b3f62a2d6856c commit 248a47a4c2fb229ae815fa61875b3f62a2d6856c Author: Daniel Ebdrup Jensen <debdrup@FreeBSD.org> AuthorDate: 2021-02-18 21:50:54 +0000 Commit: Daniel Ebdrup Jensen <debdrup@FreeBSD.org> CommitDate: 2021-02-19 12:42:16 +0000 ports(7): Update instructions for package target Packages default to ending up in a different location compared to the documentation, so catch up to the implementation by referring to the location where packages can usually be found if no environment variables have been set. While here, also update the mention of the file extension to match the txz format that packages use. PR: 253179, 224370 Reported by: rwatson, jeromer at fastmail dotnet share/man/man7/ports.7 | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) Thank you for your attention to detail. :) |
In attempting to build packages locally, I read the documentation, and was confused by the following pieces of text from ports(7): ... package Make a binary package for the port. The port will be installed if it has not already been. The package is a .tbz file that you can use to install the port on other machines with pkg-add(8). If the directory specified by PACKAGES does not exist, the package will be put into the current directory. See PKGREPOSITORY and PKGFILE. ... PACKAGES Used only for the package target; the base directory for the packages tree, normally packages/ in PORTSDIR. If this directory exists, the package tree will be (partially) constructed. This directory does not have to exist; if it does not, packages will be placed into the current directory, or you can define one of PKGREPOSITORY Directory to put the package in. PKGFILE The full path to the package. ... When I attempted to build a package, I was surprised not to find it in my current working directory (the root of the port), as I hadn't specified PACKAGES on the command line. It turns out that it is not in the current working directory, but in work/pkg relative to the current working directory. This probably needs updating. When I ran find(1) to try and find the package, I was further surprised not to find any, having used the pattern '*.tbz' as suggested by the text "a .tbz file". In fact, ports are now .txz files. This probably needs updating.