From owner-dev-commits-doc-all@freebsd.org Tue Jan 12 18:34:43 2021 Return-Path: Delivered-To: dev-commits-doc-all@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id CE7964E1F60 for ; Tue, 12 Jan 2021 18:34:43 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4DFfPb5Rjgz4TfX; Tue, 12 Jan 2021 18:34:43 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id ADB3F14EA; Tue, 12 Jan 2021 18:34:43 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 10CIYh65030032; Tue, 12 Jan 2021 18:34:43 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 10CIYhTw030031; Tue, 12 Jan 2021 18:34:43 GMT (envelope-from git) Date: Tue, 12 Jan 2021 18:34:43 GMT Message-Id: <202101121834.10CIYhTw030031@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Daniel Ebdrup Jensen Subject: git: eab1c5d1f6 - main - books/: Address more instances of sentences beginning with 'Because...' MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: debdrup X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: eab1c5d1f64d77131928469081729d6370841075 Auto-Submitted: auto-generated X-BeenThere: dev-commits-doc-all@freebsd.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Commit messages for all branches of the doc repository List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 12 Jan 2021 18:34:43 -0000 The branch main has been updated by debdrup: URL: https://cgit.FreeBSD.org/doc/commit/?id=eab1c5d1f64d77131928469081729d6370841075 commit eab1c5d1f64d77131928469081729d6370841075 Author: Ceri Davies AuthorDate: 2021-01-12 17:57:32 +0000 Commit: Daniel Ebdrup Jensen CommitDate: 2021-01-12 18:33:23 +0000 books/: Address more instances of sentences beginning with 'Because...' As was the case with the previous commit, the intention is to avoid sentence fragments as well as sentences that can be mistaken for them, since the handbook isn't written in a style that makes use of subordinate conjunctions. While touching the relevant files, I also fixed a few issues pointed out by PauAmma, and reflowed a sentence as a result. PR: 252519 Submitted by: ceri@ Reviewed by: PauAmma --- en_US.ISO8859-1/books/arch-handbook/boot/chapter.xml | 2 +- en_US.ISO8859-1/books/arch-handbook/scsi/chapter.xml | 4 ++-- .../books/developers-handbook/ipv6/chapter.xml | 6 +++--- .../books/developers-handbook/kerneldebug/chapter.xml | 2 +- .../books/developers-handbook/secure/chapter.xml | 2 +- .../books/developers-handbook/sockets/chapter.xml | 6 +++--- en_US.ISO8859-1/books/faq/book.xml | 4 ++-- en_US.ISO8859-1/books/fdp-primer/manpages/chapter.xml | 2 +- .../books/fdp-primer/po-translations/chapter.xml | 8 ++++---- en_US.ISO8859-1/books/fdp-primer/xml-primer/chapter.xml | 6 +++--- en_US.ISO8859-1/books/handbook/basics/chapter.xml | 6 +++--- en_US.ISO8859-1/books/handbook/boot/chapter.xml | 2 +- en_US.ISO8859-1/books/handbook/config/chapter.xml | 4 ++-- en_US.ISO8859-1/books/handbook/geom/chapter.xml | 16 ++++++++-------- en_US.ISO8859-1/books/handbook/multimedia/chapter.xml | 2 +- en_US.ISO8859-1/books/handbook/security/chapter.xml | 4 ++-- en_US.ISO8859-1/books/handbook/serialcomms/chapter.xml | 4 ++-- en_US.ISO8859-1/books/handbook/zfs/chapter.xml | 6 +++--- 18 files changed, 43 insertions(+), 43 deletions(-) diff --git a/en_US.ISO8859-1/books/arch-handbook/boot/chapter.xml b/en_US.ISO8859-1/books/arch-handbook/boot/chapter.xml index 798b7bc6d9..2ba2795fb3 100644 --- a/en_US.ISO8859-1/books/arch-handbook/boot/chapter.xml +++ b/en_US.ISO8859-1/books/arch-handbook/boot/chapter.xml @@ -1585,7 +1585,7 @@ init.3: lea 0x8(%di),%di # Next entry if multitasking facilities are used or different privilege levels are defined. Since the boot2 client is executed in privilege level 3, but the - BTX server does in privilege level 0, a + BTX server runs in privilege level 0, a TSS must be defined:
diff --git a/en_US.ISO8859-1/books/arch-handbook/scsi/chapter.xml b/en_US.ISO8859-1/books/arch-handbook/scsi/chapter.xml index 7de627b5b9..dfde154052 100644 --- a/en_US.ISO8859-1/books/arch-handbook/scsi/chapter.xml +++ b/en_US.ISO8859-1/books/arch-handbook/scsi/chapter.xml @@ -1634,9 +1634,9 @@ routine (or the other way around, the poll routine may be doing the real action and the interrupt routine would just call the poll routine). Why bother about a separate function then? - Due to different calling conventions. The + This has to do with different calling conventions. The xxx_poll routine gets the struct cam_sim - pointer as its argument when the PCI interrupt routine by common + pointer as its argument while the PCI interrupt routine by common convention gets pointer to the struct xxx_softc and the ISA interrupt routine gets just the device unit number. So the poll routine would diff --git a/en_US.ISO8859-1/books/developers-handbook/ipv6/chapter.xml b/en_US.ISO8859-1/books/developers-handbook/ipv6/chapter.xml index 568cc8ba35..6a51621e89 100644 --- a/en_US.ISO8859-1/books/developers-handbook/ipv6/chapter.xml +++ b/en_US.ISO8859-1/books/developers-handbook/ipv6/chapter.xml @@ -822,16 +822,16 @@ fe80:2::%ep0/64 link#2 UC ep0 packet processing code in the way BSD IPv4 code is implemented, kernel stack may overflow due to long function call chain. sys/netinet6 code is carefully designed to - avoid kernel stack overflow. Because of this, sys/netinet6 + avoid kernel stack overflow, so sys/netinet6 code defines its own protocol switch structure, as "struct ip6protosw" (see netinet6/ip6protosw.h). There is no such update to IPv4 part (sys/netinet) for compatibility, but small change is added to its pr_input() prototype. So - "struct ipprotosw" is also defined. Because of this, if you + "struct ipprotosw" is also defined. As a result, if you receive IPsec-over-IPv4 packet with massive number of IPsec headers, kernel stack may blow up. IPsec-over-IPv6 is okay. - (Off-course, for those all IPsec headers to be processed, + (Of-course, for those all IPsec headers to be processed, each such IPsec header must pass each IPsec check. So an anonymous attacker will not be able to do such an attack.) diff --git a/en_US.ISO8859-1/books/developers-handbook/kerneldebug/chapter.xml b/en_US.ISO8859-1/books/developers-handbook/kerneldebug/chapter.xml index 8fd50f0d68..793d728368 100644 --- a/en_US.ISO8859-1/books/developers-handbook/kerneldebug/chapter.xml +++ b/en_US.ISO8859-1/books/developers-handbook/kerneldebug/chapter.xml @@ -679,7 +679,7 @@ options DIAGNOSTIC &man.dcons.4; provides similar functionality as a serial console. It emulates two serial ports, one for the console and DDB, the other for - GDB. Because remote memory access is fully + GDB. Since remote memory access is fully handled by the hardware, the &man.dcons.4; buffer is accessible even when the system crashes. diff --git a/en_US.ISO8859-1/books/developers-handbook/secure/chapter.xml b/en_US.ISO8859-1/books/developers-handbook/secure/chapter.xml index 8e00147c82..02b062f20c 100644 --- a/en_US.ISO8859-1/books/developers-handbook/secure/chapter.xml +++ b/en_US.ISO8859-1/books/developers-handbook/secure/chapter.xml @@ -310,7 +310,7 @@ int main() { seteuid There are at least 6 different IDs associated with any - given process. Because of this you have to be very careful with + given process, and you must therefore be very careful with the access that your process has at any given time. In particular, all seteuid applications should give up their privileges as soon as it is no longer required. diff --git a/en_US.ISO8859-1/books/developers-handbook/sockets/chapter.xml b/en_US.ISO8859-1/books/developers-handbook/sockets/chapter.xml index 6173905a07..43b32f9b78 100644 --- a/en_US.ISO8859-1/books/developers-handbook/sockets/chapter.xml +++ b/en_US.ISO8859-1/books/developers-handbook/sockets/chapter.xml @@ -101,7 +101,7 @@ computer at speeds approaching the speed of light, it often travels considerably slower between two computers. - Because the languages used in data communications are so + As the languages used in data communications are so terse, we usually refer to them as protocols rather than languages. @@ -337,7 +337,7 @@ extract the PNG file from it. - Because of the complexity of internetworking, we cannot just + Due to the complexity of internetworking, we cannot just use the open system call, or the open() C function. Instead, we need to take several steps to opening a socket. @@ -1381,7 +1381,7 @@ int main() { Not all protocols are that simple. Many receive a request from the client, reply to it, then receive another - request from the same client. Because of that, they do + request from the same client. As a result, they do not know in advance how long they will be serving the client. Such servers usually start a new process for each client. While the new process is serving its client, the diff --git a/en_US.ISO8859-1/books/faq/book.xml b/en_US.ISO8859-1/books/faq/book.xml index 11ebe38646..5942b54a38 100644 --- a/en_US.ISO8859-1/books/faq/book.xml +++ b/en_US.ISO8859-1/books/faq/book.xml @@ -2404,7 +2404,7 @@ kern.timecounter.hardware: TSC -> i8254 (&man.make.1;, &man.system.3;, &man.popen.3;, and analogues in higher-level scripting languages like Perl and Tcl) are specified to use the Bourne shell to - interpret commands. Because the Bourne shell is so often + interpret commands. As the Bourne shell is so often and widely used, it is important for it to be quick to start, be deterministic in its behavior, and have a small memory footprint. @@ -5037,7 +5037,7 @@ Key F15 A A Menu Workplace Nop - Because a packet is coming from outside the network + A packet is coming from outside the network unexpectedly. To disable them, set net.link.ether.inet.log_arp_wrong_iface to 0. diff --git a/en_US.ISO8859-1/books/fdp-primer/manpages/chapter.xml b/en_US.ISO8859-1/books/fdp-primer/manpages/chapter.xml index b2a78f8dc1..c951cbd85e 100644 --- a/en_US.ISO8859-1/books/fdp-primer/manpages/chapter.xml +++ b/en_US.ISO8859-1/books/fdp-primer/manpages/chapter.xml @@ -289,7 +289,7 @@ information. - A final optional argument is defined. Because no name + A final optional argument is defined. Since no name is specified for the argument, the default of file ... is used. diff --git a/en_US.ISO8859-1/books/fdp-primer/po-translations/chapter.xml b/en_US.ISO8859-1/books/fdp-primer/po-translations/chapter.xml index e89c3bde73..cc5681e7a5 100644 --- a/en_US.ISO8859-1/books/fdp-primer/po-translations/chapter.xml +++ b/en_US.ISO8859-1/books/fdp-primer/po-translations/chapter.xml @@ -472,7 +472,7 @@ A pgpkeys A Makefile Check the contents of the - Makefile. Because this is a simple + Makefile. As this is a simple article, in this case the Makefile can be used unchanged. The $&os;...$ version string on the second line will be replaced by the @@ -744,7 +744,7 @@ DOC_PREFIX?= ${.CURDIR}/../../.. - Build the translated document. Because the original + Build the translated document. As the original is a book, the generated document is book.xml. @@ -892,8 +892,8 @@ property 'svn:keywords' set on 'ko_KR.po' Set the MIME types of the files. - Because these files use the UTF-8 - character set, that is also specified. To prevent the + These files use the UTF-8 + character set, so that is also specified. To prevent the version control system from mistaking these files for binary data, the fbsd:notbinary property is also set: diff --git a/en_US.ISO8859-1/books/fdp-primer/xml-primer/chapter.xml b/en_US.ISO8859-1/books/fdp-primer/xml-primer/chapter.xml index 96d2c60d0a..a91251c25b 100644 --- a/en_US.ISO8859-1/books/fdp-primer/xml-primer/chapter.xml +++ b/en_US.ISO8859-1/books/fdp-primer/xml-primer/chapter.xml @@ -214,7 +214,7 @@ A tag is used to identify where a particular element starts, and where the element ends. The tag is not part of - the element itself. Because each grammar was + the element itself. As each grammar was normally written to mark up specific types of information, each one will recognize different elements, and will therefore have different names for the tags. @@ -596,9 +596,9 @@ example.xml:5: element head: validity error : Element head content does not foll council delegated this to the American National Standards Institute (ANSI). - Because the &os; Project has not been registered, + Since the &os; Project has not been registered, the owner string is -//&os;. As seen - in the example, the W3C are not a + in the example, the W3C is not a registered owner either. diff --git a/en_US.ISO8859-1/books/handbook/basics/chapter.xml b/en_US.ISO8859-1/books/handbook/basics/chapter.xml index bc31008871..1be3270b7e 100644 --- a/en_US.ISO8859-1/books/handbook/basics/chapter.xml +++ b/en_US.ISO8859-1/books/handbook/basics/chapter.xml @@ -2867,7 +2867,7 @@ Swap: 2048M Total, 2048M Free - Use &man.kill.1; to send the signal. Because + Use &man.kill.1; to send the signal. As &man.inetd.8; is owned by root, use &man.su.1; to become @@ -3218,8 +3218,8 @@ Swap: 2048M Total, 2048M Free editors - Most &os; configuration is done by editing text files. - Because of this, it is a good idea to become familiar with a + Most &os; configuration is done by editing text files, so + it is a good idea to become familiar with a text editor. &os; comes with a few as part of the base system, and many more are available in the Ports Collection. diff --git a/en_US.ISO8859-1/books/handbook/boot/chapter.xml b/en_US.ISO8859-1/books/handbook/boot/chapter.xml index aa0c741acb..2eead109e5 100644 --- a/en_US.ISO8859-1/books/handbook/boot/chapter.xml +++ b/en_US.ISO8859-1/books/handbook/boot/chapter.xml @@ -217,7 +217,7 @@ Default: F2 Stage One and Stage Two Conceptually, the first and second stages are part of the - same program on the same area of the disk. Because of space + same program on the same area of the disk. Due to space constraints, they have been split into two, but are always installed together. They are copied from the combined /boot/boot by the &os; installer or diff --git a/en_US.ISO8859-1/books/handbook/config/chapter.xml b/en_US.ISO8859-1/books/handbook/config/chapter.xml index dd0a3d7bc3..f7f24a65f4 100644 --- a/en_US.ISO8859-1/books/handbook/config/chapter.xml +++ b/en_US.ISO8859-1/books/handbook/config/chapter.xml @@ -748,7 +748,7 @@ linuxemu/chapter.xml --> Network Driver Interface Specification (NDIS). It includes &man.ndisgen.8; which can be used to convert a &windowsxp; driver into a - format that can be used on &os;. Because the &man.ndis.4; + format that can be used on &os;. As the &man.ndis.4; driver uses a &windowsxp; binary, it only runs on &i386; and amd64 systems. PCI, CardBus, PCMCIA, and USB @@ -2344,7 +2344,7 @@ device_probe_and_attach: cbb0 attach returned 12 referred to as journaling. Meta-data updates are still written synchronously, but only into a small region of the disk. Later on, they are moved - to their proper location. Because the logging area is a + to their proper location. Since the logging area is a small, contiguous region on the disk, there are no long distances for the disk heads to move, even during heavy operations, so these operations are quicker than synchronous diff --git a/en_US.ISO8859-1/books/handbook/geom/chapter.xml b/en_US.ISO8859-1/books/handbook/geom/chapter.xml index dcb1e12e3c..a682799543 100644 --- a/en_US.ISO8859-1/books/handbook/geom/chapter.xml +++ b/en_US.ISO8859-1/books/handbook/geom/chapter.xml @@ -331,7 +331,7 @@ Done. &prompt.root; gmirror clear ada8 &man.gmirror.8; stores one block of metadata at the end of - the disk. Because GPT partition schemes + the disk. As GPT partition schemes also store metadata at the end of the disk, mirroring entire GPT disks with &man.gmirror.8; is not recommended. MBR partitioning is used here @@ -451,7 +451,7 @@ Done. Reboot the system to test the new mirror and verify that all data has been copied. The BIOS will see the mirror as two individual drives rather than a mirror. - Because the drives are identical, it does not matter which is + Since the drives are identical, it does not matter which is selected to boot. See if there are @@ -1431,12 +1431,12 @@ ggate0 A better solution is to use glabel to label the disk devices and use the labels in - /etc/fstab. Because - glabel stores the label in the last sector of - a given provider, the label will remain persistent across - reboots. By using this label as a device, the file system may - always be mounted regardless of what device node it is accessed - through. + /etc/fstab. + Since glabel stores the label in the last + sector of a given provider, the label will remain persistent + across reboots. By using this label as a device, the + file-system may always be mounted regardless of what + device node it is accessed through. glabel can create both transient and diff --git a/en_US.ISO8859-1/books/handbook/multimedia/chapter.xml b/en_US.ISO8859-1/books/handbook/multimedia/chapter.xml index 53dc3c06b2..e1ae696ce9 100644 --- a/en_US.ISO8859-1/books/handbook/multimedia/chapter.xml +++ b/en_US.ISO8859-1/books/handbook/multimedia/chapter.xml @@ -839,7 +839,7 @@ kern.ipc.shmall=32768 an &xorg; extension which allows a program to bypass the &xorg; server and directly - alter the framebuffer. Because it relies on a low level + alter the framebuffer. As it relies on a low-level memory mapping, programs using it must be run as root. The DGA extension can be tested and diff --git a/en_US.ISO8859-1/books/handbook/security/chapter.xml b/en_US.ISO8859-1/books/handbook/security/chapter.xml index 4bc3279737..d3b277a978 100644 --- a/en_US.ISO8859-1/books/handbook/security/chapter.xml +++ b/en_US.ISO8859-1/books/handbook/security/chapter.xml @@ -696,7 +696,7 @@ cat changed The authentication system keeps track of the last one-time password used, and the user is authenticated if the hash of the user-provided password is equal to the previous password. - Because a one-way hash is used, it is impossible to generate + Since a one-way hash is used, it is impossible to generate future one-time passwords if a successfully used password is captured. The iteration count is decremented after each successful login to keep the user and the login program in sync. @@ -1196,7 +1196,7 @@ sendmail : PARANOID : deny trusted third party of the system. It is the computer that issues Kerberos tickets, which are used for clients to authenticate to - servers. Because the KDC is considered + servers. As the KDC is considered trusted by all other computers in the Kerberos realm, it has heightened security concerns. Direct access to the KDC should be diff --git a/en_US.ISO8859-1/books/handbook/serialcomms/chapter.xml b/en_US.ISO8859-1/books/handbook/serialcomms/chapter.xml index 9913ad3755..db13e71ef6 100644 --- a/en_US.ISO8859-1/books/handbook/serialcomms/chapter.xml +++ b/en_US.ISO8859-1/books/handbook/serialcomms/chapter.xml @@ -1031,7 +1031,7 @@ ttyu5 "/usr/libexec/getty std.19200" vt100 on insecure device provides a 16-character buffer, which allows for better system performance. Bugs in plain 16550 devices prevent the use of the 16-character buffer, so use 16550A devices if possible. - Because single-character-buffer devices require more work by the + As single-character-buffer devices require more work by the operating system than the 16-character-buffer devices, 16550A-based serial interface cards are preferred. If the system has many active serial ports or will have a heavy load, @@ -1081,7 +1081,7 @@ ttyu5 "/usr/libexec/getty std.19200" vt100 on insecure The second method is to configure the RS-232 interface to vary its speed based on - the remote user's connection speed. Because + the remote user's connection speed. As getty does not understand any particular modem's connection speed reporting, it gives a login: message at an initial speed and diff --git a/en_US.ISO8859-1/books/handbook/zfs/chapter.xml b/en_US.ISO8859-1/books/handbook/zfs/chapter.xml index c6d89f091a..ef1064a438 100644 --- a/en_US.ISO8859-1/books/handbook/zfs/chapter.xml +++ b/en_US.ISO8859-1/books/handbook/zfs/chapter.xml @@ -1282,7 +1282,7 @@ errors: No known data errors 2 TB drive. The usable space is 1 TB. When the 1 TB drive is replaced with another 2 TB drive, the resilvering process copies the existing data onto the new - drive. Because + drive. As both of the devices now have 2 TB capacity, the mirror's available space can be grown to 2 TB. @@ -4045,7 +4045,7 @@ vfs.zfs.vdev.cache.size="5M" Clones can be promoted, reversing this dependency and making the clone the parent and the previous parent the child. This operation requires no - additional space. Because the amount of space used by + additional space. Since the amount of space used by the parent and child is reversed, existing quotas and reservations might be affected. @@ -4201,7 +4201,7 @@ vfs.zfs.vdev.cache.size="5M" blocks will be checked byte-for-byte to ensure it is actually identical. If the data is not identical, the hash collision will be noted and the two blocks will be - stored separately. Because DDT must + stored separately. As DDT must store the hash of each unique block, it consumes a very large amount of memory. A general rule of thumb is 5-6 GB of ram per 1 TB of deduplicated data).