commit 0307d901c447c2676c723d59cfbe02e146862043
from: Omar Polo <op@omarpolo.com>
via: Thomas Adam <thomas@xteddy.org>
date: Thu Aug 08 16:43:08 2024 UTC

some tweaks for the *.conf.5 pages

- mention that the comments can start anywhere in the file
- explain when quoting is needed

This last point was brought to my attention by PyRX3 on IRC, thanks!

ok/typofix stsp@

commit - c8ff6e7213ea3263819a97db437abb40ea17aff6
commit + 0307d901c447c2676c723d59cfbe02e146862043
blob - 6e7ca5a02c54e06736b5ac4e5d9755da996cf1f5
blob + 3c1e6bc9f14008544ec25a5b8dd7e6c31eb81aa2
--- got/got.conf.5
+++ got/got.conf.5
@@ -34,9 +34,15 @@ settings for
 commands executed within this work tree.
 .Pp
 The file format is line-based, with one configuration directive per line.
-Any lines beginning with a
-.Sq #
-are treated as comments and ignored.
+Comments can be put anywhere in the file using a hash mark
+.Pq Sq # ,
+and extend to the end of the current line.
+Arguments names not beginning with a letter, digit or underscore,
+as well as reserved words
+.Pq such as Ic author , Ic remote No or Ic port ,
+must be quoted.
+Arguments containing whitespace should be surrounded by double quotes
+.Pq \&" .
 .Pp
 The available configuration directives are as follows:
 .Bl -tag -width Ds
blob - fd312076688c5cf8bb47bce4dc90bb1df44222db
blob + fc2b64876b2b20537494f7fa72e0f2a19756ca54
--- gotd/gotd.conf.5
+++ gotd/gotd.conf.5
@@ -25,9 +25,15 @@ is the run-time configuration file for
 .Xr gotd 8 .
 .Pp
 The file format is line-based, with one configuration directive per line.
-Any lines beginning with a
-.Sq #
-are treated as comments and ignored.
+Comments can be put anywhere in the file using a hash mark
+.Pq Sq # ,
+and extend to the end of the current line.
+Arguments names not beginning with a letter, digit or underscore,
+as well as reserved words
+.Pq such as Ic listen , Ic repository No or Ic user ,
+must be quoted.
+Arguments containing whitespace should be surrounded by double quotes
+.Pq \&" .
 .Sh GLOBAL CONFIGURATION
 The available global configuration directives are as follows:
 .Bl -tag -width Ds
blob - 107ee3f149a19d1adc3b1944da2664b7b30b8526
blob + 2bbc2da98a42f54eda543a5d44e452364ab5402f
--- gotwebd/gotwebd.conf.5
+++ gotwebd/gotwebd.conf.5
@@ -25,9 +25,15 @@ is the run-time configuration file for
 .Xr gotwebd 8 .
 .Pp
 The file format is line-based, with one configuration directive per line.
-Any lines beginning with a
-.Sq #
-are treated as comments and ignored.
+Comments can be put anywhere in the file using a hash mark
+.Pq Sq # ,
+and extend to the end of the current line.
+Arguments names not beginning with a letter, digit or underscore,
+as well as reserved words
+.Pq such as Ic listen , Ic server No or Ic user ,
+must be quoted.
+Arguments containing whitespace should be surrounded by double quotes
+.Pq \&" .
 .Pp
 Macros can be defined that are later expanded in context.
 Macro names must start with a letter, digit, or underscore, and may