]> git.eshelyaron.com Git - emacs.git/commitdiff
Merge from origin/emacs-28
authorStefan Kangas <stefankangas@gmail.com>
Fri, 28 Oct 2022 19:51:44 +0000 (21:51 +0200)
committerStefan Kangas <stefankangas@gmail.com>
Fri, 28 Oct 2022 19:51:44 +0000 (21:51 +0200)
510020d30d ; Improve doc strings in whitespace.el

# Conflicts:
# lisp/whitespace.el

1  2 
lisp/whitespace.el

index d7b83ef34a5042d131275a69fb0eead727601aad,e518f1e00ab02f7acfac94c2592ec11d75bf1baf..4238461b7e161e4c68233123fa18694a8dda60c1
      indentation empty space-after-tab
      space-mark tab-mark newline-mark
      missing-newline-at-eof)
-   "Specify which kind of blank is visualized.
+   "Determine the kinds of whitespace are visualized.
  
It's a list containing some or all of the following values:
The value is a list containing one or more of the following symbols:
  
-    face                 enable all visualization via faces (see below).
+    face                 visualize by using faces (see below).
  
-    trailing             trailing blanks are visualized via faces.
-                         It has effect only if `face' (see above)
+    trailing             visualize trailing blanks via faces.
+                         This has effect only if `face' (see above)
                          is present in `whitespace-style'.
  
-    tabs                 TABs are visualized via faces.
-                         It has effect only if `face' (see above)
+    tabs                 visualize TABs via faces.
+                         This has effect only if `face' (see above)
                          is present in `whitespace-style'.
  
-    spaces               SPACEs and HARD SPACEs are visualized via
+    spaces               visualize SPACEs and HARD SPACEs via
                          faces.
-                         It has effect only if `face' (see above)
+                         This has effect only if `face' (see above)
                          is present in `whitespace-style'.
  
-    lines                lines which have columns beyond
-                         `whitespace-line-column' are highlighted via
-                         faces.
+    lines                highlight lines which have columns beyond
+                         `whitespace-line-column' via faces.
                          Whole line is highlighted.
-                         It has precedence over `lines-tail' and
 -                        This has precedence over `lines-tail' (see
 -                        below).
++                        This has precedence over `lines-tail' and
 +                        `lines-char' (see below).
-                         It has effect only if `face' (see above)
+                         This has effect only if `face' (see above)
                          is present in `whitespace-style'.
  
-    lines-tail           lines which have columns beyond
-                         `whitespace-line-column' are highlighted via
-                         faces.
-                         But only the part of line which goes
-                         beyond `whitespace-line-column' column.
-                         It has effect only if `lines' (see above)
-                         is not present in `whitespace-style'
-                         and if `face' (see above) is present in
+    lines-tail           highlighted lines which have columns beyond
+                         `whitespace-line-column' via faces.
+                         Only the part of line which goes beyond
+                         `whitespace-line-column' column.
+                         This has effect only if `lines' (see above)
+                         is NOT present in `whitespace-style',
+                         and if `face' (see above) IS present in
                          `whitespace-style'.
  
-    newline              NEWLINEs are visualized via faces.
-                         It has effect only if `face' (see above)
 +   lines-char           lines which have columns beyond
 +                        `whitespace-line-column' are highlighted via
 +                        putting a face on the first character that goes
 +                        beyond the `whitespace-line-column' column.
 +                        It has effect only if `lines' or
 +                        `lines-tail' (see above) is not present
 +                        in `whitespace-style' and if `face' (see
 +                        above) is present in `whitespace-style'.
 +
+    newline              visualize NEWLINEs via faces.
+                         This has effect only if `face' (see above)
                          is present in `whitespace-style'.
  
-    missing-newline-at-eof Missing newline at the end of the file is
-                         visualized via faces.
-                         It has effect only if `face' (see above)
+    missing-newline-at-eof visualize missing newline at the end of
+                         the file via faces.
+                         This has effect only if `face' (see above)
                          is present in `whitespace-style'.
  
-    empty                empty lines at beginning and/or end of buffer
-                         are visualized via faces.
-                         It has effect only if `face' (see above)
+    empty                visualize empty lines at beginning and/or
+                         end of buffer via faces.
+                         This has effect only if `face' (see above)
                          is present in `whitespace-style'.
  
-    indentation::tab     `tab-width' or more SPACEs at beginning of line
-                         are visualized via faces.
-                         It has effect only if `face' (see above)
+    indentation::tab     visualize `tab-width' or more SPACEs at
+                         beginning of line via faces.
+                         This has effect only if `face' (see above)
                          is present in `whitespace-style'.
  
-    indentation::space   TABs at beginning of line are visualized via
+    indentation::space   visualize TABs at beginning of line via
                          faces.
-                         It has effect only if `face' (see above)
+                         This has effect only if `face' (see above)
                          is present in `whitespace-style'.
  
-    indentation          `tab-width' or more SPACEs at beginning of line
-                         are visualized, if `indent-tabs-mode' (which
-                         see) is non-nil; otherwise, TABs at beginning
-                         of line are visualized via faces.
-                         It has effect only if `face' (see above)
+    indentation          visualize `tab-width' or more SPACEs at
+                         beginning of line, if `indent-tabs-mode' (which
+                         see) is non-nil; otherwise, visualize TABs
+                         at beginning of line via faces.
+                         This has effect only if `face' (see above)
                          is present in `whitespace-style'.
  
-    big-indent           Big indentations are visualized via faces.
-                         It has effect only if `face' (see above)
+    big-indent           visualize big indentations via faces.
+                         This has effect only if `face' (see above)
                          is present in `whitespace-style'.
  
-    space-after-tab::tab         `tab-width' or more SPACEs after a TAB
-                                 are visualized via faces.
-                                 It has effect only if `face' (see above)
+    space-after-tab::tab         visualize `tab-width' or more SPACEs
+                                 after a TAB via faces.
+                                 This has effect only if `face' (see above)
                                  is present in `whitespace-style'.
  
-    space-after-tab::space       TABs are visualized when `tab-width' or
+    space-after-tab::space       visualize TABs when `tab-width' or
                                  more SPACEs occur after a TAB, via
                                  faces.
-                                 It has effect only if `face' (see above)
+                                 This has effect only if `face' (see above)
                                  is present in `whitespace-style'.
  
-    space-after-tab              `tab-width' or more SPACEs after a TAB
-                                 are visualized, if `indent-tabs-mode'
+    space-after-tab              visualize `tab-width' or more SPACEs
+                                 after a TAB, if `indent-tabs-mode'
                                  (which see) is non-nil; otherwise,
-                                 the TABs are visualized via faces.
-                                 It has effect only if `face' (see above)
+                                 visualize the TABs via faces.
+                                 This has effect only if `face' (see above)
                                  is present in `whitespace-style'.
  
-    space-before-tab::tab        SPACEs before TAB are visualized via
-                                 faces.
-                                 It has effect only if `face' (see above)
+    space-before-tab::tab        visualize SPACEs before TAB via faces.
+                                 This has effect only if `face' (see above)
                                  is present in `whitespace-style'.
  
-    space-before-tab::space      TABs are visualized when SPACEs occur
+    space-before-tab::space      visualize TABs when SPACEs occur
                                  before TAB, via faces.
-                                 It has effect only if `face' (see above)
+                                 This has effect only if `face' (see above)
                                  is present in `whitespace-style'.
  
-    space-before-tab             SPACEs before TAB are visualized, if
+    space-before-tab             visualize SPACEs before TAB, if
                                  `indent-tabs-mode' (which see) is
-                                 non-nil; otherwise, the TABs are
-                                 visualized via faces.
-                                 It has effect only if `face' (see above)
+                                 non-nil; otherwise, visualize TABs
+                                 via faces.
+                                 This has effect only if `face' (see above)
                                  is present in `whitespace-style'.
  
-    space-mark           SPACEs and HARD SPACEs are visualized via
+    space-mark           visualize SPACEs and HARD SPACEs via
                          display table.
  
-    tab-mark             TABs are visualized via display table.
+    tab-mark             visualize TABs via display table.
  
-    newline-mark         NEWLINEs are visualized via display table.
+    newline-mark         visualize NEWLINEs via display table.
  
  Any other value is ignored.
  
@@@ -730,10 -745,11 +755,11 @@@ This variable is used when `whitespace-
    :group 'whitespace)
  
  
 -(defcustom whitespace-empty-at-bob-regexp "\\`\\(\\([ \t]*\n\\)+\\)"
 +(defcustom whitespace-empty-at-bob-regexp "\\`\\([ \t\n]*\\(?:\n\\|$\\)\\)"
-   "Specify regexp for empty lines at beginning of buffer.
+   "Regexp to match empty lines at beginning of buffer that should be visualized.
  
- Used when `whitespace-style' includes `empty'."
+ The empty lines are highlighted using the `whitespace-empty' face.
+ This variable is used when `whitespace-style' includes `empty'."
    :type '(regexp :tag "Empty Lines At Beginning Of Buffer")
    :group 'whitespace)
  
@@@ -777,13 -800,16 +810,16 @@@ This variable is used when `whitespace-
  
  
  (defcustom whitespace-line-column 80
-   "Specify column beyond which the line is highlighted.
+   "Column beyond which the line is highlighted.
+ The value must be an integer or nil.  If nil, use the value
+ of the `fill-column' variable.
  
- It must be an integer or nil.  If nil, the `fill-column' variable value is
used.
+ The characters beyond the column specified by this variable are
highlighted using the `whitespace-line' face.
  
- Used when `whitespace-style' includes `lines', `lines-tail' or
- `lines-char'."
 -This varioable is used when `whitespace-style' includes `lines'
 -or `lines-tail' or `lines-char'."
++This variable is used when `whitespace-style' includes `lines',
++`lines-tail' or `lines-char'."
    :type '(choice :tag "Line Length Limit"
                 (integer :tag "Line Length")
                 (const :tag "Use fill-column" nil))