git: f3d9d3255f - main - documentation/content: Replace Poudriere with poudriere
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Sun, 16 Jul 2023 20:12:19 UTC
The branch main has been updated by bofh:
URL: https://cgit.FreeBSD.org/doc/commit/?id=f3d9d3255fa60edfdc2a5c879360465ef7cf515c
commit f3d9d3255fa60edfdc2a5c879360465ef7cf515c
Author: Muhammad Moinur Rahman <bofh@FreeBSD.org>
AuthorDate: 2023-07-16 20:10:22 +0000
Commit: Muhammad Moinur Rahman <bofh@FreeBSD.org>
CommitDate: 2023-07-16 20:10:22 +0000
documentation/content: Replace Poudriere with poudriere
- poudriere authors bapt and bdrewary prefers to write it as poudriere
instead of Poudriere. Update all the documentation to reflect the same.
- While I am here fix EOL and trailing spaces.
---
.../en/articles/committers-guide/_index.adoc | 4 ++--
.../content/en/books/handbook/ports/_index.adoc | 14 +++++++-------
.../porters-handbook/quick-porting/_index.adoc | 2 +-
.../en/books/porters-handbook/special/_index.adoc | 22 +++++++++++-----------
.../en/books/porters-handbook/testing/_index.adoc | 2 +-
5 files changed, 22 insertions(+), 22 deletions(-)
diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc
index 898fa7e307..04fbc8c6cc 100644
--- a/documentation/content/en/articles/committers-guide/_index.adoc
+++ b/documentation/content/en/articles/committers-guide/_index.adoc
@@ -3400,7 +3400,7 @@ Don't forget to <<port-commit-message-formats,setup git hooks for the ports tree
Check the port, preferably to make sure it compiles and packages correctly.
The extref:{porters-handbook}testing[Porters Handbook's Testing Chapter] contains more detailed instructions.
-See the extref:{porters-handbook}testing[Portclippy / Portfmt, testing-portclippy] and the extref:{porters-handbook}testing[Poudriere, testing-poudriere] sections.
+See the extref:{porters-handbook}testing[Portclippy / Portfmt, testing-portclippy] and the extref:{porters-handbook}testing[poudriere, testing-poudriere] sections.
You do not necessarily have to eliminate all warnings but make sure you have fixed the simple ones.
@@ -3411,7 +3411,7 @@ To close a PR, change the state to `Issue Resolved` and the resolution as `Fixed
[NOTE]
====
-If for some reason using extref:{porters-handbook}testing[Poudriere, testing-poudriere] to test the new port is not possible, the bare minimum of testing includes this sequence:
+If for some reason using extref:{porters-handbook}testing[poudriere, testing-poudriere] to test the new port is not possible, the bare minimum of testing includes this sequence:
[source,shell]
....
diff --git a/documentation/content/en/books/handbook/ports/_index.adoc b/documentation/content/en/books/handbook/ports/_index.adoc
index 001dc7a831..f8916d98c6 100644
--- a/documentation/content/en/books/handbook/ports/_index.adoc
+++ b/documentation/content/en/books/handbook/ports/_index.adoc
@@ -436,7 +436,7 @@ The output should be similar to the following:
[.programlisting]
....
-Fetching vuln.xml.xz: 100% 976 KiB 499.5kB/s 00:02
+Fetching vuln.xml.xz: 100% 976 KiB 499.5kB/s 00:02
chromium-108.0.5359.98 is vulnerable:
chromium -- multiple vulnerabilities
CVE: CVE-2022-4440
@@ -503,7 +503,7 @@ Number of packages to be removed: 1
The operation will free 723 KiB.
-Proceed with deinstalling packages? [y/N]:
+Proceed with deinstalling packages? [y/N]:
....
Packages installed as dependencies are called _automatic_ packages.
@@ -1133,15 +1133,15 @@ By default, this command is interactive and prompts the user to confirm if a dis
In addition to these commands, package:ports-mgmt/pkg_cutleaves[] automates the task of removing installed ports that are no longer needed.
[[ports-poudriere]]
-== Building Packages with Poudriere
+== Building Packages with poudriere
-Poudriere is a `BSD`-licensed utility for creating and testing FreeBSD packages.
+poudriere is a `BSD`-licensed utility for creating and testing FreeBSD packages.
It uses FreeBSD jails to set up isolated compilation environments.
These jails can be used to build packages for versions of FreeBSD that are different from the system on which it is installed, and also to build packages for i386 if the host is an amd64 system.
Once the packages are built, they are in a layout identical to the official mirrors.
These packages are usable by man:pkg[8] and other package management tools.
-Poudriere is installed using the package:ports-mgmt/poudriere[] package or port.
+poudriere is installed using the package:ports-mgmt/poudriere[] package or port.
The installation includes a sample configuration file `/usr/local/etc/poudriere.conf.sample`.
Copy this file to `/usr/local/etc/poudriere.conf`.
Edit the copied file to suit the local configuration.
@@ -1252,13 +1252,13 @@ Finally, packages are built and a package repository is created:
....
While running, pressing kbd:[Ctrl+t] displays the current state of the build.
-Poudriere also builds files in `/poudriere/logs/bulk/jailname` that can be used with a web server to display build information.
+poudriere also builds files in `/poudriere/logs/bulk/jailname` that can be used with a web server to display build information.
After completion, the new packages are now available for installation from the poudriere repository.
For more information on using poudriere, see man:poudriere[8] and the main web site, https://github.com/freebsd/poudriere/wiki[].
-=== Configuring pkg Clients to Use a Poudriere Repository
+=== Configuring pkg Clients to Use a poudriere Repository
While it is possible to use both a custom repository along side of the official repository, sometimes it is useful to disable the official repository.
This is done by creating a configuration file that overrides and disables the official configuration file.
diff --git a/documentation/content/en/books/porters-handbook/quick-porting/_index.adoc b/documentation/content/en/books/porters-handbook/quick-porting/_index.adoc
index 16f803a34c..32e42b0228 100644
--- a/documentation/content/en/books/porters-handbook/quick-porting/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/quick-porting/_index.adoc
@@ -227,7 +227,7 @@ These are the important points to verify:
Make certain no warnings are shown in any of the stages.
-Thorough automated testing can be done with package:ports-mgmt/poudriere[] from the Ports Collection, see crossref:testing[testing-poudriere,Poudriere] for more information.
+Thorough automated testing can be done with package:ports-mgmt/poudriere[] from the Ports Collection, see crossref:testing[testing-poudriere,poudriere] for more information.
It maintains `jails` where all of the steps shown above can be tested without affecting the state of the host system.
[[porting-portlint]]
diff --git a/documentation/content/en/books/porters-handbook/special/_index.adoc b/documentation/content/en/books/porters-handbook/special/_index.adoc
index db9cbf3d32..32123e82a9 100644
--- a/documentation/content/en/books/porters-handbook/special/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/special/_index.adoc
@@ -695,7 +695,7 @@ rust/crates/atty-0.2.9.tar.gz 100% of 5898 B 81 MBps 00m00s
The port is now ready for a test build and further adjustments like creating a plist, writing a description, adding license information, options, etc. as normal.
-If you are not testing your port in a clean environment like with Poudriere, remember to run `make clean` before any testing.
+If you are not testing your port in a clean environment like with poudriere, remember to run `make clean` before any testing.
====
[[cargo-ex2]]
@@ -938,7 +938,7 @@ daviddengcn-go-colortext-186a3d44e920_GH0.tar. 4534 B 1098 kBps 00s
The port is now ready for a test build and further adjustments like creating a plist, writing a description, adding license information, options, etc. as normal.
-If you are not testing your port in a clean environment like with Poudriere, remember to run `make clean` before any testing.
+If you are not testing your port in a clean environment like with poudriere, remember to run `make clean` before any testing.
====
[[go-ex2]]
@@ -1050,7 +1050,7 @@ QuickCheck-2.12.6.1/QuickCheck-2.12.6.1.tar.gz 65 kB 361 kBps 00s
The port is now ready for a test build and further adjustments like creating a plist, writing a description, adding license information, options, etc. as normal.
-If you are not testing your port in a clean environment like with Poudriere, remember to run `make clean` before any testing.
+If you are not testing your port in a clean environment like with poudriere, remember to run `make clean` before any testing.
====
Some Haskell ports install various data files under `share/${PORTNAME}`. For such cases special handling is required on the port side.
@@ -1087,7 +1087,7 @@ It installs HTML templates under `share/profiteur`, so we need to add `CABAL_WRA
USE_CABAL= OneTuple-0.3.1_2 \
QuickCheck-2.14.2 \
[...]
-
+
CABAL_WRAPPER_SCRIPTS= ${CABAL_EXECUTABLES}
@@ -1159,7 +1159,7 @@ It might be useful to separate the `GH_TUPLE` items coming from `make-use-cabal`
GH_TUPLE= input-output-hk:cardano-base:0f3a867493059e650cda69e20a5cbf1ace289a57:cardano_base/dist-newstyle/src/cardano-b_-c8db9876882556ed \
input-output-hk:cardano-crypto:f73079303f663e028288f9f4a9e08bcca39a923e:cardano_crypto/dist-newstyle/src/cardano-c_-253fd88117badd8f \
[...]
-
+
GH_TUPLE+= bitcoin-core:secp256k1:ac83be33d0956faf6b7f61a60ab524ef7d6a473a:secp
....
@@ -4069,11 +4069,11 @@ the Lua API changes to some extent in every version, and configuration tools lik
Software that uses Lua may have been written to auto-detect the Lua version in use.
In general ports should override this assumption, and force the use of the specific Lua version selected as described above.
-Depending on the software being ported, this might require any or all of:
+Depending on the software being ported, this might require any or all of:
-* Using `LUA_VER` as part of a parameter to the software's configuration script via `CONFIGURE_ARGS` or `CONFIGURE_ENV` (or equivalent for other build systems);
-* Adding `-I${LUA_INCDIR}`, `-L${LUA_LIBDIR}`, and `-llua-${LUA_VER}` to `CFLAGS`, `LDFLAGS`, `LIBS` respectively as appropriate;
-* Patch the software's configuration or build files to select the correct version.
+* Using `LUA_VER` as part of a parameter to the software's configuration script via `CONFIGURE_ARGS` or `CONFIGURE_ENV` (or equivalent for other build systems);
+* Adding `-I${LUA_INCDIR}`, `-L${LUA_LIBDIR}`, and `-llua-${LUA_VER}` to `CFLAGS`, `LDFLAGS`, `LIBS` respectively as appropriate;
+* Patch the software's configuration or build files to select the correct version.
[[lua-version-flavors]]
@@ -4107,10 +4107,10 @@ USES= lua:flavors
....
This operates the same way as the `module` parameter described above, but without the assumption that the package should be documented as a Lua module (so `LUA_DOCSDIR` and `LUA_EXAMPLESDIR` are not defined by default).
-However, the port may choose to define `LUA_DOCSUBDIR` as a suitable subdirectory name (usually the port's `PORTNAME` as long as this does not conflict with the `PORTNAME` of any module), in which case the framework will define both `LUA_DOCSDIR` and `LUA_EXAMPLESDIR`.
+However, the port may choose to define `LUA_DOCSUBDIR` as a suitable subdirectory name (usually the port's `PORTNAME` as long as this does not conflict with the `PORTNAME` of any module), in which case the framework will define both `LUA_DOCSDIR` and `LUA_EXAMPLESDIR`.
As with module ports, a flavored port should avoid installing files that would conflict between versions.
-Typically this is done by adding `LUA_VER_STR` as a suffix to program names (e.g. using crossref:uses[uses-uniquefiles,`uniquefiles`]), and otherwise using either `LUA_VER` or `LUA_VER_STR` as part of any other files or subdirectories used outside of `LUA_MODLIBDIR` and `LUA_MODSHAREDIR`.
+Typically this is done by adding `LUA_VER_STR` as a suffix to program names (e.g. using crossref:uses[uses-uniquefiles,`uniquefiles`]), and otherwise using either `LUA_VER` or `LUA_VER_STR` as part of any other files or subdirectories used outside of `LUA_MODLIBDIR` and `LUA_MODSHAREDIR`.
[[lua-defined-variables]]
=== Defined Variables
diff --git a/documentation/content/en/books/porters-handbook/testing/_index.adoc b/documentation/content/en/books/porters-handbook/testing/_index.adoc
index c317d99221..e0c92f0852 100644
--- a/documentation/content/en/books/porters-handbook/testing/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/testing/_index.adoc
@@ -3,7 +3,7 @@ title: Chapter 10. Testing the Port
prev: books/porters-handbook/pkg-files
next: books/porters-handbook/upgrading
description: Testing a FreeBSD Port
-tags: ["testing", "port", "Portclippy", "Portfmt", "Portlint", "Poudriere", "sets"]
+tags: ["testing", "port", "Portclippy", "Portfmt", "Portlint", "poudriere", "sets"]
showBookMenu: true
weight: 10
path: "/books/porters-handbook/"