Fossil Forum

Minor Fixes to FAQ
Login

Minor Fixes to FAQ

Minor Fixes to FAQ

(1) By DB (ABC...) on 2024-06-09 07:30:32 [source]

In re-reading the FAQ I decided I’d attempt a few minor fixes.

The word “to” is missing from “If you want add a tag to an existing check-in,” later I guess autocomplete snuck in “what” instead of “want,” and items are “in” a repository.

Also, I find it very difficult to follow --long-options which break at the end of the line, whether after the double hyphen or before an option’s value.

I think in-line examples of options, and definitely --long-options, should stay on one line, thus I added some non-breaking spaces, and some zero-width joiners.

Another option instead of   & ‍ would be using CSS, something like white-space: nowrap but that would be a bigger change.

After thinking about it a short time, I’m less in favor of a CSS approach since 5 to 6 characters is far less than the CSS would be, and it makes adding them in a batch way less complicated--easier to review a diff.

$ fossil diff -c 2
Index: www/faq.tcl
==================================================================
--- www/faq.tcl
+++ www/faq.tcl
@@ -75,5 +75,5 @@
   for example, it is common to give every released version a "release" tag.
 
-  If you want add a tag to an existing check-in, you can use the
+  If you want to add a tag to an existing check-in, you can use the
   <b>[/help/tag|tag]</b> command.  For example:
 
@@ -86,6 +86,6 @@
 
   You can also add (and remove) tags from a check-in using the
-  [./webui.wiki | web interface].  First locate the check-in that you
-  what to tag on the timeline, then click on the link to go the detailed
+  [./webui.wiki | web interface].  First locate the check-in you
+  want to tag on the timeline, then click on the link to go the detailed
   information page for that check-in.  Then find the "<b>edit</b>"
   link (near the "Commands:" label) and click on that.  There are
@@ -99,5 +99,5 @@
 } {
   Use the <b>--private</b> command-line option on the
-  <b>commit</b> command.  The result will be a check-in which exists on
+  <b>commit</b> command.  The result will be a check-in which exists in
   your local repository only and is never pushed to other repositories.
   All descendants of a private check-in are also private.
$ fossil diff -c 2
Index: www/faq.tcl
==================================================================
--- www/faq.tcl
+++ www/faq.tcl
@@ -39,6 +39,6 @@
 
   When you are checking in a new change using the <b>[/help/commit|commit]</b>
-  command, you can add the option  "--branch <i>BRANCH-NAME</i>" to
-  make the new check-in be the first check-in for a new branch.
+  command, you can add the option  "--&zwj;branch&nbsp;<i>BRANCH-&zwj;NAME</i>"
+  to make the new check-in be the first check-in for a new branch.
 
   If you want to create a new branch whose initial content is the
@@ -71,7 +71,7 @@
   When you are checking in a new change using the <b>[/help/commit|commit]</b>
   command, you can add a tag to that check-in using the
-  "--tag <i>TAGNAME</i>" command-line option.  You can repeat the --tag
-  option to give a check-in multiple tags.  Tags need not be unique.  So,
-  for example, it is common to give every released version a "release" tag.
+  "--&zwj;tag&nbsp;<i>TAGNAME</i>" command-line option.  You can repeat the
+  --&zwj;tag option to give a check-in multiple tags.  Tags need not be unique. 
+  So, for example, it is common to give every released version a "release" tag.
 
   If you want add a tag to an existing check-in, you can use the
@@ -103,6 +103,6 @@
   All descendants of a private check-in are also private.
 
-  Unless you specify something different using the <b>--branch</b> and/or
-  <b>--bgcolor</b> options, the new private check-in will be put on a branch
+  Unless you specify something different using the <b>--&zwj;branch</b> and/or
+  <b>--&zwj;bgcolor</b> options, the new private check-in will be put on a branch
   named "private" with an orange background color.

(2) By Stephan Beal (stephan) on 2024-06-09 11:02:05 in reply to 1 [link] [source]

I think in-line examples of options, and definitely --long-options, should stay on one line, thus I added some non-breaking spaces, and some zero-width joiners.

Thank you for these. i have applied the typo fixes but and adding zwj and nbsp just to keep flags from wrapping with at specific browser widths feels very much like noise to me so i left those bits as-is. We have many documents which would need to be updated for consistency in that regard, plus the /help page text generator (which takes its input from plain text), and future edits would need to take that into account. i.e. the ongoing maintenance burden of those additions outweighs, IMHO, the cosmetic benefits.