From 2ea2a2f1a5b5b2e1b20f1ee8c86058334d0a2652 Mon Sep 17 00:00:00 2001 From: Paul Eggert Date: Tue, 3 May 2016 08:02:16 -0700 Subject: Doc fixes for quoting * doc/emacs/text.texi, doc/lispintro/emacs-lisp-intro.texi: * doc/lispref/control.texi, doc/lispref/display.texi: * doc/lispref/help.texi, doc/lispref/strings.texi, lisp/subr.el: * src/callint.c, src/doprnt.c, src/editfns.c: Document quoting a bit more systematically. Problem reported by Alan Mackenzie (Bug#23425). --- src/callint.c | 2 +- src/doprnt.c | 6 +++--- src/editfns.c | 13 ++++++++----- 3 files changed, 12 insertions(+), 9 deletions(-) (limited to 'src') diff --git a/src/callint.c b/src/callint.c index e56f7cd1b84..053ee6cdaa5 100644 --- a/src/callint.c +++ b/src/callint.c @@ -272,7 +272,7 @@ invoke it. If KEYS is omitted or nil, the return value of { /* `args' will contain the array of arguments to pass to the function. `visargs' will contain the same list but in a nicer form, so that if we - pass it to `Fformat' it will be understandable to a human. */ + pass it to `Fformat_message' it will be understandable to a human. */ Lisp_Object *args, *visargs; Lisp_Object specs; Lisp_Object filter_specs; diff --git a/src/doprnt.c b/src/doprnt.c index 506bbc3df35..9d8b783565f 100644 --- a/src/doprnt.c +++ b/src/doprnt.c @@ -46,15 +46,15 @@ along with GNU Emacs. If not, see . */ ignored %s and %c conversions. (See below for the detailed documentation of what is supported.) However, this is okay, as this function is supposed to be called from `error' and similar functions, and thus does not need to - support features beyond those in `Fformat', which is used by `error' on the - Lisp level. */ + support features beyond those in `Fformat_message', which is used + by `error' on the Lisp level. */ /* In the FORMAT argument this function supports ` and ' as directives that output left and right quotes as per ‘text-quoting style’. It also supports the following %-sequences: %s means print a string argument. - %S is silently treated as %s, for loose compatibility with `Fformat'. + %S is treated as %s, for loose compatibility with `Fformat_message'. %d means print a `signed int' argument in decimal. %o means print an `unsigned int' argument in octal. %x means print an `unsigned int' argument in hex. diff --git a/src/editfns.c b/src/editfns.c index f0ce4e7cf34..a858e6e79dd 100644 --- a/src/editfns.c +++ b/src/editfns.c @@ -3665,10 +3665,11 @@ In batch mode, the message is printed to the standard error stream, followed by a newline. The first argument is a format control string, and the rest are data -to be formatted under control of the string. See `format' for details. +to be formatted under control of the string. See `format-message' for +details. -Note: Use (message "%s" VALUE) to print the value of expressions and -variables to avoid accidentally interpreting `%' as format specifiers. +Note: (message "%s" VALUE) displays the string VALUE without +interpreting format characters like `%', `\\=`', and `\\=''. If the first argument is nil or the empty string, the function clears any existing message; this lets the minibuffer contents show. See @@ -3696,7 +3697,8 @@ DEFUN ("message-box", Fmessage_box, Smessage_box, 1, MANY, 0, doc: /* Display a message, in a dialog box if possible. If a dialog box is not available, use the echo area. The first argument is a format control string, and the rest are data -to be formatted under control of the string. See `format' for details. +to be formatted under control of the string. See `format-message' for +details. If the first argument is nil or the empty string, clear any existing message; let the minibuffer contents show. @@ -3727,7 +3729,8 @@ If this command was invoked with the mouse, use a dialog box if `use-dialog-box' is non-nil. Otherwise, use the echo area. The first argument is a format control string, and the rest are data -to be formatted under control of the string. See `format' for details. +to be formatted under control of the string. See `format-message' for +details. If the first argument is nil or the empty string, clear any existing message; let the minibuffer contents show. -- cgit v1.3 From 50650cb6887d99b01eeb1e686fc1f695c2a0c64a Mon Sep 17 00:00:00 2001 From: Paul Eggert Date: Thu, 5 May 2016 12:48:33 -0700 Subject: Doc fixes for fclist and grep A newline is needed between two fc-list calls. egrep and fgrep have been withdrawn from POSIX, so document grep -E and grep -F instead. --- doc/emacs/frames.texi | 5 +++-- etc/PROBLEMS | 2 +- lisp/cedet/cedet-cscope.el | 2 +- lisp/cedet/semantic/symref.el | 2 +- lisp/man.el | 2 +- src/bidi.c | 4 ++-- 6 files changed, 9 insertions(+), 8 deletions(-) (limited to 'src') diff --git a/doc/emacs/frames.texi b/doc/emacs/frames.texi index 23ccd6a8f41..a7e709f9221 100644 --- a/doc/emacs/frames.texi +++ b/doc/emacs/frames.texi @@ -764,7 +764,8 @@ Fontconfig fonts, you can use the @command{fc-list} command to list the available fixed-width fonts, like this: @example -fc-list :spacing=mono fc-list :spacing=charcell +fc-list :spacing=mono +fc-list :spacing=charcell @end example @noindent @@ -772,7 +773,7 @@ For server-side X fonts, you can use the @command{xlsfonts} program to list the available fixed-width fonts, like this: @example -xlsfonts -fn '*x*' | egrep "^[0-9]+x[0-9]+" +xlsfonts -fn '*x*' | grep -E '^[0-9]+x[0-9]+' xlsfonts -fn '*-*-*-*-*-*-*-*-*-*-*-m*' xlsfonts -fn '*-*-*-*-*-*-*-*-*-*-*-c*' @end example diff --git a/etc/PROBLEMS b/etc/PROBLEMS index be9400bf264..533c4e9be8d 100644 --- a/etc/PROBLEMS +++ b/etc/PROBLEMS @@ -1655,7 +1655,7 @@ which combination produces "M-x" in the echo area. You can also use the 'xmodmap' utility to show all the keys which produce a Meta modifier: - xmodmap -pk | egrep -i "meta|alt" + xmodmap -pk | grep -Ei "meta|alt" A more convenient way of finding out which keys produce a Meta modifier is to use the 'xkbprint' utility, if it's available on your system: diff --git a/lisp/cedet/cedet-cscope.el b/lisp/cedet/cedet-cscope.el index 9a54d341f56..373149c16e3 100644 --- a/lisp/cedet/cedet-cscope.el +++ b/lisp/cedet/cedet-cscope.el @@ -52,7 +52,7 @@ SCOPE is the scope of the search, such as 'project or 'subdirs." ;; -0 = Find C symbol ;; -1 = Find global definition ;; -3 = Find references - ;; -6 = Find egrep pattern + ;; -6 = Find grep -E pattern ;; -7 = Find file (let ((idx (cond ((eq type 'file) "-7") diff --git a/lisp/cedet/semantic/symref.el b/lisp/cedet/semantic/symref.el index 088740b2624..516a4f30414 100644 --- a/lisp/cedet/semantic/symref.el +++ b/lisp/cedet/semantic/symref.el @@ -266,7 +266,7 @@ Returns an object of class `semantic-symref-result'." ;;;###autoload (defun semantic-symref-find-text (text &optional scope) "Find a list of occurrences of TEXT in the current project. -TEXT is a regexp formatted for use with egrep. +TEXT is a regexp formatted for use with grep -E. Optional SCOPE specifies which file set to search. Defaults to `project'. Refers to `semantic-symref-tool', to determine the reference tool to use for the current buffer. diff --git a/lisp/man.el b/lisp/man.el index 2b2ee99a9be..5acf90baf28 100644 --- a/lisp/man.el +++ b/lisp/man.el @@ -964,7 +964,7 @@ otherwise look like a page name. An \"apropos\" query with -k gives a buffer of matching page names or descriptions. The pattern argument is usually an -\"egrep\" style regexp. +\"grep -E\" style regexp. -k pattern" diff --git a/src/bidi.c b/src/bidi.c index c23ff954356..573e513469d 100644 --- a/src/bidi.c +++ b/src/bidi.c @@ -2498,10 +2498,10 @@ typedef struct bpa_stack_entry { And finally, cross-reference these two: - fgrep -w -f brackets.txt decompositions.txt + grep -Fw -f brackets.txt decompositions.txt where "decompositions.txt" was produced by the 1st script, and - "brackets.txt" by the 2nd script. In the output of fgrep, look + "brackets.txt" by the 2nd script. In the output of grep, look only for decompositions that don't begin with some compatibility formatting tag, such as "". Only decompositions that consist solely of character codepoints are relevant to bidi -- cgit v1.3