master 59951f7af5: Audit quoting symbols in C doc strings

[Lars Ingebrigtsen]

branch: master
commit 59951f7af5877221a25d66a1344b649c6872bac6
Author: Lars Ingebrigtsen <larsi@gnus.org>
Commit: Lars Ingebrigtsen <larsi@gnus.org>

    Audit quoting symbols in C doc strings
    
    * test/manual/etags/c-src/emacs/src/keyboard.c (Frecursive_edit):
    * src/xfns.c (syms_of_xfns):
    * src/xdisp.c (Fwindow_text_pixel_size):
    (syms_of_xdisp):
    * src/w32notify.c (Fw32notify_add_watch):
    (Fw32notify_add_watch):
    * src/frame.c (Fframe_child_frame_border_width):
    * src/comp.c (Fcomp__subr_signature):
    * src/alloc.c (Fgarbage_collect):
    * lib-src/make-docfile.c (scan_c_stream): Audit quoting symbols in C
    doc strings.
---
 lib-src/make-docfile.c                       |  2 +-
 src/alloc.c                                  |  2 +-
 src/comp.c                                   |  2 +-
 src/frame.c                                  |  2 +-
 src/w32notify.c                              | 30 ++++++++++++++--------------
 src/xdisp.c                                  |  6 +++---
 src/xfns.c                                   |  4 ++--
 test/manual/etags/c-src/emacs/src/keyboard.c |  2 +-
 8 files changed, 25 insertions(+), 25 deletions(-)

diff --git a/lib-src/make-docfile.c b/lib-src/make-docfile.c
index d2d4b1d277..908d73f525 100644
--- a/lib-src/make-docfile.c
+++ b/lib-src/make-docfile.c
@@ -1068,7 +1068,7 @@ scan_c_stream (FILE *infile)
                   attributes: attribute1 attribute2 ...)
               (Lisp_Object arg...)
 
-            Now only ’const’, ’noinline’ and 'noreturn' attributes
+            Now only `const', `noinline' and `noreturn' attributes
             are used.  */
 
          /* Advance to the end of docstring.  */
diff --git a/src/alloc.c b/src/alloc.c
index 3cfc3d61dd..cfa51c0a8d 100644
--- a/src/alloc.c
+++ b/src/alloc.c
@@ -6302,7 +6302,7 @@ where each entry has the form (NAME SIZE USED FREE), 
where:
   to return them to the OS).
 
 However, if there was overflow in pure space, and Emacs was dumped
-using the 'unexec' method, `garbage-collect' returns nil, because
+using the \"unexec\" method, `garbage-collect' returns nil, because
 real GC can't be done.
 
 Note that calling this function does not guarantee that absolutely all
diff --git a/src/comp.c b/src/comp.c
index 2b9808aba6..97bc6a5f9d 100644
--- a/src/comp.c
+++ b/src/comp.c
@@ -756,7 +756,7 @@ comp_hash_source_file (Lisp_Object filename)
 
 DEFUN ("comp--subr-signature", Fcomp__subr_signature,
        Scomp__subr_signature, 1, 1, 0,
-       doc: /* Support function to 'hash_native_abi'.
+       doc: /* Support function to hash_native_abi.
 For internal use.  */)
   (Lisp_Object subr)
 {
diff --git a/src/frame.c b/src/frame.c
index 1391cef628..795dcb3ca6 100644
--- a/src/frame.c
+++ b/src/frame.c
@@ -3643,7 +3643,7 @@ DEFUN ("frame-fringe-width", Ffringe_width, 
Sfringe_width, 0, 1, 0,
 
 DEFUN ("frame-child-frame-border-width", Fframe_child_frame_border_width, 
Sframe_child_frame_border_width, 0, 1, 0,
        doc: /* Return width of FRAME's child-frame border in pixels.
- If FRAME's 'child-frame-border-width' parameter is nil, return FRAME's
+ If FRAME's `child-frame-border-width' parameter is nil, return FRAME's
  internal border width instead.  */)
   (Lisp_Object frame)
 {
diff --git a/src/w32notify.c b/src/w32notify.c
index ccefecb659..72e634f77c 100644
--- a/src/w32notify.c
+++ b/src/w32notify.c
@@ -519,16 +519,16 @@ watched for some reason, this function signals a 
`file-error' error.
 FILTER is a list of conditions for reporting an event.  It can include
 the following symbols:
 
-  'file-name'          -- report file creation, deletion, or renaming
-  'directory-name'     -- report directory creation, deletion, or renaming
-  'attributes'         -- report changes in attributes
-  'size'               -- report changes in file-size
-  'last-write-time'    -- report changes in last-write time
-  'last-access-time'   -- report changes in last-access time
-  'creation-time'      -- report changes in creation time
-  'security-desc'      -- report changes in security descriptor
-
-If FILE is a directory, and FILTER includes 'subtree', then all the
+  `file-name'          -- report file creation, deletion, or renaming
+  `directory-name'     -- report directory creation, deletion, or renaming
+  `attributes'         -- report changes in attributes
+  `size'               -- report changes in file-size
+  `last-write-time'    -- report changes in last-write time
+  `last-access-time'   -- report changes in last-access time
+  `creation-time'      -- report changes in creation time
+  `security-desc'      -- report changes in security descriptor
+
+If FILE is a directory, and FILTER includes `subtree', then all the
 subdirectories will also be watched and changes in them reported.
 
 When any event happens that satisfies the conditions specified by
@@ -541,11 +541,11 @@ DESCRIPTOR is the same object as the one returned by this 
function.
 ACTION is the description of the event.  It could be any one of the
 following:
 
-  'added'        -- FILE was added
-  'removed'      -- FILE was deleted
-  'modified'     -- FILE's contents or its attributes were modified
-  'renamed-from' -- a file was renamed whose old name was FILE
-  'renamed-to'   -- a file was renamed and its new name is FILE
+  `added'        -- FILE was added
+  `removed'      -- FILE was deleted
+  `modified'     -- FILE's contents or its attributes were modified
+  `renamed-from' -- a file was renamed whose old name was FILE
+  `renamed-to'   -- a file was renamed and its new name is FILE
 
 FILE is the name of the file whose event is being reported.
 
diff --git a/src/xdisp.c b/src/xdisp.c
index e3e4ca9bb3..bbe64340d1 100644
--- a/src/xdisp.c
+++ b/src/xdisp.c
@@ -11234,7 +11234,7 @@ argument if the size of the buffer is large or unknown.
 
 Optional argument MODE-LINES nil or omitted means do not include the
 height of the mode-, tab- or header-line of WINDOW in the return value.
-If it is the symbol `mode-line', 'tab-line' or `header-line', include
+If it is the symbol `mode-line', `tab-line' or `header-line', include
 only the height of that line, if present, in the return value.  If t,
 include the height of any of these, if present, in the return value.
 
@@ -36249,7 +36249,7 @@ they return to their normal size when the minibuffer is 
closed, or the
 echo area becomes empty.
 
 This variable does not affect resizing of the minibuffer window of
-minibuffer-only frames.  These are handled by 'resize-mini-frames'
+minibuffer-only frames.  These are handled by `resize-mini-frames'
 only.  */);
   /* Contrary to the doc string, we initialize this to nil, so that
      loading loadup.el won't try to resize windows before loading
@@ -36473,7 +36473,7 @@ see biditest.el in the test suite.  */);
     doc: /* Non-nil means inhibit the Bidirectional Parentheses Algorithm.
 Disabling the BPA makes redisplay faster, but might produce incorrect
 display reordering of bidirectional text with embedded parentheses and
-other bracket characters whose 'paired-bracket' Unicode property is
+other bracket characters whose `paired-bracket' Unicode property is
 non-nil, see `get-char-code-property'.  */);
   bidi_inhibit_bpa = false;
 
diff --git a/src/xfns.c b/src/xfns.c
index 4ba7edcb98..94077e0af4 100644
--- a/src/xfns.c
+++ b/src/xfns.c
@@ -9700,11 +9700,11 @@ default and usually works with most desktops.  Some 
desktop environments
 however, may refuse to resize a child frame when Emacs is built with
 GTK3.  For those environments, the two settings below are provided.
 
-If this equals the symbol 'hide', Emacs temporarily hides the child
+If this equals the symbol `hide', Emacs temporarily hides the child
 frame during resizing.  This approach seems to work reliably, may
 however induce some flicker when the frame is made visible again.
 
-If this equals the symbol 'resize-mode', Emacs uses GTK's resize mode to
+If this equals the symbol `resize-mode', Emacs uses GTK's resize mode to
 always trigger an immediate resize of the child frame.  This method is
 deprecated by GTK and may not work in future versions of that toolkit.
 It also may freeze Emacs when used with other desktop environments.  It
diff --git a/test/manual/etags/c-src/emacs/src/keyboard.c 
b/test/manual/etags/c-src/emacs/src/keyboard.c
index 7228f8cb5d..506bf0d01c 100644
--- a/test/manual/etags/c-src/emacs/src/keyboard.c
+++ b/test/manual/etags/c-src/emacs/src/keyboard.c
@@ -759,7 +759,7 @@ force_auto_save_soon (void)
 DEFUN ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "",
        doc: /* Invoke the editor command loop recursively.
 To get out of the recursive edit, a command can throw to `exit' -- for
-instance `(throw 'exit nil)'.
+instance `(throw \\='exit nil)'.
 If you throw a value other than t, `recursive-edit' returns normally
 to the function that called it.  Throwing a t value causes
 `recursive-edit' to quit, so that control returns to the command loop