git: e1e4a70e20 - main - fix punctuation and URLs in en/books and en/articles
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Tue, 14 Oct 2025 18:59:32 UTC
The branch main has been updated by vladlen:
URL: https://cgit.FreeBSD.org/doc/commit/?id=e1e4a70e20c2f2e787c3ceac8306ec33cd8d8258
commit e1e4a70e20c2f2e787c3ceac8306ec33cd8d8258
Author: Vladlen Popolitov <vladlen@FreeBSD.org>
AuthorDate: 2025-10-14 18:59:26 +0000
Commit: Vladlen Popolitov <vladlen@FreeBSD.org>
CommitDate: 2025-10-14 18:59:26 +0000
fix punctuation and URLs in en/books and en/articles
Differential Revision: https://reviews.freebsd.org/D53087
---
.../content/en/articles/geom-class/_index.adoc | 4 ++--
.../content/en/articles/mailing-list-faq/_index.adoc | 4 ++--
.../content/en/articles/pr-guidelines/_index.adoc | 6 +++---
.../content/en/books/arch-handbook/boot/_index.adoc | 6 +++---
.../content/en/books/arch-handbook/sound/_index.adoc | 2 +-
.../content/en/books/arch-handbook/usb/_index.adoc | 2 +-
.../en/books/developers-handbook/ipv6/_index.adoc | 20 ++++++++++----------
.../en/books/developers-handbook/l10n/_index.adoc | 12 ++++++------
.../en/books/developers-handbook/x86/_index.adoc | 4 ++--
.../en/books/porters-handbook/uses/_index.adoc | 4 ++--
10 files changed, 32 insertions(+), 32 deletions(-)
diff --git a/documentation/content/en/articles/geom-class/_index.adoc b/documentation/content/en/articles/geom-class/_index.adoc
index cf10202e74..7613cb780a 100644
--- a/documentation/content/en/articles/geom-class/_index.adoc
+++ b/documentation/content/en/articles/geom-class/_index.adoc
@@ -152,7 +152,7 @@ This is controlled with two [.filename]#/etc/rc.conf# variables:
[.programlisting]
....
dumpdev="/dev/ad0s4b"
-dumpdir="/usr/core
+dumpdir="/usr/core"
....
The `dumpdev` variable specifies the swap partition and `dumpdir` tells the system where in the filesystem to relocate the core dump on reboot.
@@ -241,7 +241,7 @@ Structure `bio` is used for any and all Input/Output operations concerning GEOM.
It basically contains information about what device ('provider') should satisfy the request, request type, offset, length, pointer to a buffer, and a bunch of "user-specific" flags and fields that can help implement various hacks.
The important thing here is that ``bio``s are handled asynchronously.
-That means that, in most parts of the code, there is no analogue to userland's man:read[2] and man:write[2] calls that do not return until a request is done.
+That means that, in most parts of the code, there is no analogue to userland's man:read[2] and man:write[2] calls that do not return until a request is done.
Rather, a developer-supplied function is called as a notification when the request gets completed (or results in error).
The asynchronous programming model (also called "event-driven") is somewhat harder than the much more used imperative one used in userland (at least it takes a while to get used to it).
diff --git a/documentation/content/en/articles/mailing-list-faq/_index.adoc b/documentation/content/en/articles/mailing-list-faq/_index.adoc
index ab708fc0e4..64595b6bb0 100644
--- a/documentation/content/en/articles/mailing-list-faq/_index.adoc
+++ b/documentation/content/en/articles/mailing-list-faq/_index.adoc
@@ -43,8 +43,8 @@ Abstract
This is the FAQ for the FreeBSD mailing lists.
If you are interested in helping with this project, send email to the {freebsd-doc}.
-The latest version of this document is always available from the link:.[FreeBSD World Wide Web server].
-It may also be downloaded as one large link:.[HTML] file with HTTP or as plain text, PostScript, PDF, etc. from the https://download.freebsd.org/doc/[FreeBSD FTP server].
+The latest version of this document is always available from the extref:{mailing-list-faq}[FreeBSD World Wide Web server].
+It may also be downloaded as one large extref:{mailing-list-faq}[HTML] file with HTTP or as plain text, PostScript, PDF, etc. from the https://download.freebsd.org/doc/[FreeBSD FTP server].
You may also want to link:https://www.FreeBSD.org/search/[Search the FAQ].
'''
diff --git a/documentation/content/en/articles/pr-guidelines/_index.adoc b/documentation/content/en/articles/pr-guidelines/_index.adoc
index b6729150cd..d645d4637b 100644
--- a/documentation/content/en/articles/pr-guidelines/_index.adoc
+++ b/documentation/content/en/articles/pr-guidelines/_index.adoc
@@ -208,7 +208,7 @@ this will avoid duplicate emails sent to the mailing list.
[NOTE]
====
-Since the list of individuals who have volunteered to be the default assignee for certain types of PRs changes so often, it is much more suitable for https://wiki.freebsd.org/AssigningPRs[the FreeBSD wiki].
+Since the list of individuals who have volunteered to be the default assignee for certain types of PRs changes so often, it is much more suitable for https://wiki.freebsd.org/AssigningPRs[the FreeBSD wiki].
====
Here is a sample list of such entities; it is probably not complete.
@@ -438,7 +438,7 @@ Here is a sample list of such entities; it is probably not complete.
|mailing list
|===
-Ports PRs which have a maintainer who is a ports committer may be reassigned by anyone (but note that not every FreeBSD committer is necessarily a ports committer, so you cannot simply go by the email address alone.)
+Ports PRs which have a maintainer who is a ports committer may be reassigned by anyone (but note that not every FreeBSD committer is necessarily a ports committer, so you cannot simply go by the email address alone.)
For other PRs, please do not reassign them to individuals (other than yourself) unless you are certain that the assignee really wants to track the PR.
This will help to avoid the case where no one looks at fixing a particular problem because everyone assumes that the assignee is already working on it.
@@ -500,7 +500,7 @@ This means that spammers found them.
Whenever you close one of these PRs, please do the following:
-* Set the component to `junk` (under `Supporting Services`.
+* Set the component to `junk` (under `Supporting Services`).
* Set Responsible to `nobody@FreeBSD.org`.
* Set State to `Issue Resolved`.
diff --git a/documentation/content/en/books/arch-handbook/boot/_index.adoc b/documentation/content/en/books/arch-handbook/boot/_index.adoc
index ef1d8932d1..8508f6f116 100644
--- a/documentation/content/en/books/arch-handbook/boot/_index.adoc
+++ b/documentation/content/en/books/arch-handbook/boot/_index.adoc
@@ -258,7 +258,7 @@ start:
.[.filename]#stand/i386/boot0/boot0.S# [[boot-boot0-entrypoint]]
This first block of code is the entry point of the program.
It is where the BIOS transfers control.
-First, it makes sure that the string operations autoincrement its pointer operands (the `cld` instruction) footnote:[When in doubt, we refer the reader to the official Intel manuals, which describe the exact semantics for each instruction: .].
+First, it makes sure that the string operations autoincrement its pointer operands (the `cld` instruction) footnote:[When in doubt, we refer the reader to the official Intel manuals, which describe the exact semantics for each instruction.].
Then, as it makes no assumption about the state of the segment registers, it initializes them.
Finally, it sets the stack pointer register (`%sp`) to ($LOAD = address `0x7c00`), so we have a working stack.
@@ -719,8 +719,8 @@ The code after the call to `nread` locates the beginning of [.filename]#boot2# i
This is because the BTX server arranges [.filename]#boot2# to execute in a segment starting at `0xa000`.
We explore this in detail in the following section.
-The last code block of [.filename]#boot1# enables access to memory above 1MB footnote:[This is necessary for legacy reasons.
-Interested readers should see .] and concludes with a jump to the starting point of the BTX server:
+The last code block of [.filename]#boot1# enables access to memory above 1MB footnote:[This is necessary for legacy reasons.]
+and concludes with a jump to the starting point of the BTX server:
[.programlisting]
....
diff --git a/documentation/content/en/books/arch-handbook/sound/_index.adoc b/documentation/content/en/books/arch-handbook/sound/_index.adoc
index 395cade887..f7a7d6c19f 100644
--- a/documentation/content/en/books/arch-handbook/sound/_index.adoc
+++ b/documentation/content/en/books/arch-handbook/sound/_index.adoc
@@ -152,7 +152,7 @@ When playing, the general transfer mechanism is as follows (reverse the idea for
==== channel_init
`xxxchannel_init()` is called to initialize each of the play or record channels.
-The calls are initiated from the sound driver attach routine. (See the crossref:sound[pcm-probe-and-attach,probe and attach section).
+The calls are initiated from the sound driver attach routine. (See the crossref:sound[pcm-probe-and-attach,probe and attach section]).
[.programlisting]
....
diff --git a/documentation/content/en/books/arch-handbook/usb/_index.adoc b/documentation/content/en/books/arch-handbook/usb/_index.adoc
index 94a22e850b..a1c8f2b579 100644
--- a/documentation/content/en/books/arch-handbook/usb/_index.adoc
+++ b/documentation/content/en/books/arch-handbook/usb/_index.adoc
@@ -65,7 +65,7 @@ _Lennart Augustsson has done most of the implementation of the USB support for t
The development of drivers for the USB subsystem and devices connected to it is supported by the specifications that have been developed and will be developed. These specifications are publicly available from the USB home pages. Apple has been very strong in pushing for standards based drivers, by making drivers for the generic classes available in their operating system MacOS and discouraging the use of separate drivers for each new device. This chapter tries to collate essential information for a basic understanding of the USB 2.0 implementation stack in FreeBSD/NetBSD. It is recommended however to read it together with the relevant 2.0 specifications and other developer resources:
* USB 2.0 Specification (http://www.usb.org/developers/docs/usb20_docs/[http://www.usb.org/developers/docs/usb20_docs/])
-* Universal Host Controller Interface (UHCI) Specification (link:ftp://ftp.netbsd.org/pub/NetBSD/misc/blymn/uhci11d.pdf[ftp://ftp.netbsd.org/pub/NetBSD/misc/blymn/uhci11d.pdf)]
+* Universal Host Controller Interface (UHCI) Specification (link:ftp://ftp.netbsd.org/pub/NetBSD/misc/blymn/uhci11d.pdf[ftp://ftp.netbsd.org/pub/NetBSD/misc/blymn/uhci11d.pdf])
* Open Host Controller Interface (OHCI) Specification(link:ftp://ftp.compaq.com/pub/supportinformation/papers/hcir1_0a.pdf[ftp://ftp.compaq.com/pub/supportinformation/papers/hcir1_0a.pdf])
* Developer section of USB home page (http://www.usb.org/developers/[http://www.usb.org/developers/])
diff --git a/documentation/content/en/books/developers-handbook/ipv6/_index.adoc b/documentation/content/en/books/developers-handbook/ipv6/_index.adoc
index a97feddf59..e80cf22dbd 100644
--- a/documentation/content/en/books/developers-handbook/ipv6/_index.adoc
+++ b/documentation/content/en/books/developers-handbook/ipv6/_index.adoc
@@ -80,7 +80,7 @@ We also attended University of New Hampshire IOL tests (http://www.iol.unh.edu/[
** IPv4 compatible address is not supported.
** automatic tunneling (described in 4.3 of this RFC) is not supported.
** man:gif[4] interface implements IPv[46]-over-IPv[46] tunnel in a generic way,
- and it covers "configured tunnel" described in the spec. See crossref:ipv6[gif,23.5.1.5] in this document for details.
+ and it covers "configured tunnel" described in the spec. See crossref:ipv6[gif,Generic Tunnel Interface] in this document for details.
* RFC1981: Path MTU Discovery for IPv6
* RFC2080: RIPng for IPv6
@@ -114,15 +114,15 @@ We also attended University of New Hampshire IOL tests (http://www.iol.unh.edu/[
* RFC2460: IPv6 specification
* RFC2461: Neighbor discovery for IPv6
-** See crossref:ipv6[neighbor-discovery,23.5.1.2] in this document for details.
+** See crossref:ipv6[neighbor-discovery,Neighbor Discovery] in this document for details.
* RFC2462: IPv6 Stateless Address Autoconfiguration
-** See crossref:ipv6[ipv6-pnp,23.5.1.4] in this document for details.
+** See crossref:ipv6[ipv6-pnp,Plug and Play] in this document for details.
* RFC2463: ICMPv6 for IPv6 specification
-** See crossref:ipv6[icmpv6,23.5.1.9] in this document for details.
+** See crossref:ipv6[icmpv6,ICMPv6] in this document for details.
* RFC2464: Transmission of IPv6 Packets over Ethernet Networks
* RFC2465: MIB for IPv6: Textual Conventions and General Group
@@ -138,11 +138,11 @@ We also attended University of New Hampshire IOL tests (http://www.iol.unh.edu/[
* RFC2553: Basic Socket Interface Extensions for IPv6
** IPv4 mapped address (3.7) and special behavior of IPv6 wildcard bind socket
- (3.8) are supported. See crossref:ipv6[ipv6-wildcard-socket,23.5.1.12] in this document for details.
+ (3.8) are supported. See crossref:ipv6[ipv6-wildcard-socket,IPv4 Mapped Address and IPv6 Wildcard Socket] in this document for details.
* RFC2675: IPv6 Jumbograms
-** See crossref:ipv6[ipv6-jumbo,23.5.1.7] in this document for details.
+** See crossref:ipv6[ipv6-jumbo,Jumbo Payload] in this document for details.
* RFC2710: Multicast Listener Discovery for IPv6
* RFC2711: IPv6 router alert option
@@ -156,7 +156,7 @@ We also attended University of New Hampshire IOL tests (http://www.iol.unh.edu/[
* [.filename]#draft-itojun-ipv6-tcp-to-anycast-00#: Disconnecting TCP connection toward IPv6 anycast address
* [.filename]#draft-yamamoto-wideipv6-comm-model-00#
-** See crossref:ipv6[ipv6-sas,23.5.1.6] in this document for details.
+** See crossref:ipv6[ipv6-sas,Source Address Selection] in this document for details.
* [.filename]#draft-ietf-ipngwg-scopedaddr-format-00.txt#: An Extension of Format for IPv6 Scoped Addresses
@@ -315,7 +315,7 @@ RFC2462 has validation rule against incoming RA prefix information option, in 5.
This is to protect hosts from malicious (or misconfigured) routers that advertise very short prefix lifetime.
There was an update from Jim Bound to ipngwg mailing list (look for "(ipng 6712)" in the archive) and it is implemented Jim's update.
-See crossref:ipv6[neighbor-discovery,23.5.1.2] in the document for relationship between DAD and autoconfiguration.
+See crossref:ipv6[neighbor-discovery,Neighbor Discovery] in the document for relationship between DAD and autoconfiguration.
[[gif]]
==== Generic Tunnel Interface
@@ -334,7 +334,7 @@ It is very easy to configure interfaces and routing tables to perform infinite l
_Please be warned_.
gif can be configured to be ECN-friendly.
-See crossref:ipv6[ipsec-ecn,23.5.4.5] for ECN-friendliness of tunnels, and man:gif[4] for how to configure.
+See crossref:ipv6[ipsec-ecn,ECN Consideration on IPsec Tunnels] for ECN-friendliness of tunnels, and man:gif[4] for how to configure.
If you would like to configure an IPv4-in-IPv6 tunnel with gif interface, read man:gif[4] carefully.
You will need to remove IPv6 link-local address automatically assigned to the gif interface.
@@ -354,7 +354,7 @@ This is the most typical case.
. If there is no address that satisfies the above condition, choose the address associated with the routing table entry for the destination. This is the last resort, which may cause scope violation.
For instance, ::1 is selected for ff01::1, fe80:1::200:f8ff:fe01:6317 for
-fe80:1::2a0:24ff:feab:839b (note that embedded interface index - described in crossref:ipv6[ipv6-scope-index,23.5.1.3] - helps us choose the right source address.
+fe80:1::2a0:24ff:feab:839b (note that embedded interface index - described in crossref:ipv6[ipv6-scope-index,Scope Index] - helps us choose the right source address.
Those embedded indices will not be on the wire).
If the outgoing interface has multiple address for the scope, a source is selected longest match basis (rule 3).
Suppose 2001:0DB8:808:1:200:f8ff:fe01:6317 and 2001:0DB8:9:124:200:f8ff:fe01:6317 are given to the outgoing interface. 2001:0DB8:808:1:200:f8ff:fe01:6317 is chosen as the source for the destination 2001:0DB8:800::1.
diff --git a/documentation/content/en/books/developers-handbook/l10n/_index.adoc b/documentation/content/en/books/developers-handbook/l10n/_index.adoc
index 5760eaef62..34153230f6 100644
--- a/documentation/content/en/books/developers-handbook/l10n/_index.adoc
+++ b/documentation/content/en/books/developers-handbook/l10n/_index.adoc
@@ -152,7 +152,7 @@ The below lines need to be put into a common header file of the program, which i
#ifdef WITHOUT_NLS
#define getstr(n) nlsstr[n]
#else
-#include nl_types.h
+#include <nl_types.h>
extern nl_catd catalog;
#define getstr(n) catgets(catalog, 1, n, nlsstr[n])
@@ -166,7 +166,7 @@ Next, put these lines into the global declaration part of the main source file:
[.programlisting]
....
#ifndef WITHOUT_NLS
-#include nl_types.h
+#include <nl_types.h>
nl_catd catalog;
#endif
@@ -209,7 +209,7 @@ First, here is an example that does not use libc error messages:
[.programlisting]
....
-#include err.h
+#include <err.h>
...
if (!S_ISDIR(st.st_mode))
errx(1, "argument is not a directory");
@@ -219,8 +219,8 @@ This can be transformed to print an error message by reading `errno` and printin
[.programlisting]
....
-#include err.h
-#include errno.h
+#include <err.h>
+#include <errno.h>
...
if (!S_ISDIR(st.st_mode)) {
errno = ENOTDIR;
@@ -236,7 +236,7 @@ It is worth to note that there are cases when `errno` is set automatically by a
[.programlisting]
....
-#include err.h
+#include <err.h>
...
if ((p = malloc(size)) == NULL)
err(1, NULL);
diff --git a/documentation/content/en/books/developers-handbook/x86/_index.adoc b/documentation/content/en/books/developers-handbook/x86/_index.adoc
index de7cd9e992..b0ca446359 100644
--- a/documentation/content/en/books/developers-handbook/x86/_index.adoc
+++ b/documentation/content/en/books/developers-handbook/x86/_index.adoc
@@ -171,7 +171,7 @@ open:
int 80h
....
-This convention has a great disadvantage over the UNIX(R) way, at least as far as assembly language programming is concerned:
+This convention has a great disadvantage over the UNIX(R) way, at least as far as assembly language programming is concerned:
Every time you make a kernel call you must `push` the registers, then `pop` them later.
This makes your code bulkier and slower.
Nevertheless, FreeBSD gives you a choice.
@@ -2789,7 +2789,7 @@ Plus, this value is for the daylight only: Other types of light will require a d
==== The F-Number
The f-number is a very useful measure of how much light reaches the film.
-A light meter can determine that, for example, to expose a film of specific sensitivity with f5.6 mkay require the exposure to last 1/1000 sec.
+A light meter can determine that, for example, to expose a film of specific sensitivity with f/5.6 may require the exposure to last 1/1000 sec.
It does not matter whether it is a 35-mm camera, or a 6x9cm camera, etc.
As long as we know the f-number, we can determine the proper exposure.
diff --git a/documentation/content/en/books/porters-handbook/uses/_index.adoc b/documentation/content/en/books/porters-handbook/uses/_index.adoc
index 84c6123b80..3f23a7e0f4 100644
--- a/documentation/content/en/books/porters-handbook/uses/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/uses/_index.adoc
@@ -819,8 +819,8 @@ Add a dependency to the client library of the Firebird database.
Possible arguments: (none), `fc`, `fontsdir` (default), `none`
Adds a runtime dependency on tools needed to register fonts.
-Depending on the argument, add a `crossref:plist[plist-keywords-fc,`@fc`]
-${FONTSDIR}` line, `crossref:plist[plist-keywords-fontsdir,`@fontsdir`] ${FONTSDIR}` line, or no line if the argument is `none`, to the plist.
+Depending on the argument, add a `crossref:plist[plist-keywords-fc,@fc] ${FONTSDIR}` line,
+`crossref:plist[plist-keywords-fontsdir,@fontsdir] ${FONTSDIR}` line, or no line if the argument is `none`, to the plist.
`FONTSDIR` defaults to [.filename]#${PREFIX}/share/fonts/${FONTNAME}# and `FONTNAME` to `${PORTNAME}`.
Add `FONTSDIR` to `PLIST_SUB` and `SUB_LIST`