docs: More inter-command links

Author: jpgrayson

src/cmd/branch.rs

@@ -71,9 +71,9 @@ fn make() -> clap::Command {
                      unless an optional committish provided for the base.\n\
                      \n\
                      StGit attempts to detect the branch from which the new branch forked, as \
-                     well as the remote repository of that parent branch such that \"stg pull\" \
+                     well as the remote repository of that parent branch such that 'stg pull' \
                      will pull from the correct remote branch. A warning will be printed if the \
-                     parrent branch cannot be determined.",
+                     parent branch cannot be determined.",
                 )
                 .arg(
                     Arg::new("new-branch")
@@ -179,7 +179,7 @@ fn make() -> clap::Command {
                      \n\
                      A protected branch will not be cleaned up; it must be unprotected first.\n\
                      \n\
-                     A cleaned up branch may be reinitialized using \"stg init\".",
+                     A cleaned up branch may be reinitialized using 'stg init'.",
                 )
                 .arg(
                     Arg::new("branch")

src/cmd/edit.rs

@@ -39,7 +39,7 @@ fn make() -> clap::Command {
              message). The StGit attempts to apply the modified diff to the patch's \
              parent tree. If the updated diff does not apply, no changes are made to \
              the patch and the edited patch is saved to a file which may be corrected \
-             and then fed-back into \"stg edit --file\".",
+             and then fed-back into `stg edit --file`.",
         )
         .arg(
             Arg::new("patch")
@@ -53,12 +53,12 @@ fn make() -> clap::Command {
             .short('t')
             .help("Set patch's tree to treeish")
             .long_help(
-                "With --set-tree the patch's git tree is set to the specified \
-                 treeish without changing the tree of any other patches. When used \
-                 on the top patch, the index and work tree will be updated to \
-                 match the new tree. This low-level option is primarily meant to \
-                 be used by tools built on top of StGit, such as the Emacs mode. \
-                 See also the '--set-tree' flag of \"stg push\".",
+                "Set the patch's git tree to the specified treeish without changing \
+                 the tree of any other patches. When used on the top patch, the index \
+                 and work tree will be updated to match the new tree. This low-level \
+                 option is primarily meant to be used by tools built on top of StGit, \
+                 such as the Emacs mode. See also the '--set-tree' flag of 'stg \
+                 push'.",
             )
             .num_args(1)
             .value_name("treeish"),

src/cmd/log.rs

@@ -21,8 +21,8 @@ fn make() -> clap::Command {
             "Show the history of changes to the stack. If one or more patch names are given, \
              only the changes affecting those patches are shown.\n\
              \n\
-             The \"stg undo\" and \"stg redo\" commands may be used to step back and forth \
-             through historical stack states. The \"stg reset\" command may be used to reset \
+             The 'stg undo' and 'stg redo' commands may be used to step back and forth \
+             through historical stack states. The 'stg reset' command may be used to reset \
              the stack directly to a historic state.\n\
              \n\
              The --clear option may be used to delete the stack's change history. Undo and redo \

src/cmd/new.rs

@@ -99,7 +99,7 @@ fn make() -> clap::Command {
                     "Refresh the new patch with changes from work tree. \
                      New patches are empty by default, but with this option \
                      the new patch will capture outstanding changes in the work \
-                     tree as if \"stg refresh\" was run. \
+                     tree as if 'stg refresh' was run. \
                      Use \"--index\" to refresh from the index instead of the work tree.",
                 )
                 .action(clap::ArgAction::SetTrue)

src/cmd/redo.rs

@@ -21,7 +21,7 @@ fn make() -> clap::Command {
         .long_about(
             "If the last command was an undo, the patch stack state will be reset to its state \
              before the undo. Consecutive redos will undo the effects of consecutive invocations \
-             of \"stg undo\".\n\
+             of 'stg undo'.\n\
              \n\
              It is an error to redo if the last stack-modifying command was not an undo.",
         )

src/cmd/repair.rs

@@ -25,38 +25,37 @@ fn make() -> clap::Command {
         .about("Repair stack after branch is modified with git commands")
         .long_about(
             "If a branch with a StGit stack is modified with certain git commands such \
-             as commit, pull, merge, or rebase, the StGit stack metadata will become \
-             inconsistent with the branch state. There are a few options for resolving \
-             this kind of situation:\n\
+             as git-commit(1), git-pull(1), git-merge(1), or git-rebase(1), the StGit \
+             stack metadata will become inconsistent with the branch state. There are \
+             a few options for resolving this kind of situation:\n\
              \n\
-             1. Use \"stg undo\" to undo the effect of the git commands. Or similarly \
-             use \"stg reset\" to reset the stack/branch to any previous stack state.\n\
+             1. Use 'stg undo' to undo the effect of the git commands. Or similarly \
+             use 'stg reset' to reset the stack/branch to any previous stack state.\n\
              \n\
-             2. Use \"stg repair\". This will repair the StGit stack metadata to \
+             2. Use `stg repair`. This will repair the StGit stack metadata to \
              accommodate the modifications to the branch made by the git commands. \
              Specifically, it will do the following:\n\
              \n\
              - If regular git commits were made on top of the stack of StGit patches \
-             (i.e. by using plain \"git commit\"), \"stg repair\" will convert those \
+             (i.e. by using plain `git commit`), `stg repair` will convert those \
              commits to StGit patches, preserving their content.\n\
              \n\
              - However, merge commits cannot become patches. So if a merge was \
-             committed on top of the stack, \"stg repair\" will mark all patches below \
+             committed on top of the stack, `stg repair` will mark all patches below \
              the merge commit as unapplied, since they are no longer reachable. An \
-             alternative when this is not the desired behavior is to use \"stg undo\" \
-             to first get rid of the offending merge and then run \"stg repair\" \
-             again.\n\
+             alternative when this is not the desired behavior is to use `stg undo` to \
+             first get rid of the offending merge and then run `stg repair` again.\n\
              \n\
              - The applied patches are supposed to be precisely those that are \
-             reachable from the branch head. If, for example, \"git reset\" was used \
-             to move the head, some applied patches may no longer be reachable and \
-             some unapplied patches may have become reachable. In this case, \"stg \
-             repair\" will correct the applied/unapplied state of such patches.\n\
+             reachable from the branch head. If, for example, git-reset(1) was used to \
+             move the head, some applied patches may no longer be reachable and some \
+             unapplied patches may have become reachable. In this case, `stg repair` \
+             will correct the applied/unapplied state of such patches.\n\
              \n\
-             \"stg repair\" will repair these inconsistencies reliably, so there are \
-             valid workflows where git commands are used followed by \"stg repair\". \
-             For example, new patches can be created by first making commits with a \
-             graphical commit tool and then running \"stg repair\" to convert those \
+             `stg repair` will repair these inconsistencies reliably, so there are \
+             valid workflows where git commands are used followed by `stg repair`. For \
+             example, new patches can be created by first making commits with a \
+             graphical commit tool and then running `stg repair` to convert those \
              commits into patches.",
         )
 }