From nobody Thu Aug 28 16:58:51 2025 X-Original-To: dev-commits-doc-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4cCSKR3XlYz66JsG for ; Thu, 28 Aug 2025 16:58:51 +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 "R12" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4cCSKR2Sl6z3MgJ; Thu, 28 Aug 2025 16:58:51 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1756400331; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=vnBAsMY/jBwtHeufxh/EUyqTa9PwzHl9TkiwJihb38A=; b=XAmy8HSGACJBw8nmc3FVZuuxySJJ0ywxWBfonxLkBkh3X68SEVB+bT0qA/5CFqxF//2g9H YI0+KN5SKUDHC8pGobqGjP7YTbszQxwk4gQEBZ3B7QuO8iVLKCvo+343Rcoerabk+Rh+dv cPNCqhx7UGeFWF8aluNBaB+2gEDlmWXBRFPlabicerNp3Hw/BJZggUni/sdhWLFKG+gmw7 gK7VI77CrbP/j308ZLOI7R22hyMHZHhhTLwvDvifnV/nEYcacmd9m0nSJgNixABjc5hg+e 0MxBbdMPyrAmPG5l9JThFCHMHjXBUWwk0tVw7vH5g1vvw0RBzbmE24tZitnVwA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1756400331; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=vnBAsMY/jBwtHeufxh/EUyqTa9PwzHl9TkiwJihb38A=; b=Bl/Vyf1EgyTRUhGNp2dH3te9/AOCWPTc0Wic3VmfJDDOZ/aGrZaMh1y9YB3A2X5o41WyZb dIAWh+pNdHMQHgtBTgI/SC6AVOphTUvpFDiSKyL2pIUNoX18xivn4im4B4TjI784qdEWeY x0VBawFv3dcOQz9jaE/0cILsne+BKCXzvB3R8/W9RngNBEQ5S5QLZKflKO97vu/iA9/Nf3 g6XPPuQdhbgGYJyYsjjlOo9eOGZCODP8Vj50+PKznk2yCVAXVGLpzY3Do9gGx1cm3i3ylQ NCCjVfV4T8Hf1XaB/9o/dHi9nc58VkRnNL2AXvJ4ybv2QvyOjXBRCqNWKtENSQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1756400331; a=rsa-sha256; cv=none; b=PQtuzEXhT8Sdc7XrIubvVta561XBhjGowzsQi5/p1CNBZnbI+58+pISKj+W5Sht32ssMa6 Pdxo+WDpoDq5z/kL2Yy7Nt2sAd5EmuglObpf5kBp0V7s+RU5mnojyNQ7RRFXNxHyDsVFat 35QcoVbQEMyiguGePejrRhZ6QDWQ5teg9DieZCOvcRhs+58Yh9IOFQsPuxGN0Puc3dZlzP oQM0Sw2QDwd57fv/Ydzl1BjTN8YspAyaB0DAPcYeKWw+vrn0qSyqK02FzPsMuEOYi9wTDk aWeM0PyFA43ZqyfjiP/kLpvPXPBX38Yv1O87DHmpf4GU26LgeKObSrbXfbYdNg== ARC-Authentication-Results: i=1; mx1.freebsd.org; none 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 4cCSKR1p0Sz1GN7; Thu, 28 Aug 2025 16:58:51 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.18.1/8.18.1) with ESMTP id 57SGwpuB083102; Thu, 28 Aug 2025 16:58:51 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 57SGwpo4083099; Thu, 28 Aug 2025 16:58:51 GMT (envelope-from git) Date: Thu, 28 Aug 2025 16:58:51 GMT Message-Id: <202508281658.57SGwpo4083099@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Benedict Reuschling Subject: git: 338b72447e - main - Avoid the use of "you" in the install chapter List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-doc-all@freebsd.org Sender: owner-dev-commits-doc-all@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: bcr X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 338b72447eb0e04ffab8890047f99fb4c88fd012 Auto-Submitted: auto-generated The branch main has been updated by bcr: URL: https://cgit.FreeBSD.org/doc/commit/?id=338b72447eb0e04ffab8890047f99fb4c88fd012 commit 338b72447eb0e04ffab8890047f99fb4c88fd012 Author: Benedict Reuschling AuthorDate: 2025-08-28 14:48:52 +0000 Commit: Benedict Reuschling CommitDate: 2025-08-28 16:58:03 +0000 Avoid the use of "you" in the install chapter Rewrite sentences that contain 'you', which should be avoided according to the FDP Primer. The resulting sentences are easier to understand and often shorter. I did not change programlistings and other output as these are from programs, which need to be changed first (out of scope of this change). Event: Oslo Hackathon 2025 Reviewed by: carlavilla Differential Revision: https://reviews.freebsd.org/D52206 --- .../content/en/books/handbook/bsdinstall/_index.adoc | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/documentation/content/en/books/handbook/bsdinstall/_index.adoc b/documentation/content/en/books/handbook/bsdinstall/_index.adoc index 83acfe30e7..79234d2dc6 100644 --- a/documentation/content/en/books/handbook/bsdinstall/_index.adoc +++ b/documentation/content/en/books/handbook/bsdinstall/_index.adoc @@ -64,7 +64,7 @@ The image types are: The rest of this chapter describes the third case, explaining how to install FreeBSD using the text-based installation program named bsdinstall. There may be minor differences between the installer and what is shown here, so use this chapter as a general guide rather than as a set of literal instructions. -After reading this chapter, you will know: +Read this chapter to learn: * How to obtain FreeBSD images and create FreeBSD installation media. * How to start bsdinstall. @@ -86,7 +86,7 @@ Once it has been determined that the system meets the minimum hardware requireme [TIP] ==== -Consider using crossref:virtualization[virtualization,virtualization] if you want to use FreeBSD on a system that already has another operating system installed. +Consider using crossref:virtualization[virtualization,virtualization] when wanting to use FreeBSD on a system that already has another operating system installed. ==== Before moving on to the installation, check that the system is ready by verifying the items in this checklist: @@ -185,7 +185,7 @@ There are two _checksum_ files available, named after the release number and the For example: `CHECKSUM.SHA256-FreeBSD-13.1-RELEASE-amd64` and `CHECKSUM.SHA512-FreeBSD-13.1-RELEASE-amd64`. After downloading one of the files (or both), calculate the _checksum_ for the image file and compare it with the one shown in the _checksum_ file. -Note that you need to compare the calculated _checksum_ against the correct file, as they correspond to two different algorithms: SHA256 and SHA512. +Note that comparing the calculated _checksum_ against the correct file is needed, as they correspond to two different algorithms: SHA256 and SHA512. FreeBSD provides man:sha256[1] and man:sha512[1] that can be used for calculating the _checksum_. Other operating systems have similar programs. @@ -468,7 +468,7 @@ It then demonstrates how to use the different partitioning methods. === Designing the Partition Layout The default partition layout for file systems includes one file system for the entire system. -When using `UFS` it may be worth considering the use of multiple file systems if you have sufficient disk space or multiple disks. +When using `UFS` it may be worth considering the use of multiple file systems with sufficient disk space or multiple disks available. When laying out file systems, remember that hard drives transfer data faster from the outer tracks to the inner. Thus, smaller and heavier-accessed file systems should be closer to the outside of the drive, while larger partitions like `/usr` should be placed toward the inner parts of the disk. It is a good idea to create partitions in an order similar to: `/`, swap, `/var`, and `/usr`. @@ -1045,7 +1045,7 @@ Here is a summary of the services that can be enabled in this menu: * `sshd` - The Secure Shell (SSH) daemon is used to remotely access a system over an encrypted connection. Only enable this service if the system should be available for remote logins. * `moused` - Enable this service if the mouse will be used from the command-line system console. * `ntpdate` - Enable automatic clock synchronization at boot time. Note that the functionality of this program is now available in the man:ntpd[8] daemon and the man:ntpdate[8] utility will soon be retired. -* `ntpd` - The Network Time Protocol (NTP) daemon for automatic clock synchronization. Enable this service if you wish to synchronise your system clock with a remote time server or pool. +* `ntpd` - The Network Time Protocol (NTP) daemon for automatic clock synchronization. Enable this service when wanting to synchronise the system clock with a remote time server or pool. * `powerd` - System power control utility for power control and energy saving. * `dumpdev` - Crash dumps are useful when debugging issues with the system, so users are encouraged to enable them. @@ -1151,7 +1151,7 @@ Once configuration is complete, select btn:[Exit]. [[bsdinstall-final-modification-shell]] .Manual Configuration -image::bsdinstall-final-modification-shell.png[Menu showing that the installation has finished. And asking if you want to open a shell to make manual changes.] +image::bsdinstall-final-modification-shell.png[Menu showing that the installation has finished. And asking if a shell to make manual changes should open.] bsdinstall will prompt for any additional configuration that needs to be done before rebooting into the new system. Select btn:[Yes] to exit to a shell within the new system or btn:[No] to proceed to the last step of the installation.