jmq/Documentation
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

pkgmeek.8: update the section on deprecated options

Browse Source
This commit is contained in:
John McQuah 2023-02-17 11:51:14 -05:00
parent e55a7a43cd
commit f2ccd4184a
1 changed files with 24 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
man8/pkgmeek.8
View File

@ -27,10 +27,6 @@ Install package using pkgadd(8) after successful build.
.B "\-u, \-\-upgrade"
Install package as an upgrade using pkgadd(8) after successful build.
.TP
.B "\-r, \-\-recursive"
Search for Pkgfiles in all subdirectories under the current working directory,
and perform the requested action (download, extract, ...) in each subdirectory found.
.TP
.B "\-do, \-\-download\-only"
Do not build, stop after obtaining all the source file(s).
.TP
@ -74,9 +70,6 @@ Do not strip executable binaries or libraries.
.B "\-f, \-\-force"
Build package even if it appears to be up to date.
.TP
.B "\-c, \-\-clean"
Remove the (previously built) package and the downloaded source files.
.TP
.B "\-kw, \-\-keep-work"
Keep temporary working directory.
.TP
@ -90,6 +83,23 @@ Print version and exit.
Print help and exit.
.SH DEPRECATED OPTIONS
.TP
.B "\-c, \-\-clean"
Using \fBprtwash(1)\fP to remove the built package and downloaded
source files gives you the flexibility to specify exactly what you want
deleted. There is no longer a need to have this functionality included
in \fBpkgmeek\fP.
.TP
.B "\-r, \-\-recursive"
If you want to traverse the working directory for all valid port dirs
(containing a \fBPkgfile(5)\fP, .signature, and .footprint) and run
\fBpkgmeek\fP in each directory found, you should write a wrapper
script instead. Putting that functionality inside \fBpkgmeek\fP itself
requires either hard-coding a specific set of flags passed to the
\fBfind(1)\fP command (such as whether to follow symlinks), or asking
the user to supply the flags. Each of these design decisions would
fit poorly in some use cases, so recursive invocations are now the
user's responsibility.
.TP
.B "\-cm, \-\-check-md5sum, \-im, \-\-ignore-md5sum, \-um, \-\-update-md5sum"
The code to generate a listing of md5 hashes for the source files has been removed
from \fBpkgmeek\fP. Verifying the integrity of source files should be handled
@ -147,9 +157,12 @@ An error occured while verifying the signature.
.SH PROGRAM DESIGN
\fBpkgmeek\fP aims to provide the same feature set as the original
\fBpkgmk\fP by Per Liden, but in a more compact code base to allow for
extensibility and easier auditing. Its core function of building a package
\fBpkgmeek\fP aims to provide all the essential features of the
official \fBpkgmk\fP, but in a more compact code base to allow for
extensibility and easier auditing. A few less-frequently-used features
have been omitted from \fBpkgmeek\fP, as explained in
.B DEPRECATED OPTIONS
above. Its core function of building a package
is based on \fBupkgmk\fP, a 100-line bash script written by Fun. Upon this
foundation, new code in the same pithy style was added. Reviewers of the
\fBpkgmeek\fP script should be able to discern a linear narrative leading to
@ -163,7 +176,7 @@ One new feature that sets \fBpkgmeek\fP apart from \fBpkgmk\fP is its native
support for git sources. If the prefix \fI__git__\fP appears among any of
the entries in the source array, then \fBpkgmeek\fP will strip off this
prefix and interpret the rest of the entry as the URL of a git project.
The port maintainer can also specify a branch or a tag other than "master",
The port maintainer can also specify a branch or a tag other than "main",
by appending the tag to the base URL, with the hash symbol (#) as
separator. The downloaded git project will be saved under the directory
specified by PKGMK_SOURCE_DIR, using either the project name (the default)