procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

; * lisp/so-long.el: Documentation

Browse source
This commit is contained in:
Phil Sainty 2020-08-04 04:29:56 +12:00
parent fa20e443c8
commit 5578febcd4
1 changed files with 10 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

17
lisp/so-long.el
View file

@ -255,8 +255,7 @@
;; `so-long-mode', completely bypassing the automated decision process. ;; `so-long-mode', completely bypassing the automated decision process.
;; Refer to M-: (info "(emacs) Specifying File Variables") RET ;; Refer to M-: (info "(emacs) Specifying File Variables") RET
;; ;;
;; If so-long itself is causing problems, it can be inhibited by setting the ;; If so-long itself causes problems, disable the automated behaviour with
;; `so-long-enabled' variable to nil, or by disabling the global mode with
;; M-- M-x global-so-long-mode, or M-: (global-so-long-mode 0) ;; M-- M-x global-so-long-mode, or M-: (global-so-long-mode 0)
;; * Example configuration ;; * Example configuration
@ -413,7 +412,6 @@
;; - Added mode-line indicator, user option `so-long-mode-line-label', ;; - Added mode-line indicator, user option `so-long-mode-line-label',
;; and faces `so-long-mode-line-active', `so-long-mode-line-inactive'. ;; and faces `so-long-mode-line-active', `so-long-mode-line-inactive'.
;; - New help commands `so-long-commentary' and `so-long-customize'. ;; - New help commands `so-long-commentary' and `so-long-customize'.
;; - Renamed `so-long-mode-enabled' to `so-long-enabled'.
;; - Refactored the default hook values using variable overrides ;; - Refactored the default hook values using variable overrides
;; (and returning all the hooks to nil default values). ;; (and returning all the hooks to nil default values).
;; - Performance improvements for `so-long-detected-long-line-p'. ;; - Performance improvements for `so-long-detected-long-line-p'.
@ -453,9 +451,14 @@
(declare-function longlines-mode "longlines") (declare-function longlines-mode "longlines")
(defvar longlines-mode) (defvar longlines-mode)
(defvar so-long-enabled nil (defvar so-long-enabled nil
"Set to nil to prevent `so-long' from being triggered automatically. ;; This was initially a renaming of the old `so-long-mode-enabled' and
;; documented as "Set to nil to prevent `so-long' from being triggered
Has no effect if `global-so-long-mode' is not enabled.") ;; automatically."; however `so-long--ensure-enabled' may forcibly re-enable
;; it contrary to the user's expectations, so for the present this should be
;; considered internal-use only (with `global-so-long-mode' the interface
;; for enabling or disabling the automated behaviour). FIXME: Establish a
;; way to support the original use-case, or rename to `so-long--enabled'.
"Internal use. Non-nil when any so-long functionality has been used.")
(defvar-local so-long--active nil ; internal use (defvar-local so-long--active nil ; internal use
"Non-nil when `so-long' mitigations are in effect.") "Non-nil when `so-long' mitigations are in effect.")
@ -1920,7 +1923,7 @@ If it appears in `%s', you should remove it."
; LocalWords: defadvice nadvice whitespace ie bos eos eobp origmode un Un setq ; LocalWords: defadvice nadvice whitespace ie bos eos eobp origmode un Un setq
; LocalWords: docstring auf Wiedersehen longlines alist autoload Refactored Inc ; LocalWords: docstring auf Wiedersehen longlines alist autoload Refactored Inc
; LocalWords: MERCHANTABILITY RET REGEXP VAR ELPA WS mitigations EmacsWiki eval ; LocalWords: MERCHANTABILITY RET REGEXP VAR ELPA WS mitigations EmacsWiki eval
; LocalWords: rx filename filenames js defun bidi bpa prog ; LocalWords: rx filename filenames js defun bidi bpa prog FIXME
;; So long, farewell, auf Wiedersehen, goodbye ;; So long, farewell, auf Wiedersehen, goodbye
;; You have to go, this code is minified ;; You have to go, this code is minified