Guangyuan Yang
2021-06-01 06:35:48 UTC
The branch main has been updated by ygy:
URL: https://cgit.FreeBSD.org/doc/commit/?id=231b9562c8714ccf53530acf5db94853e842a02f
commit 231b9562c8714ccf53530acf5db94853e842a02f
Author: Philipp Ost <***@philippost.de>
AuthorDate: 2021-06-01 06:35:17 +0000
Commit: Guangyuan Yang <***@FreeBSD.org>
CommitDate: 2021-06-01 06:35:32 +0000
porters-handbook: Fix typos and phrasing
---
documentation/content/en/books/porters-handbook/makefiles/_index.adoc | 4 ++--
documentation/content/en/books/porters-handbook/plist/_index.adoc | 2 +-
documentation/content/en/books/porters-handbook/special/_index.adoc | 2 +-
3 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/documentation/content/en/books/porters-handbook/makefiles/_index.adoc b/documentation/content/en/books/porters-handbook/makefiles/_index.adoc
index f80c96a952..ddf8d9e63a 100644
--- a/documentation/content/en/books/porters-handbook/makefiles/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/makefiles/_index.adoc
@@ -4328,7 +4328,7 @@ For any of these dependency types:
* `LIB_DEPENDS`
* `RUN_DEPENDS`
-When option _OPT_ is selected, the value of `PT_DEPTYPE`, if defined, is appended to `DEPTYPE`. `OPT_DEPTYPE_OFF` works the same, but when `OPT` is _not_ selected. For example:
+When option _OPT_ is selected, the value of `OPT_DEPTYPE`, if defined, is appended to `DEPTYPE`. `OPT_DEPTYPE_OFF` works the same, but when `OPT` is _not_ selected. For example:
[.programlisting]
....
@@ -4760,7 +4760,7 @@ These macros do not add the installed files to [.filename]#pkg-plist#. They must
[[install-documentation]]
=== Install Additional Documentation
-If the software has some documentation other than the standard man and info pages that is useful for the user, install it under `DOCSDIR` This can be done, like the previous item, in the `post-install` target.
+If the software has some documentation other than the standard man and info pages that is useful for the user, install it under `DOCSDIR`. This can be done, like the previous item, in the `post-install` target.
Create a new directory for the port. The directory name is `DOCSDIR`. This usually equals `PORTNAME`. However, if the user might want different versions of the port to be installed at the same time, the whole `PKGNAME` can be used.
diff --git a/documentation/content/en/books/porters-handbook/plist/_index.adoc b/documentation/content/en/books/porters-handbook/plist/_index.adoc
index 4d6689b428..e89f1b6770 100644
--- a/documentation/content/en/books/porters-handbook/plist/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/plist/_index.adoc
@@ -38,7 +38,7 @@ Some ports, particularly the `p5-` ports, need to change their [.filename]#pkg-p
To make other substitutions, set `PLIST_SUB` with a list of `_VAR=VALUE_` pairs and instances of `%%_VAR_%%` will be substituted with _VALUE_ in [.filename]#pkg-plist#.
-For instance, if a port installs many files in a version-specific subdirectory, use a placeholder for the version so that [.filename]#pkg-plist# does not have to be regenerated every time the port is updated. For example:
+For instance, if a port installs many files in a version-specific subdirectory, use a placeholder for the version so that [.filename]#pkg-plist# does not have to be regenerated every time the port is updated. For example, set:
[.programlisting]
....
diff --git a/documentation/content/en/books/porters-handbook/special/_index.adoc b/documentation/content/en/books/porters-handbook/special/_index.adoc
index 0e3951e091..64748f5290 100644
--- a/documentation/content/en/books/porters-handbook/special/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/special/_index.adoc
@@ -161,7 +161,7 @@ USE_LDCONFIG= ${PREFIX}/lib/foo ${PREFIX}/lib/bar
Please double-check, often this is not necessary at all or can be avoided through `-rpath` or setting `LD_RUN_PATH` during linking (see package:lang/mosml[] for an example), or through a shell-wrapper which sets `LD_LIBRARY_PATH` before invoking the binary, like package:www/seamonkey[] does.
-When installing 32-bit libraries on 64-bit system, use `USE_LDCONFIG32` instead.
+When installing 32-bit libraries on a 64-bit system, use `USE_LDCONFIG32` instead.
If the software uses <<using-autotools,autotools>>, and specifically `libtool`, add crossref:uses[uses-libtool,`USES=libtool`].
URL: https://cgit.FreeBSD.org/doc/commit/?id=231b9562c8714ccf53530acf5db94853e842a02f
commit 231b9562c8714ccf53530acf5db94853e842a02f
Author: Philipp Ost <***@philippost.de>
AuthorDate: 2021-06-01 06:35:17 +0000
Commit: Guangyuan Yang <***@FreeBSD.org>
CommitDate: 2021-06-01 06:35:32 +0000
porters-handbook: Fix typos and phrasing
---
documentation/content/en/books/porters-handbook/makefiles/_index.adoc | 4 ++--
documentation/content/en/books/porters-handbook/plist/_index.adoc | 2 +-
documentation/content/en/books/porters-handbook/special/_index.adoc | 2 +-
3 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/documentation/content/en/books/porters-handbook/makefiles/_index.adoc b/documentation/content/en/books/porters-handbook/makefiles/_index.adoc
index f80c96a952..ddf8d9e63a 100644
--- a/documentation/content/en/books/porters-handbook/makefiles/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/makefiles/_index.adoc
@@ -4328,7 +4328,7 @@ For any of these dependency types:
* `LIB_DEPENDS`
* `RUN_DEPENDS`
-When option _OPT_ is selected, the value of `PT_DEPTYPE`, if defined, is appended to `DEPTYPE`. `OPT_DEPTYPE_OFF` works the same, but when `OPT` is _not_ selected. For example:
+When option _OPT_ is selected, the value of `OPT_DEPTYPE`, if defined, is appended to `DEPTYPE`. `OPT_DEPTYPE_OFF` works the same, but when `OPT` is _not_ selected. For example:
[.programlisting]
....
@@ -4760,7 +4760,7 @@ These macros do not add the installed files to [.filename]#pkg-plist#. They must
[[install-documentation]]
=== Install Additional Documentation
-If the software has some documentation other than the standard man and info pages that is useful for the user, install it under `DOCSDIR` This can be done, like the previous item, in the `post-install` target.
+If the software has some documentation other than the standard man and info pages that is useful for the user, install it under `DOCSDIR`. This can be done, like the previous item, in the `post-install` target.
Create a new directory for the port. The directory name is `DOCSDIR`. This usually equals `PORTNAME`. However, if the user might want different versions of the port to be installed at the same time, the whole `PKGNAME` can be used.
diff --git a/documentation/content/en/books/porters-handbook/plist/_index.adoc b/documentation/content/en/books/porters-handbook/plist/_index.adoc
index 4d6689b428..e89f1b6770 100644
--- a/documentation/content/en/books/porters-handbook/plist/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/plist/_index.adoc
@@ -38,7 +38,7 @@ Some ports, particularly the `p5-` ports, need to change their [.filename]#pkg-p
To make other substitutions, set `PLIST_SUB` with a list of `_VAR=VALUE_` pairs and instances of `%%_VAR_%%` will be substituted with _VALUE_ in [.filename]#pkg-plist#.
-For instance, if a port installs many files in a version-specific subdirectory, use a placeholder for the version so that [.filename]#pkg-plist# does not have to be regenerated every time the port is updated. For example:
+For instance, if a port installs many files in a version-specific subdirectory, use a placeholder for the version so that [.filename]#pkg-plist# does not have to be regenerated every time the port is updated. For example, set:
[.programlisting]
....
diff --git a/documentation/content/en/books/porters-handbook/special/_index.adoc b/documentation/content/en/books/porters-handbook/special/_index.adoc
index 0e3951e091..64748f5290 100644
--- a/documentation/content/en/books/porters-handbook/special/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/special/_index.adoc
@@ -161,7 +161,7 @@ USE_LDCONFIG= ${PREFIX}/lib/foo ${PREFIX}/lib/bar
Please double-check, often this is not necessary at all or can be avoided through `-rpath` or setting `LD_RUN_PATH` during linking (see package:lang/mosml[] for an example), or through a shell-wrapper which sets `LD_LIBRARY_PATH` before invoking the binary, like package:www/seamonkey[] does.
-When installing 32-bit libraries on 64-bit system, use `USE_LDCONFIG32` instead.
+When installing 32-bit libraries on a 64-bit system, use `USE_LDCONFIG32` instead.
If the software uses <<using-autotools,autotools>>, and specifically `libtool`, add crossref:uses[uses-libtool,`USES=libtool`].