From nobody Fri Sep 26 10:32:48 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 4cY6Nc5xQDz686Jx for ; Fri, 26 Sep 2025 10:32:48 +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 4cY6Nc5LVGz3Jcj; Fri, 26 Sep 2025 10:32:48 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1758882768; 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=rYiGST3Txba/3OQ1MyosadQ2mZe9siSps9g36zMF7A4=; b=Za3aFfcJ4uPK2aEugX0OijmY/+d5YTaksFQdPLOSA+mGlJSz5XXdT+zxfI3EpmrsDVUP8F 2yozlw7HIO1UdUKJOeAoFEodgwslaKmDR89xQCmHA7STz5MggQnuqT8bwKvrHCesLDxbmE NNg6iPFJ5B8r2TO0DWJs+btMSwvpsGIw/QoMWrYL7ed4pWx1yf8kBAJJHZIWGbcOypWNUf CT8QwcJeW398UJL6KitkE53RlQ5HxJQ97QI/sqiI0B8+mkLWGxYzH+7L97q9+ko2E/tWIo YmQ7xHy36Ko902S8fVFtPJjCdoCm1Ox7hlm+E5eP/pjyzj6QjhbFLy2lPezlhQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1758882768; 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=rYiGST3Txba/3OQ1MyosadQ2mZe9siSps9g36zMF7A4=; b=xKb4rQKYsJSTl7MPCMKsVSjpW+Iz9OX1jNqhpWdVexOrLYOx+VWXlhLwl9KCzAA08tmvNL M2JRc1us/2B3YtoTFIbpLk+u4260TF1+dGhbkT6nwGfY8h4sFL2Co/5EkCoBoGrNv61yvN dBAAK0PuIvlpnZ9v8zFCEotT2xtPgn3gU5uRF3k6SrXI8jDCiJxk+6A0AGgIk/VHbje9zA sSQmX07pvN92DuhA2Nnx7j2jf3vD0sC1WyVccgAqHWJHbwD4z+7EOmn3fpakQem4q5/TVz LmkdlZm1bEdpRgtCHpaqBUfjL9mdzAycE9lur8DQ6rfhKUesfypTu0ALzWJ7LA== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1758882768; a=rsa-sha256; cv=none; b=JiYMq67NEeiYbGkqhgG5Ald/6Sxy+6xh5dWjkmuigbuHM9iIU1c4A+3J0TY/B3TheArwCN FCet0gcBBXtDm9ZcprR881AQ8gssRwbCyAOdWyIfFPt1jIaKmn+3RKM84Cc3SQ/2oVOWIc K87cRNFc2zwOrErrHLpWXoxvdtR4bKEh+7EuendITapD4GoVwIOrqEHjWAhuEYy2VbloYX HeR3FsUTT5PS7osTL6UuWTif32IVvqGxFMgffq+yLNLgqXVavcwP9K4duaI3GzPrBl/yeX M2SRsuitIxHlRCn/6zV+RqpU2GLIH6RVwzrQ73yoq0MXwOG0mdqwEa2xbBXVvw== 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 4cY6Nc4xkZzk44; Fri, 26 Sep 2025 10:32:48 +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 58QAWmfs052568; Fri, 26 Sep 2025 10:32:48 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 58QAWmUV052565; Fri, 26 Sep 2025 10:32:48 GMT (envelope-from git) Date: Fri, 26 Sep 2025 10:32:48 GMT Message-Id: <202509261032.58QAWmUV052565@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Benedict Reuschling Subject: git: e9348918d0 - main - Avoid the use of 'you' in the documentation 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: e9348918d0cae69c903a57410a90fdc228601297 Auto-Submitted: auto-generated The branch main has been updated by bcr: URL: https://cgit.FreeBSD.org/doc/commit/?id=e9348918d0cae69c903a57410a90fdc228601297 commit e9348918d0cae69c903a57410a90fdc228601297 Author: Benedict Reuschling AuthorDate: 2025-08-28 11:31:02 +0000 Commit: Benedict Reuschling CommitDate: 2025-09-26 10:32:12 +0000 Avoid the use of 'you' in the documentation Differential Revision: https://reviews.freebsd.org/D52202 --- .../en/books/handbook/cutting-edge/_index.adoc | 24 +++++++++++----------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/documentation/content/en/books/handbook/cutting-edge/_index.adoc b/documentation/content/en/books/handbook/cutting-edge/_index.adoc index 59e38e2bc9..04f7e9d37d 100644 --- a/documentation/content/en/books/handbook/cutting-edge/_index.adoc +++ b/documentation/content/en/books/handbook/cutting-edge/_index.adoc @@ -58,7 +58,7 @@ However, even official releases are often updated with security and other critic Regardless of the version used, FreeBSD provides all the necessary tools to keep the system updated, and allows for easy upgrades between versions. This chapter describes how to track the development system and the basic tools for keeping a FreeBSD system up-to-date. -After reading this chapter, you will know: +Read this chapter to learn: * How to keep a FreeBSD system up-to-date with freebsd-update or Git. * How to compare the state of an installed system against a known pristine copy. @@ -66,7 +66,7 @@ After reading this chapter, you will know: * The difference between the two development branches: FreeBSD-STABLE and FreeBSD-CURRENT. * How to rebuild and reinstall the entire base system. -Before reading this chapter, you should: +Before reading this chapter: * Properly set up the network connection (crossref:advanced-networking[advanced-networking,Advanced Networking]). * Know how to install additional third-party software (crossref:ports[ports,Installing Applications: Packages and Ports]). @@ -269,7 +269,7 @@ For example: * a kernel module that is built on 13.1 might *not* be suitable for 13.2. -So, with any minor or major OS upgrade, if your package requirements include any kernel module: +So, with any minor or major OS upgrade, if the package requirements include any kernel module: * *be prepared to build the module from source*. @@ -687,8 +687,8 @@ For example: Usually this number is not all that important. However, when bug fixes are committed, this number makes it easy to quickly determine whether the fix is present in the currently running system. Developers will often refer to the hash of the commit (or provide a URL which has that hash), but not the n-number since the hash is the easily visible identifier for a change while the n-number is not. -Security advisories and errata notices will also note an n-number, which can be directly compared against your system. -When you need to use shallow Git clones, you cannot compare n-numbers reliably as the `git rev-list` command counts all the revisions in the repository which a shallow clone omits. +Security advisories and errata notices will also note an n-number, which can be directly compared against the system. +When shallow Git clones are used, n-numbers cannot be compared reliably, as the git rev-list command counts all revisions in the repository, which a shallow clone omits. [[makeworld]] == Updating FreeBSD from Source @@ -1235,7 +1235,7 @@ To create a new boot environment using the man:bectl[8] tool run: Use this boot environment to start the system as it was before the update if something goes wrong. -Save a list of your non-base packages in case you need that later: +Save a list of the non-base packages in case they are needed later: [source,shell] .... @@ -1255,22 +1255,22 @@ FreeBSD-base { } .... -The next step will upgrade your system to the specified version. +The next step will upgrade the system to the specified version. [WARNING] ==== -This step might remove non-base packages, which could include your running desktop environment. +This step might remove non-base packages, which could include the running desktop environment. Be careful. ==== -Set the environment variable ABI to upgrade the major version (replace amd64 with your architecture and 15 with your targeted version). +Set the environment variable ABI to upgrade the major version (replace amd64 with the architecture and 15 with the targeted version). [source,shell] .... # env ABI=FreeBSD:15:amd64 pkg-static upgrade -r FreeBSD-base .... -There will be a prompt to ask if you want to ignore the version mismatch looking like this: +There will be a prompt to ask about ignoring the version mismatch looking like this: [source,shell] .... @@ -1303,12 +1303,12 @@ If something broke, go back and activate the backup boot environment created bef .... Reboot, and the system will be back to the state before upgrading. -If you haven't created a boot environment, you might want to consider getting help from link:https://www.freebsd.org/support/[FreeBSD Support]. +If no boot environment was created before, consider getting help from link:https://www.freebsd.org/support/[FreeBSD Support]. [[build-pkgbase-packages-locally]] === Manually building pkgbase and publishing it to the local network -If you want to start building your own pkgbase packages clone the FreeBSD source tree: +When building custom pkgbase packages clone the FreeBSD source tree: [source,shell] ....