From nobody Thu Aug 28 17:01:56 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 4cCSP031Q6z66K7G for ; Thu, 28 Aug 2025 17:01:56 +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 4cCSP02HlMz3MqX; Thu, 28 Aug 2025 17:01:56 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1756400516; 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=a6gR54M0X3rxsVUZ57eEtdoEQlt9xLcvYNDEsS3KGHc=; b=Jc/3TWH0Ifk2qu9F8cHbcy1hOhJUxY+C2LgWRn3PpB80GwEhtz0jL2b3q74Xasq6DVbXcf j7eRbdQIl4Ee6H1G1kmQ77w3+3TzRWenED+y8tWR6DR9jWdr5xvW9zOSv3amKjFkQyVOuL GgWqxaiR+S3ezcmMIhDcsf4ADcfJ+ryaBKB5GujCEk7RVrPFmRHIiowlHlaWc2CsPIox80 8OAG3C6MgtjPb8rPdiK0bR9GS/b5vMVNCEAj8ddQ8fnQGw0E3fube3k0CClKzQF1JyDGdp 09Xg0iNJZ0WewI9ODfM/PUGqobc9eSSlTy/fA/+XJi5bPrkmhuW2NC5D+V98DQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1756400516; 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=a6gR54M0X3rxsVUZ57eEtdoEQlt9xLcvYNDEsS3KGHc=; b=UNJ8kUQ5+RdFh4dDoUdrZbxjz2+fNW1IPTxC++arz8dLpBMSAtG1orfRmFReiK/BMlNuSM O9ZkQNrZaNYGQ5HvH6aqyaW7EEEQLBlxF8VghQQBw8nhXRkZexys6yQgTACiBHoJmYcww4 kjZ+6C928UXO36EK19EFG+bBNYLDqVvwsVZ3Axj6JjyaSYlNqZ8QqoiWFNmt4npQCV1EHp hGNgOve0ghu4q4CqcceWxj5Uy0OTbBBx8jS3yOh/4kSMU051WZSaVETkp6FgU6cR4Mtps4 iS5zkg7zZXzHKfKJGDQdUfZUiUmqrSkQI8dWEOxtk5jLl7Pe5Go8YdgFzkWN7g== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1756400516; a=rsa-sha256; cv=none; b=htgXF4grt+UcZ01TouZWBFULtFBsuJJOPd0eEdYBhTvEV2LORvXMbnk57VTM5Yv8xkQE+P Ha8LpfTJNpehFX+Tfz+wN/W894rS3mLVKs6eANxVRoLRWekJd55XHJ5ln222D1BaZTPQ/g eME0F2232kmg0m5pfLO6UTP7A5J0OYi98A5/9VZi/fQgu4DM1aIOM/JZDMAVQUYebM6++i J6LXet29+aogCXCCHgj6S4R1ST4U3ZTCXcaeljJWGvLrfjWdwYCD/l+KIT7j3PjjVtuCdX LdchN7ophzymqv6D0Jh6EiwREnqY8rakgl+smzxPlWBtXRSDtKJRVWU63XdpBQ== 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 4cCSP01t63z1GSk; Thu, 28 Aug 2025 17:01:56 +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 57SH1u6g099655; Thu, 28 Aug 2025 17:01:56 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 57SH1uCs099652; Thu, 28 Aug 2025 17:01:56 GMT (envelope-from git) Date: Thu, 28 Aug 2025 17:01:56 GMT Message-Id: <202508281701.57SH1uCs099652@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Benedict Reuschling Subject: git: 38cc9fe26c - main - Avoid the use of "you" in the disks 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: 38cc9fe26cff0230dbc76eb27014c04f0933f71f Auto-Submitted: auto-generated The branch main has been updated by bcr: URL: https://cgit.FreeBSD.org/doc/commit/?id=38cc9fe26cff0230dbc76eb27014c04f0933f71f commit 38cc9fe26cff0230dbc76eb27014c04f0933f71f Author: Benedict Reuschling AuthorDate: 2025-08-28 14:59:14 +0000 Commit: Benedict Reuschling CommitDate: 2025-08-28 17:01:17 +0000 Avoid the use of "you" in the disks 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/D52207 --- documentation/content/en/books/handbook/disks/_index.adoc | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/documentation/content/en/books/handbook/disks/_index.adoc b/documentation/content/en/books/handbook/disks/_index.adoc index 599952fecd..b86395f9e4 100644 --- a/documentation/content/en/books/handbook/disks/_index.adoc +++ b/documentation/content/en/books/handbook/disks/_index.adoc @@ -55,7 +55,7 @@ endif::[] This chapter covers the use of disks and storage media in FreeBSD. This includes SCSI and IDE disks, CD and DVD media, memory-backed disks, and USB storage devices. -After reading this chapter, you will know: +Read this chapter to learn: * How to add additional hard disks to a FreeBSD system. * How to grow the size of a disk's partition on FreeBSD. @@ -68,7 +68,7 @@ After reading this chapter, you will know: * How to encrypt disks and swap to secure them against attackers. * How to configure a highly available storage network. -Before reading this chapter, you should: +Before reading this chapter: * Know how to crossref:kernelconfig[kernelconfig,configure and install a new FreeBSD kernel]. @@ -1487,7 +1487,8 @@ For more details about `mdmfs`, refer to man:mdmfs[8]. FreeBSD offers a feature in conjunction with crossref:config[soft-updates,Soft Updates]: file system snapshots. -UFS snapshots allow a user to create images of specified file systems, and treat them as a file. If you are using the crossref:zfs[,Z file system (ZFS)], refer to crossref:zfs[zfs-zfs-snapshot,"Managing Snapshots"] on how to use snapshots. +UFS snapshots allow a user to create images of specified file systems, and treat them as a file. +When using the crossref:zfs[,Z file system (ZFS)], refer to crossref:zfs[zfs-zfs-snapshot,"Managing Snapshots"] on how to use snapshots. Snapshot files must be created in the file system that the action is performed on, and a user may create no more than 20 snapshots per file system. Active snapshots are recorded in the superblock so they are persistent across unmount and remount operations along with system reboots. @@ -2148,13 +2149,13 @@ The following are the main features of HAST: * Can be used in an already deployed environment to add additional redundancy. * Together with CARP, Heartbeat, or other tools, it can be used to build a robust and durable storage system. -After reading this section, you will know: +Read this chapter to learn: * What HAST is, how it works, and which features it provides. * How to set up and use HAST on FreeBSD. * How to integrate CARP and man:devd[8] to build a robust storage system. -Before reading this section, you should: +Before reading this section: * Understand UNIX(R) and FreeBSD basics (crossref:basics[basics,FreeBSD Basics]). * Know how to configure network interfaces and other core FreeBSD subsystems (crossref:config[config-tuning,Configuration and Tuning]).