From nobody Fri Aug 29 08:22: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 4cCrqc1Cwqz66Khd for ; Fri, 29 Aug 2025 08:22:52 +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 4cCrqc0Wmwz45VZ; Fri, 29 Aug 2025 08:22:52 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1756455772; 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=pKo6RrWTWExX9tApOvCiM9QHi/vQvfyjo8A+gOm3wSE=; b=LDKDfBNKGriBaQJyU8oj+/kmH2nGgyR8Fmoenvt1bmikrGuTCzAE5Qpqea31pohzzSjc9e W5zILWoOiTpZXJfVuuaxFlDOeiIeB9waa7Ipnh/ojIpUWpGJd2JMZMloXbaGL8mSvd9E8R rPb7kDcLc4bUEnbvarklWJ/FOsp842feWGVCpZ+d+r9B7gttiZ7nIkr79+VPoM0wOO4ikT bQDoxPz9IS/a7txGTthnpxbWaLTYnTNdUqRE8f2tYyFqevyKVvoK74GqPjLHKHWmfG8+Hp 04wK/+h4fpcRoSP+6DQTqYTe16mAPza5lXFsNCPotFQGcPZaK63elDb/q2letQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1756455772; 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=pKo6RrWTWExX9tApOvCiM9QHi/vQvfyjo8A+gOm3wSE=; b=hpYendYPDfuUxxE/nYGyEwcqc2On6r6QN+S81ICL2OJSt1EQI8sHixbudU5I8H+8Y1rHeH k/vJAIrCkc0pbrt6obkYOX5lAIHfDcdfB82IOyDUOk8xdqrcUsD5Zchsu5tbnXr0fzf3jW bqOpvVN36Kb4lShz/pLQ5jtbOz/wzNMKSj1s70rhk0iUGBJKE+u7Z+iaut4JF6gY6VW0/0 EuG6xQhHAs04EKOIDUcMPnrIRW1vtF/K6D4aJ7LZsDV8lLX6Rue5SGp7xSS+v1F+CzfFk7 mXK8zdFPRxQC+6uGGKnR6kTkLoUBx0rPzU9HmEIbU8X4zcV/HpQ+X8XuR88DxA== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1756455772; a=rsa-sha256; cv=none; b=ZD4Cz1XCCljs7qxeJMOSi81lmJlQeZc9yBbmwe5OGRhAL9j0ZRerBGM5qHQPEb7Tcxpp0Y bAdm/SA0CLILyB2SmTglarjE871ruZGMVQmEg1KoLVcJVWwXDfnq8US++n+yMgzcuhDT8u LdqPLHAayl2Do6hPt3lKFWhnIoEdZFjvnOFrF/kvbNPvqCrPTmZKjH1ml5hFBUISg8Vqdw TklPG+2Cyk4kgu+2XV1b4B7QwinfulhTw76T13HDKwbptjEk593252uIscu2tj88vhAbVA mUFszLMEmrTqqieLFStvqMxGBEMOWvGEMTc3zAw5DYlCSqGwRq7xk/Id/SiM7Q== 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 4cCrqb6yPtzY1w; Fri, 29 Aug 2025 08:22: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 57T8MpwH027124; Fri, 29 Aug 2025 08:22:51 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 57T8MpA0027121; Fri, 29 Aug 2025 08:22:51 GMT (envelope-from git) Date: Fri, 29 Aug 2025 08:22:51 GMT Message-Id: <202508290822.57T8MpA0027121@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Benedict Reuschling Subject: git: a7ce6dddfb - main - Avoid the use of "you" in the PPP 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: a7ce6dddfbc3149c26038944211be0302357b270 Auto-Submitted: auto-generated The branch main has been updated by bcr: URL: https://cgit.FreeBSD.org/doc/commit/?id=a7ce6dddfbc3149c26038944211be0302357b270 commit a7ce6dddfbc3149c26038944211be0302357b270 Author: Benedict Reuschling AuthorDate: 2025-08-28 15:45:01 +0000 Commit: Benedict Reuschling CommitDate: 2025-08-28 17:10:48 +0000 Avoid the use of "you" in the PPP 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/D52215 --- .../en/books/handbook/ppp-and-slip/_index.adoc | 28 +++++++++++----------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/documentation/content/en/books/handbook/ppp-and-slip/_index.adoc b/documentation/content/en/books/handbook/ppp-and-slip/_index.adoc index a267fdc7ea..3d7ec970d3 100644 --- a/documentation/content/en/books/handbook/ppp-and-slip/_index.adoc +++ b/documentation/content/en/books/handbook/ppp-and-slip/_index.adoc @@ -55,13 +55,13 @@ endif::[] FreeBSD supports the Point-to-Point (PPP) protocol which can be used to establish a network or Internet connection using a dial-up modem. This chapter describes how to configure modem-based communication services in FreeBSD. -After reading this chapter, you will know: +Read this chapter to learn: * How to configure, use, and troubleshoot a PPP connection. * How to set up PPP over Ethernet (PPPoE). * How to set up PPP over ATM (PPPoA). -Before reading this chapter, you should: +Before reading this chapter: * Be familiar with basic network terminology. * Understand the basics and purpose of a dial-up connection and PPP. @@ -289,7 +289,7 @@ This line specifies the PAP/CHAP user name.Insert the correct value for _MyUserN Line 14::: This line specifies the PAP/CHAP password. Insert the correct value for _MyPassword_. -You may want to add an additional line, such as: +An additional line may be added, such as: + [.programlisting] .... @@ -384,8 +384,8 @@ router_enable="NO" It is important that the `routed` daemon is not started, as `routed` tends to delete the default routing table entries created by `ppp`. -It is probably a good idea to ensure that the `sendmail_flags` line does not include the `-q` option, otherwise `sendmail` will attempt to do a network lookup every now and then, possibly causing your machine to dial out. -You may try: +It is probably a good idea to ensure that the `sendmail_flags` line does not include the `-q` option, otherwise `sendmail` will attempt to do a network lookup every now and then, possibly causing the machine to dial out. +Try this: [.programlisting] .... @@ -709,13 +709,13 @@ Here is an example of a working [.filename]#ppp.conf#: [.programlisting] .... default: - set log Phase tun command # you can add more detailed logging if you wish + set log Phase tun command # add more detailed logging when needed set ifaddr 10.0.0.1/0 10.0.0.2/0 name_of_service_provider: - set device PPPoE:xl1 # replace xl1 with your Ethernet device - set authname YOURLOGINNAME - set authkey YOURPASSWORD + set device PPPoE:xl1 # replace xl1 with the Ethernet device + set authname THELOGINNAME + set authkey THEPASSWORD set dial set login add default HISADDR @@ -734,7 +734,7 @@ Add the following to [.filename]#/etc/rc.conf#: .... ppp_enable="YES" ppp_mode="ddial" -ppp_nat="YES" # if you want to enable nat for your local network, otherwise NO +ppp_nat="YES" # when needing to enable nat for the local network, otherwise NO ppp_profile="name_of_service_provider" .... @@ -746,7 +746,7 @@ Service tags are used to distinguish between different PPPoE servers attached to Any required service tag information should be in the documentation provided by the ISP. As a last resort, one could try installing the package:net/rr-pppoe[] package or port. -Bear in mind however, this may de-program your modem and render it useless, so think twice before doing it. +Bear in mind however, this may de-program the modem and render it useless, so think twice before doing it. Simply install the program shipped with the modem. Then, access the menu:System[] menu from the program. The name of the profile should be listed there. @@ -838,8 +838,8 @@ adsl: open .... -<.> The username used to authenticate with your ISP. -<.> The password used to authenticate with your ISP. +<.> The username used to authenticate with the ISP. +<.> The password used to authenticate with the ISP. Information about the link, or links, to establish is found in [.filename]#mpd.links#. An example [.filename]#mpd.links# to accompany the above example is given beneath: @@ -896,7 +896,7 @@ adsl: .... <.> The username for the DSL provider. -<.> The password for your account. +<.> The password for the account. [WARNING] ====