Radish alpha
H
rad:z3QDZAW2FAfuLvihrhiyDC9fAD8G9
HardenedBSD Package Manager
Radicle
Git
docs/*.5: spelling, grammar and other nits
Ceri Davies committed 4 months ago
commit 14e727b69b9e2c277e5bf70ce1105b2252a38e89
parent 80b3e5c
6 files changed +35 -35
modified docs/pkg-keywords.5
@@ -11,7 +11,7 @@
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
-
.Dd January 29, 2020
+
.Dd December 12, 2025
.Dt PKG-KEYWORDS 5
.Os
.Sh NAME
@@ -33,7 +33,7 @@ Those files are in UCL format.
The format is the following:
.Bl -tag -width Ds
.It Cm actions
-
Array of actions which defines what do to the argument(s) of the keywords.
+
Array of actions which defines how to treat the argument(s) of the keywords.
Valid actions are:
.Bl -tag -width Ds
.It Va dir
@@ -56,7 +56,7 @@ New variables will be available to scripts: \%%<number>.
.El
.It Cm attributes
attributes that can be set to a file or a directory depending if actions has been set.
-
It will take the precedence over the attributes that may have been set when calling the keyword.
+
It will take precedence over the attributes that may have been set when calling the keyword.
Attributes can be:
.Bl -tag -width Ds
.It Cm owner Ar string
@@ -64,49 +64,49 @@ Name of the owner of the file or directory.
.It Cm group Ar string
Name of the group of the file or directory.
.It Cm mode Ar string
-
mode of the file or directory, this mode can be in numeric or string form.
+
mode of the file or directory, this mode can be in octal or string form.
.El
.It Cm deprecated
Boolean to mark a keyword as deprecated
.It Cm deprecation_message
Message to be show if the keyword is used and mark as deprecated
.It Cm preformat_arguments
-
Boolean to activate the preformating the arguemnts of the keywords repescting the escape sequences descibred below.
+
Boolean to activate preformatting the arguments of the keywords, respecting the escape sequences described below.
.It Cm prepackaging
lua script which is executed at the packaging time.
Useful to add some input validation.
.It Cm pre-install
shell script to be run during the pre-install phase.
It will be merged with any existing pre-install scripts.
-
The script will be formatted respecting the escape sequences define later.
+
The script will be formatted respecting the escape sequences described below.
.It Cm post-install
shell script to be run during the post-install phase.
It will be merged with any existing post-install scripts.
-
The script will be formatted respecting the escape sequences define later.
+
The script will be formatted respecting the escape sequences described below.
.It Cm pre-deinstall
shell script to be run during the pre-deinstall phase.
It will be merged with any existing pre-deinstall scripts.
-
The script will be formatted respecting the escape sequences define later.
+
The script will be formatted respecting the escape sequences described below.
.It Cm post-deinstall
shell script to be run during the post-deinstall phase.
It will be merged with any existing post-deinstall scripts.
-
The script will be formatted respecting the escape sequences define later.
+
The script will be formatted respecting the escape sequences described below.
.It Cm pre-install-lua
Lua script to be run during the pre-install phase.
-
It will be appended with any existing array of lua pre-install scripts
-
The script will be formatted respecting the escape sequences define later.
+
It will be appended with any existing array of lua pre-install scripts.
+
The script will be formatted respecting the escape sequences described below.
.It Cm post-install-lua
Lua script to be run during the post-install phase.
-
It will be appended with any existing array of lua post-install scripts
-
The script will be formatted respecting the escape sequences define later.
+
It will be appended with any existing array of lua post-install scripts.
+
The script will be formatted respecting the escape sequences described below.
.It Cm pre-deinstall-lua
Lua script to be run during the pre-deinstall phase.
-
It will be appended with any existing array of lua pre-deinstall scripts
-
The script will be formatted respecting the escape sequences define later.
+
It will be appended with any existing array of lua pre-deinstall scripts.
+
The script will be formatted respecting the escape sequences described below.
.It Cm post-deinstall-lua
Lua script to be run during the post-deinstall phase.
-
It will be appended with any existing array of lua post-deinstall scripts
-
The script will be formatted respecting the escape sequences define later.
+
It will be appended with any existing array of lua post-deinstall scripts.
+
The script will be formatted respecting the escape sequences described below.
.It Cm messages
Array of test messages that can be passed to the users.
Valid information by entry in the array are:
@@ -114,8 +114,8 @@ Valid information by entry in the array are:
.It Cm message Ar string
actual message to be shown to the users.
.It Cm type Op Ar upgrade | Ar remove | Ar install
-
defines in which contect the message should be shown to the users.
-
If not set, the message will always be printed
+
defines in which context the message should be shown to the users.
+
If not set, the message will always be printed.
.El
.El
.Sh ESCAPE SEQUENCE
modified docs/pkg-lua-script.5
@@ -11,7 +11,7 @@
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
-
.Dd October 28, 2025
+
.Dd December 12, 2025
.Dt PKG-LUA-SCRIPT 5
.Os
.Sh NAME
@@ -51,7 +51,7 @@ new post-install
.Pp
Lua scripts are always run after shell scripts (of the same phase).
.Sh API
-
All the regular lua API are available to the exception of the following changes:
+
All the regular lua APIs are available with the exception of the following changes:
.Bl -tag -width Ds
.It Fn io.open
has been modified to only open files relatively to the rootdir if specified by
@@ -158,7 +158,7 @@ expected in the following form:
Will return an
.Va ipair
with the list of elements contained in the directory
-
the specicial directory
+
the special directory
.Va So .
.Sc
and
modified docs/pkg-repository.5
@@ -15,7 +15,7 @@
.\"     @(#)pkg-repository.5
.\" $FreeBSD$
.\"
-
.Dd February 1, 2015
+
.Dd December 12, 2025
.Dt PKG-REPOSITORY 5
.Os
.Sh NAME
@@ -35,7 +35,7 @@ Each collection consists of packages suitable for installation on a
specific system
.Sy ABI :
a combination of operating system, CPU architecture, OS version, word
-
size, and for certain processors endianness or similar attributes.
+
size and, for certain processors, endianness or similar attributes.
.Pp
The package collections are typically made available to users for
download via a web or FTP server although various other means of access
modified docs/pkg-script.5
@@ -11,7 +11,7 @@
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
-
.Dd July 24, 2025
+
.Dd December 12, 2025
.Dt PKG-SCRIPT 5
.Os
.Sh NAME
@@ -20,7 +20,7 @@
.Xr pkg 8
.Sh DESCRIPTION
.Xr pkg 8
-
run scripts at given phases of the process it is running
+
may run scripts at given phases of the process it is executing.
.Pp
The phases are the following:
.Bl -tag -width Ds
@@ -46,7 +46,7 @@ replace binaries
new post-install
.El
.Sh Environment
-
The following environment variable are exported to be used by the script
+
The following environment variables are exported to be used by the script.
.Bl -tag -width Ds
.It Ev PKG_NAME
Represents the name of the package.
@@ -71,7 +71,7 @@ that will be shown at the end of the
.Xr pkg 8
process.
.It Ev PKG_UPGRADE
-
Variable existing when the scripts is run in the context of an upgrade of the package
+
This variable is set when a script is run in the context of an upgrade of a package.
.El
.Sh SEE ALSO
.Xr pkg_create 3 ,
modified docs/pkg-triggers.5
@@ -8,7 +8,7 @@
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
-
.Dd October 30, 2025
+
.Dd December 12, 2025
.Dt PKG-TRIGGERS 5
.Os
.Sh NAME
@@ -51,7 +51,7 @@ Each time a package installs a file or directory whose name matches one of the
regular expressions, the trigger will be executed at the end of the
transaction.
.It Cm cleanup
-
An object which represent the script to execute in case the transaction results
+
An object which represents the script to execute in case the transaction results
in removal of the trigger from the installation.
The object requires the following fields:
.Bl -tag -width xxxxxx
modified docs/pkg.conf.5
@@ -27,7 +27,7 @@
.\"
.\"     @(#)pkg.1
.\"
-
.Dd September 17, 2025
+
.Dd December 12, 2025
.Dt PKG.CONF 5
.Os
.Sh NAME
@@ -95,8 +95,8 @@ command line when substituted in and followed by any remaining tokens from
the original command line.
Default: not set.
.It Cm ARCHIVE_SYMLINK: boolean
-
When creating a package, create a symlink to it using the legacy extension,
-
this is a backward compatibility option, default: true
+
When creating a package, create a symlink to it using the legacy extension.
+
This is a backward compatibility option, default: true
.It Cm AUTOCLEAN: boolean
Automatically cleanout the content of
.Em PKG_CACHEDIR
@@ -114,7 +114,7 @@ Default: NO.
When this option is enabled
.Xr pkg 1
will automatically assume "yes" to all questions
-
which require user confirmation before doing anything, as if it
+
which require user confirmation before doing anything, as if
the
.Fl y
flag was specified.
@@ -249,7 +249,7 @@ addresses by the default mechanisms configured on the system.
See
.Xr getaddrinfo 3 .
.It Cm OSVERSION: integer
-
Specifiy the exact
+
Specify the exact
.Fx
version for the target ABI. This should be set in combination with the ABI option.
The format is the same as the format of