git: 5821e118dd - main - Escape correctly the # character and fix some typos
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Wed, 02 Nov 2022 19:55:54 UTC
The branch main has been updated by carlavilla:
URL: https://cgit.FreeBSD.org/doc/commit/?id=5821e118dd2b7f93e7f0e45b5cc6c6be798b38e7
commit 5821e118dd2b7f93e7f0e45b5cc6c6be798b38e7
Author: Luís Henriques <henrix@camandro.org>
AuthorDate: 2022-11-02 19:53:59 +0000
Commit: Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
CommitDate: 2022-11-02 19:53:59 +0000
Escape correctly the # character and fix some typos
PR: 267002
---
.../content/en/books/developers-handbook/x86/_index.adoc | 6 +++---
.../en/books/handbook/advanced-networking/_index.adoc | 4 ++--
documentation/content/en/books/handbook/basics/_index.adoc | 6 +++---
documentation/content/en/books/handbook/config/_index.adoc | 2 +-
documentation/content/en/books/handbook/disks/_index.adoc | 2 +-
.../content/en/books/handbook/firewalls/_index.adoc | 6 +++---
.../content/en/books/handbook/kernelconfig/_index.adoc | 12 ++++++------
documentation/content/en/books/handbook/mail/_index.adoc | 2 +-
.../content/en/books/handbook/network-servers/_index.adoc | 10 +++++-----
.../content/en/books/handbook/ppp-and-slip/_index.adoc | 2 +-
documentation/content/en/books/handbook/security/_index.adoc | 2 +-
.../content/en/books/handbook/virtualization/_index.adoc | 2 +-
12 files changed, 28 insertions(+), 28 deletions(-)
diff --git a/documentation/content/en/books/developers-handbook/x86/_index.adoc b/documentation/content/en/books/developers-handbook/x86/_index.adoc
index 77b14e450d..760493117e 100644
--- a/documentation/content/en/books/developers-handbook/x86/_index.adoc
+++ b/documentation/content/en/books/developers-handbook/x86/_index.adoc
@@ -2898,7 +2898,7 @@ Syntax error: best
Et cetera, et cetera, et cetera.
-Secondly, I like the `#` character to denote the start of a comment which extends to the end of the line.
+Secondly, I like the `+#+` character to denote the start of a comment which extends to the end of the line.
This does not take too much effort to code, and lets me treat input files for my software as executable scripts.
In our case, we also need to decide what units the input should come in: We choose _millimeters_ because that is how most photographers measure the focus length.
@@ -3063,7 +3063,7 @@ Now, while we are taking these three steps, we also need to watch out for one of
* If the counter grows above 18, we stop appending to the buffer. We continue reading the digits and sending them to the output.
* If, or rather _when_, the next input character is not a digit, we are done inputting for now.
+
-Incidentally, we can simply discard the non-digit, unless it is a `#`, which we must return to the input stream.
+Incidentally, we can simply discard the non-digit, unless it is a `+#+`, which we must return to the input stream.
It starts a comment, so we must see it after we are done producing output and start looking for more input.
That still leaves one possibility uncovered: If all the user enters is a zero (or several zeros), we will never find a non-zero to display.
@@ -4107,7 +4107,7 @@ We have found that while for the focal length of 150, our pinhole diameter shoul
[[x86-pinhole-scripting]]
=== Scripting
-Because we have chosen the `#` character to denote the start of a comment, we can treat our pinhole software as a _scripting language_.
+Because we have chosen the `+#+` character to denote the start of a comment, we can treat our pinhole software as a _scripting language_.
You have probably seen shell _scripts_ that start with:
diff --git a/documentation/content/en/books/handbook/advanced-networking/_index.adoc b/documentation/content/en/books/handbook/advanced-networking/_index.adoc
index 08bc6af194..578152c27f 100644
--- a/documentation/content/en/books/handbook/advanced-networking/_index.adoc
+++ b/documentation/content/en/books/handbook/advanced-networking/_index.adoc
@@ -2131,7 +2131,7 @@ For example, to read the input from four network interfaces as one stream:
The bridge interface and STP parameters can be monitored via man:bsnmpd[1] which is included in the FreeBSD base system.
The exported bridge MIBs conform to IETF standards so any SNMP client or monitoring package can be used to retrieve the data.
-To enable monitoring on the bridge, uncomment this line in [.filename]#/etc/snmpd.config# by removing the beginning `#` symbol:
+To enable monitoring on the bridge, uncomment this line in [.filename]#/etc/snmpd.config# by removing the beginning `+#+` symbol:
[.programlisting]
....
@@ -2581,7 +2581,7 @@ nfs_server_enable="YES"
inetd_enable="YES"
....
-. Uncomment the following line in [.filename]#/etc/inetd.conf# by making sure it does not start with a `#` symbol:
+. Uncomment the following line in [.filename]#/etc/inetd.conf# by making sure it does not start with a `+#+` symbol:
+
[.programlisting]
....
diff --git a/documentation/content/en/books/handbook/basics/_index.adoc b/documentation/content/en/books/handbook/basics/_index.adoc
index 3489754047..23c7183a04 100644
--- a/documentation/content/en/books/handbook/basics/_index.adoc
+++ b/documentation/content/en/books/handbook/basics/_index.adoc
@@ -96,7 +96,7 @@ Then enter the password associated with the username and press kbd:[Enter].
The password is _not echoed_ for security reasons.
Once the correct password is input, the message of the day (MOTD) will be displayed followed by a command prompt.
-Depending upon the shell that was selected when the user was created, this prompt will be a `#`, `$`, or `%` character.
+Depending upon the shell that was selected when the user was created, this prompt will be a `+#+`, `$`, or `%` character.
The prompt indicates that the user is now logged into the FreeBSD system console and ready to try the available commands.
[[consoles-virtual]]
@@ -138,8 +138,8 @@ ttyv7 "/usr/libexec/getty Pc" xterm on secure
ttyv8 "/usr/X11R6/bin/xdm -nodaemon" xterm off secure
....
-To disable a virtual console, put a comment symbol (`\#`) at the beginning of the line representing that virtual console.
-For example, to reduce the number of available virtual consoles from eight to four, put a `#` in front of the last four lines representing virtual consoles [.filename]#ttyv5# through [.filename]#ttyv8#.
+To disable a virtual console, put a comment symbol (`+#+`) at the beginning of the line representing that virtual console.
+For example, to reduce the number of available virtual consoles from eight to four, put a `+#+` in front of the last four lines representing virtual consoles [.filename]#ttyv5# through [.filename]#ttyv8#.
_Do not_ comment out the line for the system console [.filename]#ttyv0#.
Note that the last virtual console ([.filename]#ttyv8#) is used to access the graphical environment if Xorg has been installed and configured as described in crossref:x11[x11,The X Window System].
diff --git a/documentation/content/en/books/handbook/config/_index.adoc b/documentation/content/en/books/handbook/config/_index.adoc
index be1b87125f..ea22eb6566 100644
--- a/documentation/content/en/books/handbook/config/_index.adoc
+++ b/documentation/content/en/books/handbook/config/_index.adoc
@@ -168,7 +168,7 @@ PATH=/etc:/bin:/sbin:/usr/bin:/usr/sbin <.>
*/5 * * * * root /usr/libexec/atrun <.>
....
-<.> Lines that begin with the `#` character are comments. A comment can be placed in the file as a reminder of what and why a desired action is performed. Comments cannot be on the same line as a command or else they will be interpreted as part of the command; they must be on a new line. Blank lines are ignored.
+<.> Lines that begin with the `+#+` character are comments. A comment can be placed in the file as a reminder of what and why a desired action is performed. Comments cannot be on the same line as a command or else they will be interpreted as part of the command; they must be on a new line. Blank lines are ignored.
<.> The equals (`=`) character is used to define any environment settings. In this example, it is used to define the `SHELL` and `PATH`. If the `SHELL` is omitted, cron will use the default Bourne shell. If the `PATH` is omitted, the full path must be given to the command or script to run.
diff --git a/documentation/content/en/books/handbook/disks/_index.adoc b/documentation/content/en/books/handbook/disks/_index.adoc
index a81e915556..ced3296442 100644
--- a/documentation/content/en/books/handbook/disks/_index.adoc
+++ b/documentation/content/en/books/handbook/disks/_index.adoc
@@ -1775,7 +1775,7 @@ The asterisk `*` indicates that the user is currently over the quota limit.
Quotas are enforced by the quota subsystem on the NFS server.
The man:rpc.rquotad[8] daemon makes quota information available to `quota` on NFS clients, allowing users on those machines to see their quota statistics.
-On the NFS server, enable `rpc.rquotad` by removing the `#` from this line in [.filename]*/etc/inetd.conf*:
+On the NFS server, enable `rpc.rquotad` by removing the `+#+` from this line in [.filename]*/etc/inetd.conf*:
[.programlisting]
....
diff --git a/documentation/content/en/books/handbook/firewalls/_index.adoc b/documentation/content/en/books/handbook/firewalls/_index.adoc
index 99d8a50ed6..6f239ee78b 100644
--- a/documentation/content/en/books/handbook/firewalls/_index.adoc
+++ b/documentation/content/en/books/handbook/firewalls/_index.adoc
@@ -851,7 +851,7 @@ SMTP traffic from an address listed in `<spamd>` but not in `<spamd-white>` is r
The installation of package:mail/spamd[] includes a sample configuration file ([.filename]#/usr/local/etc/spamd.conf.sample#) and a man page for [.filename]#spamd.conf#.
Refer to these for additional configuration options beyond those shown in this example.
+
-One of the first lines in the configuration file that does not begin with a `#` comment sign contains the block which defines the `all` list, which specifies the lists to use:
+One of the first lines in the configuration file that does not begin with a `+#+` comment sign contains the block which defines the `all` list, which specifies the lists to use:
+
[.programlisting]
....
@@ -1170,7 +1170,7 @@ Refer to man:ipfw[8] for details on how these keywords affect rule processing.
When creating an IPFW rule, keywords must be written in the following order.
Some keywords are mandatory while other keywords are optional.
The words shown in uppercase represent a variable and the words shown in lowercase must precede the variable that follows it.
-The `#` symbol is used to mark the start of a comment and may appear at the end of a rule or on its own line.
+The `+#+` symbol is used to mark the start of a comment and may appear at the end of a rule or on its own line.
Blank lines are ignored.
`_CMD RULE_NUMBER set SET_NUMBER ACTION log LOG_AMOUNT PROTO from SRC SRC_PORT to DST DST_PORT OPTIONS_`
@@ -1924,7 +1924,7 @@ When creating rules, keep in mind that unless the `quick` keyword appears in a r
This means that even if the first rule to match a packet is a `pass`, if there is a later matching rule that is a `block`, the packet will be dropped.
Sample rulesets can be found in [.filename]#/usr/share/examples/ipfilter#.
-When creating rules, a `#` character is used to mark the start of a comment and may appear at the end of a rule, to explain that rule's function, or on its own line.
+When creating rules, a `+#+` character is used to mark the start of a comment and may appear at the end of a rule, to explain that rule's function, or on its own line.
Any blank lines are ignored.
The keywords which are used in rules must be written in a specific order, from left to right.
diff --git a/documentation/content/en/books/handbook/kernelconfig/_index.adoc b/documentation/content/en/books/handbook/kernelconfig/_index.adoc
index a16db8cd37..a8d625baef 100644
--- a/documentation/content/en/books/handbook/kernelconfig/_index.adoc
+++ b/documentation/content/en/books/handbook/kernelconfig/_index.adoc
@@ -95,7 +95,7 @@ If there is a need for specific hardware support, it may already exist as a modu
Kernel modules exist in [.filename]#/boot/kernel# and may be dynamically loaded into the running kernel using man:kldload[8].
Most kernel drivers have a loadable module and manual page.
-For example, the man:ath[4] wireless Ethernet driver has the following information in its manual page:
+For example, the man:ath[4] wireless network driver has the following information in its manual page:
[source,shell,subs="macros"]
....
@@ -171,7 +171,7 @@ Once the hardware inventory list is created, refer to it to ensure that drivers
In order to create a custom kernel configuration file and build a custom kernel, the full FreeBSD source tree must first be installed.
If [.filename]#/usr/src/# does not exist or it is empty, source has not been installed.
-Source can be installed using Git and the instructions in crossref:mirrors[git,“Using Git”].
+Source can be installed with Git using the instructions in crossref:mirrors[git,“Using Git”].
Once source is installed, review the contents of [.filename]#/usr/src/sys#.
This directory contains a number of subdirectories, including those which represent the following supported architectures: [.filename]#amd64#, [.filename]#i386#, [.filename]#powerpc#, and [.filename]#sparc64#.
@@ -195,9 +195,9 @@ The default editor is vi, though an easier editor for beginners, called ee, is a
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.
+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.
[WARNING]
====
@@ -339,7 +339,7 @@ Also, man:dmesg[8] will print the kernel messages from the current boot.
+
[NOTE]
====
-When troubleshooting a kernel, make sure to keep a copy of [.filename]#GENERIC#, or some other kernel that is known to work, as a different name that will not get erased on the next build.
+When troubleshooting a kernel make sure to keep a copy of a kernel that is known to work, such as [.filename]#GENERIC#.
This is important because every time a new kernel is installed, [.filename]#kernel.old# is overwritten with the last installed kernel, which may or may not be bootable.
As soon as possible, move the working kernel by renaming the directory containing the good kernel:
diff --git a/documentation/content/en/books/handbook/mail/_index.adoc b/documentation/content/en/books/handbook/mail/_index.adoc
index 0c7563255f..149e8da6d4 100644
--- a/documentation/content/en/books/handbook/mail/_index.adoc
+++ b/documentation/content/en/books/handbook/mail/_index.adoc
@@ -175,7 +175,7 @@ Examples of using these options for both IPv4 and IPv6 addresses can be found in
#Connect:[IPv6:1:2:3:4:5:6:7:8] OK
....
+
-To configure the access database, use the format shown in the sample to make entries in [.filename]#/etc/mail/access#, but do not put a comment symbol (`#`) in front of the entries.
+To configure the access database, use the format shown in the sample to make entries in [.filename]#/etc/mail/access#, but do not put a comment symbol (`+#+`) in front of the entries.
Create an entry for each host or network whose access should be configured.
Mail senders that match the left side of the table are affected by the action on the right side of the table.
+
diff --git a/documentation/content/en/books/handbook/network-servers/_index.adoc b/documentation/content/en/books/handbook/network-servers/_index.adoc
index 822c49f0d2..7a6a3d4bd1 100644
--- a/documentation/content/en/books/handbook/network-servers/_index.adoc
+++ b/documentation/content/en/books/handbook/network-servers/_index.adoc
@@ -93,8 +93,8 @@ This section covers the basics of configuring inetd.
Configuration of inetd is done by editing [.filename]#/etc/inetd.conf#.
Each line of this configuration file represents an application which can be started by inetd.
-By default, every line starts with a comment (`#`), meaning that inetd is not listening for any applications.
-To configure inetd to listen for an application's connections, remove the `#` at the beginning of the line for that application.
+By default, every line starts with a comment (`+#+`), meaning that inetd is not listening for any applications.
+To configure inetd to listen for an application's connections, remove the `+#+` at the beginning of the line for that application.
After saving your edits, configure inetd to start at system boot by editing [.filename]#/etc/rc.conf#:
@@ -124,7 +124,7 @@ Once inetd is started, it needs to be notified whenever a modification is made t
====
-Typically, the default entry for an application does not need to be edited beyond removing the `#`.
+Typically, the default entry for an application does not need to be edited beyond removing the `+#+`.
In some situations, it may be appropriate to edit the default entry.
As an example, this is the default entry for man:ftpd[8] over IPv4:
@@ -760,7 +760,7 @@ ellington has been setup as an YP master server without any errors.
This will create [.filename]#/var/yp/Makefile# from [.filename]#/var/yp/Makefile.dist#.
By default, this file assumes that the environment has a single NIS server with only FreeBSD clients.
-Since `test-domain` has a slave server, edit this line in [.filename]#/var/yp/Makefile# so that it begins with a comment (`#`):
+Since `test-domain` has a slave server, edit this line in [.filename]#/var/yp/Makefile# so that it begins with a comment (`+#+`):
[.programlisting]
....
@@ -2017,7 +2017,7 @@ For more detailed information about Apache 2.X and its configuration directives,
=== Configuring and Starting Apache
In FreeBSD, the main Apache HTTP Server configuration file is installed as [.filename]#/usr/local/etc/apache2x/httpd.conf#, where _x_ represents the version number.
-This ASCII text file begins comment lines with a `#`.
+This ASCII text file begins comment lines with a `+#+`.
The most frequently modified directives are:
`ServerRoot "/usr/local"`::
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 a59b5786ef..7ab4b3cb8c 100644
--- a/documentation/content/en/books/handbook/ppp-and-slip/_index.adoc
+++ b/documentation/content/en/books/handbook/ppp-and-slip/_index.adoc
@@ -166,7 +166,7 @@ Sets the idle timeout for the link in seconds.
Line 9:::
Instructs the peer to confirm the DNS settings.
-If the local network is running its own DNS server, this line should be commented out, by adding a `#` at the beginning of the line, or removed.
+If the local network is running its own DNS server, this line should be commented out, by adding a `+#+` at the beginning of the line, or removed.
Line 10:::
A blank line for readability. Blank lines are ignored by man:ppp[8].
diff --git a/documentation/content/en/books/handbook/security/_index.adoc b/documentation/content/en/books/handbook/security/_index.adoc
index c4c5d44506..4948ce29a3 100644
--- a/documentation/content/en/books/handbook/security/_index.adoc
+++ b/documentation/content/en/books/handbook/security/_index.adoc
@@ -277,7 +277,7 @@ The `default` login class contains an example:
# :passwordtime=90d:\
....
-So, to set an expiry of 90 days for this login class, remove the comment symbol (`#`), save the edit, and run `cap_mkdb /etc/login.conf`.
+So, to set an expiry of 90 days for this login class, remove the comment symbol (`+#+`), save the edit, and run `cap_mkdb /etc/login.conf`.
To set the expiration on individual users, pass an expiration date or the number of days to expiry and a username to `pw`:
diff --git a/documentation/content/en/books/handbook/virtualization/_index.adoc b/documentation/content/en/books/handbook/virtualization/_index.adoc
index 78daa5799d..dc8d5c574d 100644
--- a/documentation/content/en/books/handbook/virtualization/_index.adoc
+++ b/documentation/content/en/books/handbook/virtualization/_index.adoc
@@ -1100,7 +1100,7 @@ freebsd 1 1024 1 -b---- 663.9
To begin the installation of the base operating system, start the VNC client, directing it to the main network address of the host or to the IP address defined on the `vnclisten` line of [.filename]#freebsd.cfg#.
After the operating system has been installed, shut down the DomU and disconnect the VNC viewer.
-Edit [.filename]#freebsd.cfg#, removing the line with the `cdrom` definition or commenting it out by inserting a `#` character at the beginning of the line.
+Edit [.filename]#freebsd.cfg#, removing the line with the `cdrom` definition or commenting it out by inserting a `+#+` character at the beginning of the line.
To load this new configuration, it is necessary to remove the old DomU with `xl destroy`, passing either the name or the id as the parameter.
Afterwards, recreate it using the modified [.filename]*freebsd.cfg*.