git: b86fc49b91 - main - Avoid the use of "you" in remaining handbook chapters
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Fri, 26 Sep 2025 10:32:51 UTC
The branch main has been updated by bcr:
URL: https://cgit.FreeBSD.org/doc/commit/?id=b86fc49b915cb1d6e8674d5e98560eef60b96b2f
commit b86fc49b915cb1d6e8674d5e98560eef60b96b2f
Author: Benedict Reuschling <bcr@FreeBSD.org>
AuthorDate: 2025-08-29 10:05:56 +0000
Commit: Benedict Reuschling <bcr@FreeBSD.org>
CommitDate: 2025-09-26 10:32:12 +0000
Avoid the use of "you" in remaining handbook chapters
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
Differential Revision: https://reviews.freebsd.org/D52235
---
documentation/content/en/books/handbook/audit/_index.adoc | 4 ++--
documentation/content/en/books/handbook/boot/_index.adoc | 2 +-
documentation/content/en/books/handbook/config/_index.adoc | 4 ++--
documentation/content/en/books/handbook/desktop/_index.adoc | 2 +-
documentation/content/en/books/handbook/dtrace/_index.adoc | 4 ++--
documentation/content/en/books/handbook/eresources/_index.adoc | 6 +++---
documentation/content/en/books/handbook/filesystems/_index.adoc | 4 ++--
documentation/content/en/books/handbook/firewalls/_index.adoc | 4 ++--
documentation/content/en/books/handbook/geom/_index.adoc | 4 ++--
documentation/content/en/books/handbook/kernelconfig/_index.adoc | 4 ++--
documentation/content/en/books/handbook/l10n/_index.adoc | 5 +++--
documentation/content/en/books/handbook/linuxemu/_index.adoc | 4 ++--
documentation/content/en/books/handbook/mac/_index.adoc | 4 ++--
13 files changed, 26 insertions(+), 25 deletions(-)
diff --git a/documentation/content/en/books/handbook/audit/_index.adoc b/documentation/content/en/books/handbook/audit/_index.adoc
index 0c25670f22..e76b9b6b36 100644
--- a/documentation/content/en/books/handbook/audit/_index.adoc
+++ b/documentation/content/en/books/handbook/audit/_index.adoc
@@ -60,13 +60,13 @@ FreeBSD implements Sun(TM)'s published Basic Security Module (BSM) Application P
This chapter focuses on the installation and configuration of event auditing.
It explains audit policies and provides an example audit configuration.
-After reading this chapter, you will know:
+Read this chapter to learn:
* What event auditing is and how it works.
* How to configure event auditing on FreeBSD for users and processes.
* How to review the audit trail using the audit reduction and review tools.
-Before reading this chapter, you should:
+Before reading this chapter:
* Understand UNIX(R) and FreeBSD basics (crossref:basics[basics,FreeBSD Basics]).
* Be familiar with the basics of kernel configuration/compilation (crossref:kernelconfig[kernelconfig,Configuring the FreeBSD Kernel]).
diff --git a/documentation/content/en/books/handbook/boot/_index.adoc b/documentation/content/en/books/handbook/boot/_index.adoc
index 92a300d167..b8fe0c7e7c 100644
--- a/documentation/content/en/books/handbook/boot/_index.adoc
+++ b/documentation/content/en/books/handbook/boot/_index.adoc
@@ -59,7 +59,7 @@ This chapter details the configuration options that can be set.
It demonstrates how to customize the FreeBSD boot process, including everything that happens until the FreeBSD kernel has started, probed for devices, and started man:init[8].
This occurs when the text color of the boot messages changes from bright white to grey.
-After reading this chapter, you will recognize:
+Read this chapter to learn:
* The components of the FreeBSD bootstrap system and how they interact.
* The options that can be passed to the components in the FreeBSD bootstrap in order to control the boot process.
diff --git a/documentation/content/en/books/handbook/config/_index.adoc b/documentation/content/en/books/handbook/config/_index.adoc
index 7675b13762..6089cf402d 100644
--- a/documentation/content/en/books/handbook/config/_index.adoc
+++ b/documentation/content/en/books/handbook/config/_index.adoc
@@ -55,11 +55,11 @@ endif::[]
One of the important aspects of FreeBSD is proper system configuration.
This chapter explains much of the FreeBSD configuration process, including some of the parameters which can be set to tune a FreeBSD system.
-Before reading this chapter, you should:
+Before reading this chapter:
* Understand UNIX(R) and FreeBSD basics (crossref:basics[basics,FreeBSD Basics]).
-After reading this chapter, you will know:
+Read this chapter to learn:
* How to use the various configuration files in [.filename]#/etc#.
* The basics of [.filename]#rc.conf# configuration and [.filename]#/usr/local/etc/rc.d# startup scripts.
diff --git a/documentation/content/en/books/handbook/desktop/_index.adoc b/documentation/content/en/books/handbook/desktop/_index.adoc
index 829a63d77c..fd6e26e695 100644
--- a/documentation/content/en/books/handbook/desktop/_index.adoc
+++ b/documentation/content/en/books/handbook/desktop/_index.adoc
@@ -813,7 +813,7 @@ Functionalities included with Qt Creator are:
* code editor with C++, QML and ECMAscript support;
* rapid code navigation tools;
-* static code checking and style hints as you type;
+* static code checking and style hints when typing;
* context sensitive help;
* visual debugger;
* integrated GUI layout and forms designer.
diff --git a/documentation/content/en/books/handbook/dtrace/_index.adoc b/documentation/content/en/books/handbook/dtrace/_index.adoc
index 755a21404e..b2a8fb93b1 100644
--- a/documentation/content/en/books/handbook/dtrace/_index.adoc
+++ b/documentation/content/en/books/handbook/dtrace/_index.adoc
@@ -65,13 +65,13 @@ Some ports, such as package:databases/postgresql12-server[] and package:lang/php
The official guide to DTrace is maintained by the illumos project at https://illumos.org/books/dtrace/bookinfo.html[illumos Dynamic Tracing Guide].
-After reading this chapter, you will know:
+Read this chapter to learn:
* What DTrace is and what features it provides.
* Differences between the Solaris(TM) DTrace implementation and the one provided by FreeBSD.
* How to enable and use DTrace on FreeBSD.
-Before reading this chapter, you should:
+Before reading this chapter:
* Understand UNIX(R) and FreeBSD basics (crossref:basics[basics,FreeBSD Basics]).
* Have some familiarity with security and how it pertains to FreeBSD (crossref:security[security,Security]).
diff --git a/documentation/content/en/books/handbook/eresources/_index.adoc b/documentation/content/en/books/handbook/eresources/_index.adoc
index d237a62b71..b63222c1af 100644
--- a/documentation/content/en/books/handbook/eresources/_index.adoc
+++ b/documentation/content/en/books/handbook/eresources/_index.adoc
@@ -96,10 +96,10 @@ When in doubt about what list to post a question to, see extref:{freebsd-questio
Before posting to any list, please:
* learn about how to best use the mailing lists, such as how to help avoid frequently-repeated discussions, by reading the extref:{mailing-list-faq}[Mailing List Frequently Asked Questions] (FAQ) document
-* search the archives, to tell whether someone else has already posted what you intend to post.
+* search the archives, to tell whether someone else has already posted the same.
+
+Archive search interfaces include:
-Archive search interfaces include:
-
- https://lists.freebsd.org/search[] (FreeBSD, experimental)
- https://www.freebsd.org/search/[] (DuckDuckGo)
diff --git a/documentation/content/en/books/handbook/filesystems/_index.adoc b/documentation/content/en/books/handbook/filesystems/_index.adoc
index 5e15895838..85652391bc 100644
--- a/documentation/content/en/books/handbook/filesystems/_index.adoc
+++ b/documentation/content/en/books/handbook/filesystems/_index.adoc
@@ -63,13 +63,13 @@ See crossref:zfs[zfs,The Z File System (ZFS)] for more details.
In addition to its native file systems, FreeBSD supports a broad range of file systems from other operating systems.
Support for these file systems varies, some require loading kernel modules, while others need additional userland tools.
-Before reading this chapter, you should:
+Before reading this chapter:
* Be familiar with UNIX(R) concepts and crossref:basics[basics,FreeBSD basics].
* Feel comfortable crossref:ports[ports,installing software] in FreeBSD.
* Have some understanding of crossref:disks[disks,disks], storage devices, and FreeBSD's naming conventions for devices.
-After reading this chapter, you will:
+Read this chapter to:
* Understand the differences between native and supported file systems.
* Know which file systems are supported by FreeBSD and the level of support available.
diff --git a/documentation/content/en/books/handbook/firewalls/_index.adoc b/documentation/content/en/books/handbook/firewalls/_index.adoc
index 00e7f7688d..399eb35317 100644
--- a/documentation/content/en/books/handbook/firewalls/_index.adoc
+++ b/documentation/content/en/books/handbook/firewalls/_index.adoc
@@ -71,7 +71,7 @@ Each firewall uses rules to control the access of packets to and from a FreeBSD
FreeBSD provides multiple firewalls in order to meet the different requirements and preferences for a wide variety of users.
Each user should evaluate which firewall best meets their needs.
-After reading this chapter, you will know:
+Read this chapter to learn:
* How to define packet filtering rules.
* The differences between the firewalls built into FreeBSD.
@@ -79,7 +79,7 @@ After reading this chapter, you will know:
* How to use and configure the IPFW firewall.
* How to use and configure the IPFILTER firewall.
-Before reading this chapter, you should:
+Before reading this chapter:
* Understand basic FreeBSD and Internet concepts.
diff --git a/documentation/content/en/books/handbook/geom/_index.adoc b/documentation/content/en/books/handbook/geom/_index.adoc
index a13b1d626c..47fc93b6e4 100644
--- a/documentation/content/en/books/handbook/geom/_index.adoc
+++ b/documentation/content/en/books/handbook/geom/_index.adoc
@@ -59,14 +59,14 @@ This chapter covers the use of disks under the GEOM framework in FreeBSD.
This includes the major RAID control utilities which use the framework for configuration.
This chapter is not a definitive guide to RAID configurations and only GEOM-supported RAID classifications are discussed.
-After reading this chapter, you will know:
+Read this chapter to learn:
* What type of RAID support is available through GEOM.
* How to use the base utilities to configure, maintain, and manipulate the various RAID levels.
* How to mirror, stripe, encrypt, and remotely connect disk devices through GEOM.
* How to troubleshoot disks attached to the GEOM framework.
-Before reading this chapter, you should:
+Before reading this chapter:
* Understand how FreeBSD treats disk devices (crossref:disks[disks,Storage]).
* Know how to configure and install a new kernel (crossref:kernelconfig[kernelconfig,Configuring the FreeBSD Kernel]).
diff --git a/documentation/content/en/books/handbook/kernelconfig/_index.adoc b/documentation/content/en/books/handbook/kernelconfig/_index.adoc
index 5e035105b6..9769a57018 100644
--- a/documentation/content/en/books/handbook/kernelconfig/_index.adoc
+++ b/documentation/content/en/books/handbook/kernelconfig/_index.adoc
@@ -56,7 +56,7 @@ The kernel is the core of the FreeBSD operating system.
It is responsible for managing memory, enforcing security controls, networking, disk access, and much more.
While much of FreeBSD is dynamically configurable, some users may wish to configure and compile a custom kernel.
-After reading this chapter, you will know:
+Read this chapter to learn:
* When to build a custom kernel.
* How to take a hardware inventory.
@@ -204,7 +204,7 @@ The format of the kernel configuration file is simple.
Each line contains a keyword that represents a device or subsystem, an argument, and a brief description.
Any text after a `+#+` is considered a comment and ignored.
To remove kernel support for a device or subsystem, put a `+#+` at the beginning of the line representing that device or subsystem.
-Do not add or remove a `+#+` for any line that you do not understand.
+Do not add or remove a `+#+` for any line that is not understand.
[WARNING]
====
diff --git a/documentation/content/en/books/handbook/l10n/_index.adoc b/documentation/content/en/books/handbook/l10n/_index.adoc
index 83ce371621..73d5f3cd99 100644
--- a/documentation/content/en/books/handbook/l10n/_index.adoc
+++ b/documentation/content/en/books/handbook/l10n/_index.adoc
@@ -61,7 +61,8 @@ L10n uses the same naming scheme, but from `localization`.
The i18n/L10n methods, protocols, and applications allow users to use languages of their choice.
This chapter discusses the internationalization and localization features of FreeBSD.
-After reading this chapter, you will know:
+
+Read this chapter to learn:
* How locale names are constructed.
* How to set the locale for a login shell.
@@ -70,7 +71,7 @@ After reading this chapter, you will know:
* How to find i18n-compliant applications.
* Where to find more information for configuring specific languages.
-Before reading this chapter, you should:
+Before reading this chapter:
* Know how to crossref:ports[ports,install additional third-party applications].
diff --git a/documentation/content/en/books/handbook/linuxemu/_index.adoc b/documentation/content/en/books/handbook/linuxemu/_index.adoc
index 1f0c07c540..292af09e70 100644
--- a/documentation/content/en/books/handbook/linuxemu/_index.adoc
+++ b/documentation/content/en/books/handbook/linuxemu/_index.adoc
@@ -56,11 +56,11 @@ FreeBSD provides *optional* binary compatibility with Linux(R), commonly referre
It is available for the x86 (both 32 and 64 bit) and AArch64 architectures.
Some Linux-specific operating system features are not yet supported; this mostly happens with functionality specific to hardware or related to system management, such as cgroups or namespaces.
-Before reading this chapter, you should:
+Before reading this chapter:
* Know how to install crossref:ports[ports,additional third-party software].
-After reading this chapter, you will know:
+Read this chapter to learn:
* How to enable Linux binary compatibility on a FreeBSD system.
* How to install additional Linux shared libraries.
diff --git a/documentation/content/en/books/handbook/mac/_index.adoc b/documentation/content/en/books/handbook/mac/_index.adoc
index 8a99185537..79745411de 100644
--- a/documentation/content/en/books/handbook/mac/_index.adoc
+++ b/documentation/content/en/books/handbook/mac/_index.adoc
@@ -62,7 +62,7 @@ This is in contrast to the default security mechanism of Discretionary Access Co
This chapter focuses on the MAC framework and the set of pluggable security policy modules FreeBSD provides for enabling various security mechanisms.
-After reading this chapter, you will know:
+Read this chapter to learn:
* The terminology associated with the MAC framework.
* The capabilities of MAC security policy modules as well as the difference between a labeled and non-labeled policy.
@@ -71,7 +71,7 @@ After reading this chapter, you will know:
* How to implement a more secure environment using the MAC framework.
* How to test the MAC configuration to ensure the framework has been properly implemented.
-Before reading this chapter, you should:
+Before reading this chapter:
* Understand UNIX(R) and FreeBSD basics (crossref:basics[basics,FreeBSD Basics]).
* Have some familiarity with security and how it pertains to FreeBSD (crossref:security[security,Security]).