From a3c31adea4970b8a7fc7f495e6a6a6d4a93e69ce Mon Sep 17 00:00:00 2001 From: Paul Eggert Date: Tue, 1 Sep 2015 06:21:25 -0700 Subject: [PATCH] Docstring fixes re quotes in C code Fix some docstring quoting problems, mostly by escaping apostrophe. --- src/buffer.c | 54 +++++++++++++++++++++++++------------------------- src/data.c | 2 +- src/dired.c | 2 +- src/editfns.c | 2 +- src/eval.c | 6 +++--- src/fileio.c | 2 +- src/fns.c | 4 ++-- src/frame.c | 6 +++--- src/image.c | 2 +- src/keyboard.c | 2 +- src/print.c | 2 +- src/process.c | 4 ++-- src/w32fns.c | 4 ++-- src/xfaces.c | 4 ++-- 14 files changed, 48 insertions(+), 48 deletions(-) diff --git a/src/buffer.c b/src/buffer.c index fc2ee82e447..33f7996a8c1 100644 --- a/src/buffer.c +++ b/src/buffer.c @@ -5402,140 +5402,140 @@ syms_of_buffer (void) DEFVAR_BUFFER_DEFAULTS ("default-mode-line-format", mode_line_format, doc: /* Default value of `mode-line-format' for buffers that don't override it. -This is the same as (default-value 'mode-line-format). */); +This is the same as (default-value \\='mode-line-format). */); DEFVAR_BUFFER_DEFAULTS ("default-header-line-format", header_line_format, doc: /* Default value of `header-line-format' for buffers that don't override it. -This is the same as (default-value 'header-line-format). */); +This is the same as (default-value \\='header-line-format). */); DEFVAR_BUFFER_DEFAULTS ("default-cursor-type", cursor_type, doc: /* Default value of `cursor-type' for buffers that don't override it. -This is the same as (default-value 'cursor-type). */); +This is the same as (default-value \\='cursor-type). */); DEFVAR_BUFFER_DEFAULTS ("default-line-spacing", extra_line_spacing, doc: /* Default value of `line-spacing' for buffers that don't override it. -This is the same as (default-value 'line-spacing). */); +This is the same as (default-value \\='line-spacing). */); DEFVAR_BUFFER_DEFAULTS ("default-cursor-in-non-selected-windows", cursor_in_non_selected_windows, doc: /* Default value of `cursor-in-non-selected-windows'. -This is the same as (default-value 'cursor-in-non-selected-windows). */); +This is the same as (default-value \\='cursor-in-non-selected-windows). */); DEFVAR_BUFFER_DEFAULTS ("default-abbrev-mode", abbrev_mode, doc: /* Default value of `abbrev-mode' for buffers that do not override it. -This is the same as (default-value 'abbrev-mode). */); +This is the same as (default-value \\='abbrev-mode). */); DEFVAR_BUFFER_DEFAULTS ("default-ctl-arrow", ctl_arrow, doc: /* Default value of `ctl-arrow' for buffers that do not override it. -This is the same as (default-value 'ctl-arrow). */); +This is the same as (default-value \\='ctl-arrow). */); DEFVAR_BUFFER_DEFAULTS ("default-enable-multibyte-characters", enable_multibyte_characters, doc: /* Default value of `enable-multibyte-characters' for buffers not overriding it. -This is the same as (default-value 'enable-multibyte-characters). */); +This is the same as (default-value \\='enable-multibyte-characters). */); DEFVAR_BUFFER_DEFAULTS ("default-buffer-file-coding-system", buffer_file_coding_system, doc: /* Default value of `buffer-file-coding-system' for buffers not overriding it. -This is the same as (default-value 'buffer-file-coding-system). */); +This is the same as (default-value \\='buffer-file-coding-system). */); DEFVAR_BUFFER_DEFAULTS ("default-truncate-lines", truncate_lines, doc: /* Default value of `truncate-lines' for buffers that do not override it. -This is the same as (default-value 'truncate-lines). */); +This is the same as (default-value \\='truncate-lines). */); DEFVAR_BUFFER_DEFAULTS ("default-fill-column", fill_column, doc: /* Default value of `fill-column' for buffers that do not override it. -This is the same as (default-value 'fill-column). */); +This is the same as (default-value \\='fill-column). */); DEFVAR_BUFFER_DEFAULTS ("default-left-margin", left_margin, doc: /* Default value of `left-margin' for buffers that do not override it. -This is the same as (default-value 'left-margin). */); +This is the same as (default-value \\='left-margin). */); DEFVAR_BUFFER_DEFAULTS ("default-tab-width", tab_width, doc: /* Default value of `tab-width' for buffers that do not override it. NOTE: This controls the display width of a TAB character, and not the size of an indentation step. -This is the same as (default-value 'tab-width). */); +This is the same as (default-value \\='tab-width). */); DEFVAR_BUFFER_DEFAULTS ("default-case-fold-search", case_fold_search, doc: /* Default value of `case-fold-search' for buffers that don't override it. -This is the same as (default-value 'case-fold-search). */); +This is the same as (default-value \\='case-fold-search). */); DEFVAR_BUFFER_DEFAULTS ("default-left-margin-width", left_margin_cols, doc: /* Default value of `left-margin-width' for buffers that don't override it. -This is the same as (default-value 'left-margin-width). */); +This is the same as (default-value \\='left-margin-width). */); DEFVAR_BUFFER_DEFAULTS ("default-right-margin-width", right_margin_cols, doc: /* Default value of `right-margin-width' for buffers that don't override it. -This is the same as (default-value 'right-margin-width). */); +This is the same as (default-value \\='right-margin-width). */); DEFVAR_BUFFER_DEFAULTS ("default-left-fringe-width", left_fringe_width, doc: /* Default value of `left-fringe-width' for buffers that don't override it. -This is the same as (default-value 'left-fringe-width). */); +This is the same as (default-value \\='left-fringe-width). */); DEFVAR_BUFFER_DEFAULTS ("default-right-fringe-width", right_fringe_width, doc: /* Default value of `right-fringe-width' for buffers that don't override it. -This is the same as (default-value 'right-fringe-width). */); +This is the same as (default-value \\='right-fringe-width). */); DEFVAR_BUFFER_DEFAULTS ("default-fringes-outside-margins", fringes_outside_margins, doc: /* Default value of `fringes-outside-margins' for buffers that don't override it. -This is the same as (default-value 'fringes-outside-margins). */); +This is the same as (default-value \\='fringes-outside-margins). */); DEFVAR_BUFFER_DEFAULTS ("default-scroll-bar-width", scroll_bar_width, doc: /* Default value of `scroll-bar-width' for buffers that don't override it. -This is the same as (default-value 'scroll-bar-width). */); +This is the same as (default-value \\='scroll-bar-width). */); DEFVAR_BUFFER_DEFAULTS ("default-vertical-scroll-bar", vertical_scroll_bar_type, doc: /* Default value of `vertical-scroll-bar' for buffers that don't override it. -This is the same as (default-value 'vertical-scroll-bar). */); +This is the same as (default-value \\='vertical-scroll-bar). */); DEFVAR_BUFFER_DEFAULTS ("default-indicate-empty-lines", indicate_empty_lines, doc: /* Default value of `indicate-empty-lines' for buffers that don't override it. -This is the same as (default-value 'indicate-empty-lines). */); +This is the same as (default-value \\='indicate-empty-lines). */); DEFVAR_BUFFER_DEFAULTS ("default-indicate-buffer-boundaries", indicate_buffer_boundaries, doc: /* Default value of `indicate-buffer-boundaries' for buffers that don't override it. -This is the same as (default-value 'indicate-buffer-boundaries). */); +This is the same as (default-value \\='indicate-buffer-boundaries). */); DEFVAR_BUFFER_DEFAULTS ("default-fringe-indicator-alist", fringe_indicator_alist, doc: /* Default value of `fringe-indicator-alist' for buffers that don't override it. -This is the same as (default-value 'fringe-indicator-alist). */); +This is the same as (default-value \\='fringe-indicator-alist). */); DEFVAR_BUFFER_DEFAULTS ("default-fringe-cursor-alist", fringe_cursor_alist, doc: /* Default value of `fringe-cursor-alist' for buffers that don't override it. -This is the same as (default-value 'fringe-cursor-alist). */); +This is the same as (default-value \\='fringe-cursor-alist). */); DEFVAR_BUFFER_DEFAULTS ("default-scroll-up-aggressively", scroll_up_aggressively, doc: /* Default value of `scroll-up-aggressively'. This value applies in buffers that don't have their own local values. -This is the same as (default-value 'scroll-up-aggressively). */); +This is the same as (default-value \\='scroll-up-aggressively). */); DEFVAR_BUFFER_DEFAULTS ("default-scroll-down-aggressively", scroll_down_aggressively, doc: /* Default value of `scroll-down-aggressively'. This value applies in buffers that don't have their own local values. -This is the same as (default-value 'scroll-down-aggressively). */); +This is the same as (default-value \\='scroll-down-aggressively). */); DEFVAR_PER_BUFFER ("header-line-format", &BVAR (current_buffer, header_line_format), diff --git a/src/data.c b/src/data.c index 784d127f18a..88c5a309859 100644 --- a/src/data.c +++ b/src/data.c @@ -1668,7 +1668,7 @@ this function causes a local value to exist for this buffer, just as setting the variable would do. This function returns VARIABLE, and therefore - (set (make-local-variable 'VARIABLE) VALUE-EXP) + (set (make-local-variable \\='VARIABLE) VALUE-EXP) works. See also `make-variable-buffer-local'. diff --git a/src/dired.c b/src/dired.c index e70f136d0cc..97736673f5d 100644 --- a/src/dired.c +++ b/src/dired.c @@ -816,7 +816,7 @@ DEFUN ("file-attributes", Ffile_attributes, Sfile_attributes, 1, 2, 0, Value is nil if specified file cannot be opened. ID-FORMAT specifies the preferred format of attributes uid and gid (see -below) - valid values are 'string and 'integer. The latter is the +below) - valid values are `string' and `integer'. The latter is the default, but we plan to change that, so you should specify a non-nil value for ID-FORMAT if you use the returned uid or gid. diff --git a/src/editfns.c b/src/editfns.c index a85c9e79d4e..e7d5dd89e51 100644 --- a/src/editfns.c +++ b/src/editfns.c @@ -2156,7 +2156,7 @@ applied without consideration for daylight saving time. You can pass more than 7 arguments; then the first six arguments are used as SECOND through YEAR, and the *last* argument is used as ZONE. The intervening arguments are ignored. -This feature lets (apply 'encode-time (decode-time ...)) work. +This feature lets (apply \\='encode-time (decode-time ...)) work. Out-of-range values for SECOND, MINUTE, HOUR, DAY, or MONTH are allowed; for example, a DAY of 0 means the day preceding the given month. diff --git a/src/eval.c b/src/eval.c index 6fde7e30b7f..77d435acbe6 100644 --- a/src/eval.c +++ b/src/eval.c @@ -517,7 +517,7 @@ DEFUN ("quote", Fquote, Squote, 1, UNEVALLED, 0, Warning: `quote' does not construct its return value, but just returns the value that was pre-constructed by the Lisp reader (see info node `(elisp)Printed Representation'). -This means that '(a . b) is not identical to (cons 'a 'b): the former +This means that \\='(a . b) is not identical to (cons \\='a \\='b): the former does not cons. Quoting should be reserved for constants that will never be modified by side-effects, unless you like self-modifying code. See the common pitfall in info node `(elisp)Rearrangement' for an example @@ -2196,7 +2196,7 @@ eval_sub (Lisp_Object form) DEFUN ("apply", Fapply, Sapply, 1, MANY, 0, doc: /* Call FUNCTION with our remaining args, using our last arg as list of args. Then return the value FUNCTION returns. -Thus, (apply '+ 1 2 '(3 4)) returns 10. +Thus, (apply \\='+ 1 2 \\='(3 4)) returns 10. usage: (apply FUNCTION &rest ARGUMENTS) */) (ptrdiff_t nargs, Lisp_Object *args) { @@ -2557,7 +2557,7 @@ DEFUN ("functionp", Ffunctionp, Sfunctionp, 1, 1, 0, DEFUN ("funcall", Ffuncall, Sfuncall, 1, MANY, 0, doc: /* Call first argument as a function, passing remaining arguments to it. Return the value that function returns. -Thus, (funcall 'cons 'x 'y) returns (x . y). +Thus, (funcall \\='cons \\='x \\='y) returns (x . y). usage: (funcall FUNCTION &rest ARGUMENTS) */) (ptrdiff_t nargs, Lisp_Object *args) { diff --git a/src/fileio.c b/src/fileio.c index a36dfbcfa36..d4341f8fa59 100644 --- a/src/fileio.c +++ b/src/fileio.c @@ -5878,7 +5878,7 @@ the arguments that were passed to that primitive. For example, if you do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then HANDLER is called like this: - (funcall HANDLER 'file-exists-p FILENAME) + (funcall HANDLER \\='file-exists-p FILENAME) Note that HANDLER must be able to handle all I/O primitives; if it has nothing special to do for a primitive, it should reinvoke the diff --git a/src/fns.c b/src/fns.c index 26a98abc1a6..aa917ac6ec9 100644 --- a/src/fns.c +++ b/src/fns.c @@ -347,7 +347,7 @@ This function obeys the conventions for collation order in your locale settings. For example, punctuation and whitespace characters might be considered less significant for sorting: -\(sort '\("11" "12" "1 1" "1 2" "1.1" "1.2") 'string-collate-lessp) +\(sort '\("11" "12" "1 1" "1 2" "1.1" "1.2") \\='string-collate-lessp) => \("11" "1 1" "1.1" "12" "1 2" "1.2") The optional argument LOCALE, a string, overrides the setting of your @@ -1083,7 +1083,7 @@ multibyte character of charset `eight-bit'. See also `string-to-multibyte'. Beware, this often doesn't really do what you think it does. -It is similar to (decode-coding-string STRING 'utf-8-emacs). +It is similar to (decode-coding-string STRING \\='utf-8-emacs). If you're not sure, whether to use `string-as-multibyte' or `string-to-multibyte', use `string-to-multibyte'. */) (Lisp_Object string) diff --git a/src/frame.c b/src/frame.c index d3e478075c3..6debcb8e7bc 100644 --- a/src/frame.c +++ b/src/frame.c @@ -976,7 +976,7 @@ except when you want to create a new frame on another terminal. In that case, the `tty' parameter specifies the device file to open, and the `tty-type' parameter specifies the terminal type. Example: - (make-terminal-frame '((tty . "/dev/pts/5") (tty-type . "xterm"))) + (make-terminal-frame \\='((tty . "/dev/pts/5") (tty-type . "xterm"))) Note that changing the size of one terminal frame automatically affects all frames on the same terminal device. */) @@ -5018,7 +5018,7 @@ You can also use a floating number between 0.0 and 1.0. */); DEFVAR_LISP ("default-frame-alist", Vdefault_frame_alist, doc: /* Alist of default values for frame creation. These may be set in your init file, like this: - (setq default-frame-alist '((width . 80) (height . 55) (menu-bar-lines . 1))) + (setq default-frame-alist \\='((width . 80) (height . 55) (menu-bar-lines . 1))) These override values given in window system configuration data, including X Windows' defaults database. For values specific to the first Emacs frame, see `initial-frame-alist'. @@ -5176,7 +5176,7 @@ width by the width of one scroll bar provided this option is nil and keep it unchanged if this option is either t or a list containing `vertical-scroll-bars'. -The default value is '(tool-bar-lines) on Lucid, Motif and Windows +The default value is \\='(tool-bar-lines) on Lucid, Motif and Windows \(which means that adding/removing a tool bar does not change the frame height), nil on all other window systems including GTK+ (which means that changing any of the parameters listed above may change the size of diff --git a/src/image.c b/src/image.c index 743d230ed3b..85cf801f6a9 100644 --- a/src/image.c +++ b/src/image.c @@ -9752,7 +9752,7 @@ syms_of_image (void) defining the supported image types. */ DEFVAR_LISP ("image-types", Vimage_types, doc: /* List of potentially supported image types. -Each element of the list is a symbol for an image type, like 'jpeg or 'png. +Each element of the list is a symbol for an image type, like `jpeg' or `png'. To check whether it is really supported, use `image-type-available-p'. */); Vimage_types = Qnil; diff --git a/src/keyboard.c b/src/keyboard.c index dab32b12826..d7a533b80b7 100644 --- a/src/keyboard.c +++ b/src/keyboard.c @@ -754,7 +754,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 diff --git a/src/print.c b/src/print.c index d3b1a927b22..94f3fcd7db1 100644 --- a/src/print.c +++ b/src/print.c @@ -2212,7 +2212,7 @@ This affects only `prin1'. */); DEFVAR_BOOL ("print-quoted", print_quoted, doc: /* Non-nil means print quoted forms with reader syntax. -I.e., (quote foo) prints as 'foo, (function foo) as #'foo. */); +I.e., (quote foo) prints as \\='foo, (function foo) as #\\='foo. */); print_quoted = 0; DEFVAR_LISP ("print-gensym", Vprint_gensym, diff --git a/src/process.c b/src/process.c index 17e9187aa65..1ab83780914 100644 --- a/src/process.c +++ b/src/process.c @@ -2685,7 +2685,7 @@ Examples: \(serial-process-configure :process "/dev/ttyS0" :speed 1200) \(serial-process-configure - :buffer "COM1" :stopbits 1 :parity 'odd :flowcontrol 'hw) + :buffer "COM1" :stopbits 1 :parity \\='odd :flowcontrol \\='hw) \(serial-process-configure :port "\\\\.\\COM13" :bytesize 7) @@ -2785,7 +2785,7 @@ Examples: \(make-serial-process :port "COM1" :speed 115200 :stopbits 2) -\(make-serial-process :port "\\\\.\\COM13" :speed 1200 :bytesize 7 :parity 'odd) +\(make-serial-process :port "\\\\.\\COM13" :speed 1200 :bytesize 7 :parity \\='odd) \(make-serial-process :port "/dev/tty.BlueConsole-SPP-1" :speed nil) diff --git a/src/w32fns.c b/src/w32fns.c index f279fb86c2f..d8e22e2aa9c 100644 --- a/src/w32fns.c +++ b/src/w32fns.c @@ -5782,8 +5782,8 @@ Internal use only, use `display-monitor-attributes-list' instead. */) DEFUN ("set-message-beep", Fset_message_beep, Sset_message_beep, 1, 1, 0, doc: /* Set the sound generated when the bell is rung. -SOUND is 'asterisk, 'exclamation, 'hand, 'question, 'ok, or 'silent -to use the corresponding system sound for the bell. The 'silent sound +SOUND is `asterisk', `exclamation', `hand', `question', `ok', or `silent' +to use the corresponding system sound for the bell. The `silent' sound prevents Emacs from making any sound at all. SOUND is nil to use the normal beep. */) (Lisp_Object sound) diff --git a/src/xfaces.c b/src/xfaces.c index 556f361c10d..d89adca8c57 100644 --- a/src/xfaces.c +++ b/src/xfaces.c @@ -6506,8 +6506,8 @@ If this variable is made buffer-local, the face remapping takes effect only in that buffer. For instance, the mode my-mode could define a face `my-mode-default', and then in the mode setup function, do: - (set (make-local-variable 'face-remapping-alist) - '((default my-mode-default)))). + (set (make-local-variable \\='face-remapping-alist) + \\='((default my-mode-default)))). Because Emacs normally only redraws screen areas when the underlying buffer contents change, you may need to call `redraw-display' after -- 2.39.2