git: 9785a09c52 - main - Avoid the use of "you" in the USB device mode chapter
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Fri, 29 Aug 2025 08:33:37 UTC
The branch main has been updated by bcr:
URL: https://cgit.FreeBSD.org/doc/commit/?id=9785a09c52236fdf3772a23f7b9079b166a8c69a
commit 9785a09c52236fdf3772a23f7b9079b166a8c69a
Author: Benedict Reuschling <bcr@FreeBSD.org>
AuthorDate: 2025-08-28 15:56:46 +0000
Commit: Benedict Reuschling <bcr@FreeBSD.org>
CommitDate: 2025-08-29 08:33:13 +0000
Avoid the use of "you" in the USB device mode 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/D52219
---
.../content/en/books/handbook/usb-device-mode/_index.adoc | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/documentation/content/en/books/handbook/usb-device-mode/_index.adoc b/documentation/content/en/books/handbook/usb-device-mode/_index.adoc
index 224412d35f..1ca78d5dfd 100644
--- a/documentation/content/en/books/handbook/usb-device-mode/_index.adoc
+++ b/documentation/content/en/books/handbook/usb-device-mode/_index.adoc
@@ -75,7 +75,7 @@ Note that in some cases, depending on the hardware and the hosts operating syste
When FreeBSD is running on the host, man:usbconfig[8] `reset` can be used.
This also must be done after loading [.filename]#usb_template.ko# if the USB host was already connected to the USBOTG socket.
-After reading this chapter, you will know:
+Read this chapter to learn:
* How to set up USB Device Mode functionality on FreeBSD.
* How to configure the virtual serial port on FreeBSD.
@@ -141,7 +141,7 @@ To load the module and set the template without rebooting use:
To connect to a board configured to provide USB device mode serial ports, connect the USB host, such as a laptop, to the boards USB OTG or USB client port.
Use `pstat -t` on the host to list the terminal lines.
-Near the end of the list you should see a USB serial port, e.g. "ttyU0".
+Near the end of the list a USB serial port is shown, e.g. "ttyU0".
To open the connection, use:
[source,shell]
@@ -149,7 +149,7 @@ To open the connection, use:
# cu -l /dev/ttyU0
....
-After pressing the kbd:[Enter] key a few times you will see a login prompt.
+After pressing the kbd:[Enter] key a few times a login prompt appears.
=== Connecting to USB Device Mode Serial Ports from macOS
@@ -174,10 +174,10 @@ To open the connection, use:
=== Connecting to USB Device Mode Serial Ports from Microsoft Windows 10
To connect to a board configured to provide USB device mode serial ports, connect the USB host, such as a laptop, to the boards USB OTG or USB client port.
-To open a connection you will need a serial terminal program, such as PuTTY.
+To open a connection a serial terminal program is needed, such as PuTTY.
To check the COM port name used by Windows, run Device Manager, expand "Ports (COM & LPT)".
-You will see a name similar to "USB Serial Device (COM4)".
-Run serial terminal program of your choice, for example PuTTY.
+A name similar to "USB Serial Device (COM4)" appears.
+Run the serial terminal program of choice, for example PuTTY.
In the PuTTY dialog set "Connection type" to "Serial", type the COMx obtained from Device Manager in the "Serial line" dialog box and click Open.
[[usb-device-mode-network]]