Radish alpha
H
HardenedBSD-pkg
rad:z3QDZAW2FAfuLvihrhiyDC9fAD8G9
HardenedBSD Package Manager
Radicle
Git
Commits › 43cfa89
docs/*.3: spelling, grammar and other nits
Ceri Davies committed 4 months ago
commit 43cfa896b6b9837d6b96ae3354f39b35f9753818
parent 14e727b
3 files changed +28 -27
modified docs/pkg_create.3
@@ -1,4 +1,4 @@
- 
.Dd May 3, 2024
+ 
.Dd December 12, 2025

.Dt PKG_CREATE 3

.Os

.Sh NAME
@@ -50,12 +50,12 @@ except if specified otherwise in
.Xr pkg.conf 5 .

It returns

.Va false
- 
if the compression format is unknown and fallback the the default format.
+ 
if the compression format is unknown and will fall back to the default format.

.Pp

.Fn pkg_create_set_compression_level
- 
take a
+ 
takes an

.Ft int
- 
arguments which represents the expect compression level.
+ 
argument which represents the expected compression level.

3 special values are accepted:

.Bl -tag -width indentation

.It Va INT_MIN
@@ -67,18 +67,19 @@ Set the best compression ratio
.El

.Pp

.Fn pkg_create_set_compression_threads
- 
take a
+ 
takes an

.Ft int
- 
arguments which represents the expected numbers of threads used during
+ 
argument which represents the expected number of threads used during

compression.
+ 
.Pp

.Fn pkg_create_set_overwrite
- 
Accept a boolean to define the default behaviour when creating a package and
+ 
Accepts a boolean to define the default behaviour when creating a package if

a local file already exists.

The default behaviour is to overwrite.

.Pp

.Fn pkg_create_set_rootdir
- 
Tells the program where to find the root directory used for packaging (it is
- 
also known as staging area).
+ 
Tells the program where to find the root directory used for packaging (this directory
+ 
is also known as the staging area).

If none is provided pkg will consider

.Sq Va / .

.Pp
@@ -87,7 +88,7 @@ Tells the program where to create the new packages.
By default it will consider the current directory of the running program.

.Pp

.Fn pkg_create_set_timestamp
- 
Define the timestamp to use ad creation and modification time for the files to
+ 
Define the timestamp to use as the creation and modification time for the files to

be packaged.

By default it will use the timestamp of the files on the filesystem.

.Pp
@@ -108,25 +109,25 @@ A textual description (optional)
.It shell scripts (optional):

.Bl -tag -width pkg-post-deinstall

.It +INSTALL
- 
Shell script that will be run during both in post and pre install (DEPRECATED)
+ 
Shell script that will be run during both post and pre install (DEPRECATED)

.It +PRE_INSTALL

Shell script that will be run during pre install phase

.It +POST_INSTALL

Shell script that will be run during post install phase

.It +DEINSTALL
- 
Shell script that will be run during both in post and pre deinstall (DEPRECATED)
+ 
Shell script that will be run during both post and pre deinstall (DEPRECATED)

.It +PRE_DEINSTALL

Shell script that will be run during pre deinstall phase

.It +POST_DEINSTALL

Shell script that will be run during post deinstall phase

.It pkg-install
- 
Shell script that will be run during both in post and pre install (DEPRECATED)
+ 
Shell script that will be run during both post and pre install (DEPRECATED)

.It pkg-pre-install

Shell script that will be run during pre install phase

.It pkg-post-install

Shell script that will be run during post install phase

.It pkg-deinstall
- 
Shell script that will be run during both in post and pre deinstall (DEPRECATED)
+ 
Shell script that will be run during both post and pre deinstall (DEPRECATED)

.It pkg-pre-deinstall

Shell script that will be run during pre deinstall phase

.It pkg-post-deinstall
@@ -152,7 +153,7 @@ If
.Ar hash

is set to

.Va true
- 
then the file name will in the form:
+ 
then the file name will be in the form:

<pkgname>-<pkgversion>-<shorthash>.<extention>

instead of

<pkgname>-<pkgversion>.<extension>.
modified docs/pkg_repo_create.3
@@ -1,4 +1,4 @@
- 
.Dd January 23, 2024
+ 
.Dd December 12, 2025

.Dt PKG_REPO_CREATE 3

.Os

.Sh NAME
@@ -38,7 +38,7 @@ which should be freed by the caller using
.Fn pkg_repo_create_free .

.Pp

.Fn pkg_repo_create_set_output_dir
- 
defined the output directory where to generate the data.
+ 
defines the output directory to save the data in.

By default it will be the

.Va path

provided to the
@@ -46,7 +46,7 @@ provided to the
function.

.Pp

.Fn pkg_repo_create_set_create_filelist
- 
Accept a boolean to define if a the file database should be created
+ 
Accept a boolean to define if the file database should be created

along with the metadata database

.Pq deprecated .

Defaults to
modified docs/pkg_repos.3
@@ -1,4 +1,4 @@
- 
.Dd February 8, 2015
+ 
.Dd December 12, 2025

.Dt PKG_REPOS 3

.Os

.Sh NAME
@@ -46,9 +46,9 @@
.Fn pkg_repos

Takes the address of a pointer to the repository.

The pointer should be initialised to NULL before being passed to the
- 
function, on each iteration the r will point to the new repository.
+ 
function, on each iteration the pointer will point to the new repository.

Returns EPKG_FATAL if an error occurred, otherwise return EPKG_OK until
- 
the last repository is found in that case EPKG_END is returned.
+ 
the last repository is found in which case EPKG_END is returned.

.Pp

.Fn pkg_repos_total_count

returns the total number of defined repositories.
@@ -85,7 +85,7 @@ If the repository is not signed using the
method, NULL will be returned.

.Pp

.Fn pkg_repo_signature_type
- 
Take a pointer to a repository as argument and return the type of
+ 
takes a pointer to a repository as argument and returns the type of

signature it uses.

.Bl -tag -width SIG_FINGERPRINT

.It Cm SIG_NONE
@@ -107,7 +107,7 @@ Otherwise, return
.Fn pkg_repo_priority

takes a pointer to a repository as argument and returns

the priority of the repository as an unsigned integer.
- 
Packages ae chosed preferentially from the repository with the highest
+ 
Packages ae chosen preferentially from the repository with the highest

priority value and which has that package available.

.Pp

.Fn pkg_repo_mirror_type
@@ -115,7 +115,7 @@ takes a pointer to a repository as argument and returns the type of
mirroring it uses.

.Bl -tag -width NOMIRROR

.It Cm SRV
- 
The repository is using SRV record query to get the mirrors.
+ 
The repository is using an SRV record query to get the mirrors.

.It Cm HTTP

The repository is using the HTTP query method to get the mirrors.

.It Cm NOMIRROR
@@ -123,12 +123,12 @@ The repository does not have any mirror.
.El

.Pp

.Fn pkg_repo_find_ident
- 
Take an internal indentification string as argument and return a pointer to
+ 
takes an internal identification string as argument and returns a pointer to

a repository.

If no repository matches, NULL is returned.

.Pp

.Fn pkg_repo_find_name
- 
Take a repository
+ 
takes a repository

.Qq name
- 
as argument and return a pointer to a repository.
+ 
as argument and returns a pointer to a repository.

If no repository matches, NULL is returned.