diff --git a/doc/org-manual.org b/doc/org-manual.org index 623a66124..d5c2a864a 100644 --- a/doc/org-manual.org +++ b/doc/org-manual.org @@ -3602,7 +3602,7 @@ the link. Such a function will be called with the tag as the only argument. With the above setting, you could link to a specific bug with -=[[bugzilla:129]]=, search the web for =OrgMode= with =[[google:OrgMode]]=, +=[[bugzilla:129]]=, search the web for =OrgMode= with =[[duckduckgo:OrgMode]]=, show the map location of the Free Software Foundation =[[gmap:51 Franklin Street, Boston]]= or of Carsten office =[[omap:Science Park 904, Amsterdam, The Netherlands]]= and find out what the Org author is doing @@ -3614,7 +3614,7 @@ can define them in the file with #+cindex: @samp{LINK}, keyword #+begin_example ,#+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id= -,#+LINK: google http://www.google.com/search?q=%s +,#+LINK: duckduckgo https://duckduckgo.com/?q=%s #+end_example In-buffer completion (see [[*Completion]]) can be used after =[= to diff --git a/lisp/ob-R.el b/lisp/ob-R.el index 981f21119..c4dba88dc 100644 --- a/lisp/ob-R.el +++ b/lisp/ob-R.el @@ -362,7 +362,7 @@ Each member of this list is a list with three members: ) } }(object=%s,transfer.file=\"%s\")" - "A template for an R command to evaluate a block of code and write the result to a file. + "Template for an R command to evaluate a block of code and write result to file. Has four %s escapes to be filled in: 1. Row names, \"TRUE\" or \"FALSE\" diff --git a/lisp/ob-comint.el b/lisp/ob-comint.el index 18d4f3c93..b14849df6 100644 --- a/lisp/ob-comint.el +++ b/lisp/ob-comint.el @@ -44,7 +44,7 @@ BUFFER is checked with `org-babel-comint-buffer-livep'. BODY is executed inside the protection of `save-excursion' and `save-match-data'." - (declare (indent 1)) + (declare (indent 1) (debug t)) `(progn (unless (org-babel-comint-buffer-livep ,buffer) (error "Buffer %s does not exist or has no process" ,buffer)) @@ -53,7 +53,6 @@ executed inside the protection of `save-excursion' and (save-excursion (let ((comint-input-filter (lambda (_input) nil))) ,@body)))))) -(def-edebug-spec org-babel-comint-in-buffer (form body)) (defmacro org-babel-comint-with-output (meta &rest body) "Evaluate BODY in BUFFER and return process output. @@ -67,7 +66,7 @@ elements are optional. This macro ensures that the filter is removed in case of an error or user `keyboard-quit' during execution of body." - (declare (indent 1)) + (declare (indent 1) (debug (sexp body))) (let ((buffer (nth 0 meta)) (eoe-indicator (nth 1 meta)) (remove-echo (nth 2 meta)) @@ -112,7 +111,6 @@ or user `keyboard-quit' during execution of body." string-buffer)) (setq string-buffer (substring string-buffer (match-end 0)))) (split-string string-buffer comint-prompt-regexp))))) -(def-edebug-spec org-babel-comint-with-output (sexp body)) (defun org-babel-comint-input-command (buffer cmd) "Pass CMD to BUFFER. diff --git a/lisp/ob-core.el b/lisp/ob-core.el index 421828c51..2e78ac3e6 100644 --- a/lisp/ob-core.el +++ b/lisp/ob-core.el @@ -1107,7 +1107,7 @@ end-header-args -- point at the end of the header-args body ------------- string holding the body of the code block beg-body --------- point at the beginning of the body end-body --------- point at the end of the body" - (declare (indent 1)) + (declare (indent 1) (debug t)) (let ((tempvar (make-symbol "file"))) `(let* ((case-fold-search t) (,tempvar ,file) @@ -1146,7 +1146,6 @@ end-body --------- point at the end of the body" (goto-char end-block))))) (unless visited-p (kill-buffer to-be-removed)) (goto-char point)))) -(def-edebug-spec org-babel-map-src-blocks (form body)) ;;;###autoload (defmacro org-babel-map-inline-src-blocks (file &rest body) @@ -1361,7 +1360,7 @@ the `org-mode-hook'." (goto-char (match-beginning 0)) (org-babel-hide-hash) (goto-char (match-end 0)))))) -(add-hook 'org-mode-hook 'org-babel-hide-all-hashes) +(add-hook 'org-mode-hook #'org-babel-hide-all-hashes) (defun org-babel-hash-at-point (&optional point) "Return the value of the hash at POINT. @@ -1379,7 +1378,7 @@ This can be called with `\\[org-ctrl-c-ctrl-c]'." Add `org-babel-hide-result' as an invisibility spec for hiding portions of results lines." (add-to-invisibility-spec '(org-babel-hide-result . t))) -(add-hook 'org-mode-hook 'org-babel-result-hide-spec) +(add-hook 'org-mode-hook #'org-babel-result-hide-spec) (defvar org-babel-hide-result-overlays nil "Overlays hiding results.") @@ -1450,11 +1449,11 @@ portions of results lines." (push ov org-babel-hide-result-overlays))))) ;; org-tab-after-check-for-cycling-hook -(add-hook 'org-tab-first-hook 'org-babel-hide-result-toggle-maybe) +(add-hook 'org-tab-first-hook #'org-babel-hide-result-toggle-maybe) ;; Remove overlays when changing major mode (add-hook 'org-mode-hook (lambda () (add-hook 'change-major-mode-hook - 'org-babel-show-result-all 'append 'local))) + #'org-babel-show-result-all 'append 'local))) (defun org-babel-params-from-properties (&optional lang no-eval) "Retrieve source block parameters specified as properties. @@ -3001,7 +3000,7 @@ situations in which is it not appropriate." "If STRING represents a number return its value. Otherwise return nil." (unless (or (string-match-p "\\s-" (org-trim string)) - (not (string-match-p "^[0-9-e.+ ]+$" string))) + (not (string-match-p "^[0-9e.+ -]+$" string))) (let ((interned-string (ignore-errors (read string)))) (when (numberp interned-string) interned-string)))) @@ -3081,8 +3080,7 @@ Emacs shutdown.")) (defmacro org-babel-result-cond (result-params scalar-form &rest table-forms) "Call the code to parse raw string results according to RESULT-PARAMS." - (declare (indent 1) - (debug (form form &rest form))) + (declare (indent 1) (debug t)) (org-with-gensyms (params) `(let ((,params ,result-params)) (unless (member "none" ,params) @@ -3141,7 +3139,7 @@ of `org-babel-temporary-directory'." org-babel-temporary-directory "[directory not defined]")))))) -(add-hook 'kill-emacs-hook 'org-babel-remove-temporary-directory) +(add-hook 'kill-emacs-hook #'org-babel-remove-temporary-directory) (defun org-babel-one-header-arg-safe-p (pair safe-list) "Determine if the PAIR is a safe babel header arg according to SAFE-LIST. diff --git a/lisp/ob-sql.el b/lisp/ob-sql.el index b9dd72bf0..68d5ddd0a 100644 --- a/lisp/ob-sql.el +++ b/lisp/ob-sql.el @@ -164,7 +164,8 @@ SQL Server on Windows and Linux platform." " ")) (defun org-babel-sql-dbstring-vertica (host port user password database) - "Make Vertica command line args for database connection. Pass nil to omit that arg." + "Make Vertica command line args for database connection. +Pass nil to omit that arg." (mapconcat #'identity (delq nil (list (when host (format "-h %s" host)) diff --git a/lisp/ob-tangle.el b/lisp/ob-tangle.el index 3c3943c8f..aa0373ab8 100644 --- a/lisp/ob-tangle.el +++ b/lisp/ob-tangle.el @@ -150,7 +150,7 @@ represented in the file." "Open FILE into a temporary buffer execute BODY there like `progn', then kill the FILE buffer returning the result of evaluating BODY." - (declare (indent 1)) + (declare (indent 1) (debug t)) (let ((temp-path (make-symbol "temp-path")) (temp-result (make-symbol "temp-result")) (temp-file (make-symbol "temp-file")) @@ -164,7 +164,6 @@ evaluating BODY." (setf ,temp-result (progn ,@body))) (unless ,visited-p (kill-buffer ,temp-file)) ,temp-result))) -(def-edebug-spec org-babel-with-temp-filebuffer (form body)) ;;;###autoload (defun org-babel-tangle-file (file &optional target-file lang-re) diff --git a/lisp/ol-bbdb.el b/lisp/ol-bbdb.el index 84537b123..01a1fe932 100644 --- a/lisp/ol-bbdb.el +++ b/lisp/ol-bbdb.el @@ -431,7 +431,7 @@ variable to be globally bound." ;;; to override the 7-day default. (defun org-bbdb-date-list (d n) - "Return a list of dates in (m d y) format from the given date D to n-1 days hence." + "Return list of dates in (m d y) format from the given date D to n-1 days hence." (let ((abs (calendar-absolute-from-gregorian d))) (mapcar (lambda (i) (calendar-gregorian-from-absolute (+ abs i))) (number-sequence 0 (1- n))))) diff --git a/lisp/ol-w3m.el b/lisp/ol-w3m.el index f1f3afd76..ebb11ce3d 100644 --- a/lisp/ol-w3m.el +++ b/lisp/ol-w3m.el @@ -7,13 +7,13 @@ ;; Homepage: https://orgmode.org ;; ;; This file is part of GNU Emacs. -;; -;; This program is free software: you can redistribute it and/or modify + +;; GNU Emacs is free software: you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by ;; the Free Software Foundation, either version 3 of the License, or ;; (at your option) any later version. -;; This program is distributed in the hope that it will be useful, +;; GNU Emacs is distributed in the hope that it will be useful, ;; but WITHOUT ANY WARRANTY; without even the implied warranty of ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ;; GNU General Public License for more details. diff --git a/lisp/ol.el b/lisp/ol.el index cf105786f..f8776eca1 100644 --- a/lisp/ol.el +++ b/lisp/ol.el @@ -381,9 +381,9 @@ changes to the current buffer." Shell links can be dangerous: just think about a link - [[shell:rm -rf ~/*][Google Search]] + [[shell:rm -rf ~/*][Web Search]] -This link would show up in your Org document as \"Google Search\", +This link would show up in your Org document as \"Web Search\", but really it would remove your entire home directory. Therefore we advise against setting this variable to nil. Just change it to `y-or-n-p' if you want to confirm with a @@ -406,9 +406,9 @@ single keystroke rather than having to type \"yes\"." "Non-nil means ask for confirmation before executing Emacs Lisp links. Elisp links can be dangerous: just think about a link - [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]] + [[elisp:(shell-command \"rm -rf ~/*\")][Web Search]] -This link would show up in your Org document as \"Google Search\", +This link would show up in your Org document as \"Web Search\", but really it would remove your entire home directory. Therefore we advise against setting this variable to nil. Just change it to `y-or-n-p' if you want to confirm with a diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el index dedf7e5bb..b9799d2ab 100644 --- a/lisp/org-agenda.el +++ b/lisp/org-agenda.el @@ -2090,6 +2090,7 @@ Note that functions in this alist don't need to be quoted." If STRING is non-nil, the text property will be fetched from position 0 in that string. If STRING is nil, it will be fetched from the beginning of the current line." + (declare (debug t)) (org-with-gensyms (marker) `(let ((,marker (get-text-property (if ,string 0 (point-at-bol)) 'org-hd-marker ,string))) @@ -2097,7 +2098,6 @@ of the current line." (save-excursion (goto-char ,marker) ,@body))))) -(def-edebug-spec org-agenda-with-point-at-orig-entry (form body)) (defun org-add-agenda-custom-command (entry) "Replace or add a command in `org-agenda-custom-commands'. @@ -7558,7 +7558,8 @@ With a prefix argument, do so in all agenda buffers." "Filter lines in the agenda buffer that have a specific category. The category is that of the current line. With a `\\[universal-argument]' prefix argument, exclude the lines of that category. -When there is already a category filter in place, this command removes the filter." +When there is already a category filter in place, this command removes the +filter." (interactive "P") (if (and org-agenda-filtered-by-category org-agenda-category-filter) @@ -7734,9 +7735,9 @@ the variable `org-agenda-auto-exclude-function'." (negate (equal strip-or-accumulate '(4))) (cf (mapconcat #'identity org-agenda-category-filter "")) (tf (mapconcat #'identity org-agenda-tag-filter "")) - (rpl-fn (lambda (c) (replace-regexp-in-string "^\+" "" (or (car c) "")))) - (ef (replace-regexp-in-string "^\+" "" (or (car org-agenda-effort-filter) ""))) - (rf (replace-regexp-in-string "^\+" "" (or (car org-agenda-regexp-filter) ""))) + (rpl-fn (lambda (c) (replace-regexp-in-string "^\\+" "" (or (car c) "")))) + (ef (replace-regexp-in-string "^\\+" "" (or (car org-agenda-effort-filter) ""))) + (rf (replace-regexp-in-string "^\\+" "" (or (car org-agenda-regexp-filter) ""))) (ff (concat cf tf ef (when (not (equal rf "")) (concat "/" rf "/")))) (f-string (completing-read (concat diff --git a/lisp/org-attach.el b/lisp/org-attach.el index 1d8c216f4..715fe3e93 100644 --- a/lisp/org-attach.el +++ b/lisp/org-attach.el @@ -184,7 +184,7 @@ attachment folders based on ID." :type '(repeat (function :tag "Function with ID as input"))) (defvar org-attach-after-change-hook nil - "Hook to be called when files have been added or removed to the attachment folder.") + "Hook called when files have been added or removed to the attachment folder.") (defvar org-attach-open-hook nil "Hook that is invoked by `org-attach-open'. diff --git a/lisp/org-clock.el b/lisp/org-clock.el index cfd112ec3..72f84f68c 100644 --- a/lisp/org-clock.el +++ b/lisp/org-clock.el @@ -911,17 +911,17 @@ If CLOCK-SOUND is non-nil, it overrides `org-clock-sound'." (defmacro org-with-clock-position (clock &rest forms) "Evaluate FORMS with CLOCK as the current active clock." + (declare (indent 1) (debug t)) `(with-current-buffer (marker-buffer (car ,clock)) (org-with-wide-buffer (goto-char (car ,clock)) (beginning-of-line) ,@forms))) -(def-edebug-spec org-with-clock-position (form body)) -(put 'org-with-clock-position 'lisp-indent-function 1) (defmacro org-with-clock (clock &rest forms) "Evaluate FORMS with CLOCK as the current active clock. This macro also protects the current active clock from being altered." + (declare (indent 1) (debug t)) `(org-with-clock-position ,clock (let ((org-clock-start-time (cdr ,clock)) (org-clock-total-time) @@ -932,8 +932,6 @@ This macro also protects the current active clock from being altered." (org-back-to-heading t) (point-marker)))) ,@forms))) -(def-edebug-spec org-with-clock (form body)) -(put 'org-with-clock 'lisp-indent-function 1) (defsubst org-clock-clock-in (clock &optional resume start-time) "Clock in to the clock located by CLOCK. diff --git a/lisp/org-ctags.el b/lisp/org-ctags.el index 8dc177df6..1fca873c1 100644 --- a/lisp/org-ctags.el +++ b/lisp/org-ctags.el @@ -165,7 +165,7 @@ See the ctags documentation for more information.") '(org-ctags-find-tag org-ctags-ask-rebuild-tags-file-then-find-tag org-ctags-ask-append-topic) - "List of functions to be prepended to ORG-OPEN-LINK-FUNCTIONS when ORG-CTAGS is active." + "List of functions to be prepended to ORG-OPEN-LINK-FUNCTIONS by ORG-CTAGS." :group 'org-ctags :version "24.1" :type 'hook diff --git a/lisp/org-indent.el b/lisp/org-indent.el index af2485c01..c6bf41656 100644 --- a/lisp/org-indent.el +++ b/lisp/org-indent.el @@ -85,15 +85,13 @@ it may be prettier to customize the `org-indent' face." :type 'character) (defcustom org-indent-mode-turns-off-org-adapt-indentation t - "Non-nil means setting the variable `org-indent-mode' will \ -turn off indentation adaptation. + "Non-nil means setting `org-indent-mode' will turn off indentation adaptation. For details see the variable `org-adapt-indentation'." :group 'org-indent :type 'boolean) (defcustom org-indent-mode-turns-on-hiding-stars t - "Non-nil means setting the variable `org-indent-mode' will \ -turn on `org-hide-leading-stars'." + "Non-nil means setting `org-indent-mode' will turn on `org-hide-leading-stars'." :group 'org-indent :type 'boolean) diff --git a/lisp/org-pcomplete.el b/lisp/org-pcomplete.el index 29d9d5848..d8a4937b9 100644 --- a/lisp/org-pcomplete.el +++ b/lisp/org-pcomplete.el @@ -239,11 +239,11 @@ When completing for #+STARTUP, for example, this function returns (require 'ox) (pcomplete-here (and org-export-exclude-tags - (list (mapconcat 'identity org-export-exclude-tags " "))))) + (list (mapconcat #'identity org-export-exclude-tags " "))))) (defun pcomplete/org-mode/file-option/filetags () "Complete arguments for the #+FILETAGS file option." - (pcomplete-here (and org-file-tags (mapconcat 'identity org-file-tags " ")))) + (pcomplete-here (and org-file-tags (mapconcat #'identity org-file-tags " ")))) (defun pcomplete/org-mode/file-option/language () "Complete arguments for the #+LANGUAGE file option." @@ -264,13 +264,13 @@ When completing for #+STARTUP, for example, this function returns (require 'ox) (pcomplete-here (and org-export-select-tags - (list (mapconcat 'identity org-export-select-tags " "))))) + (list (mapconcat #'identity org-export-select-tags " "))))) (defun pcomplete/org-mode/file-option/startup () "Complete arguments for the #+STARTUP file option." (while (pcomplete-here (let ((opts (pcomplete-uniquify-list - (mapcar 'car org-startup-options)))) + (mapcar #'car org-startup-options)))) ;; Some options are mutually exclusive, and shouldn't be completed ;; against if certain other options have already been seen. (dolist (arg pcomplete-args) @@ -340,7 +340,8 @@ When completing for #+STARTUP, for example, this function returns "Complete against TeX-style HTML entity names." (require 'org-entities) (while (pcomplete-here - (pcomplete-uniquify-list (remove nil (mapcar 'car-safe org-entities))) + (pcomplete-uniquify-list + (remove nil (mapcar #'car-safe org-entities))) (substring pcomplete-stub 1)))) (defun pcomplete/org-mode/todo () diff --git a/lisp/org-protocol.el b/lisp/org-protocol.el index 7f9a6ae02..74043f834 100644 --- a/lisp/org-protocol.el +++ b/lisp/org-protocol.el @@ -181,7 +181,8 @@ Possible properties are: :working-directory - the local working directory. This is, what base-url will be replaced with. :redirects - A list of cons cells, each of which maps a regular - expression to match to a path relative to :working-directory. + expression to match to a path relative to + :working-directory. Example: @@ -202,7 +203,8 @@ Example: :working-directory \"~/site/content/post/\" :online-suffix \".html\" :working-suffix \".md\" - :rewrites ((\"\\(https://site.com/[0-9]+/[0-9]+/[0-9]+/\\)\" . \".md\"))) + :rewrites ((\"\\(https://site.com/[0-9]+/[0-9]+/[0-9]+/\\)\" + . \".md\"))) (\"GNU emacs OpenGrok\" :base-url \"https://opengrok.housegordon.com/source/xref/emacs/\" :working-directory \"~/dev/gnu-emacs/\"))) diff --git a/lisp/org-refile.el b/lisp/org-refile.el index 4a09ab53f..4e9f26eff 100644 --- a/lisp/org-refile.el +++ b/lisp/org-refile.el @@ -7,18 +7,18 @@ ;; ;; This file is part of GNU Emacs. -;; This program is free software; you can redistribute it and/or modify +;; GNU Emacs is free software: you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by ;; the Free Software Foundation, either version 3 of the License, or ;; (at your option) any later version. -;; This program is distributed in the hope that it will be useful, +;; GNU Emacs is distributed in the hope that it will be useful, ;; but WITHOUT ANY WARRANTY; without even the implied warranty of ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ;; GNU General Public License for more details. ;; You should have received a copy of the GNU General Public License -;; along with this program. If not, see . +;; along with GNU Emacs. If not, see . ;;; Commentary: diff --git a/lisp/org-table.el b/lisp/org-table.el index 48d49b8e9..4262718e6 100644 --- a/lisp/org-table.el +++ b/lisp/org-table.el @@ -1994,7 +1994,7 @@ toggle `org-table-follow-field-mode'." (let ((b (save-excursion (skip-chars-backward "^|") (point))) (e (save-excursion (skip-chars-forward "^|\r\n") (point)))) (remove-text-properties b e '(invisible t intangible t)) - (if (and (boundp 'font-lock-mode) font-lock-mode) + (if font-lock-mode (font-lock-fontify-block)))) (t (let ((pos (point-marker)) diff --git a/lisp/org.el b/lisp/org.el index 5b1443c4e..ed209c397 100644 --- a/lisp/org.el +++ b/lisp/org.el @@ -1851,7 +1851,7 @@ link types. The types are: bracket The recommended [[link][description]] or [[link]] links with hiding. angle Links in angular brackets that may contain whitespace like . -plain Plain links in normal text, no whitespace, like http://google.com. +plain Plain links in normal text, no whitespace, like https://gnu.org. radio Text that is matched by a radio target, see manual for details. tag Tag settings in a headline (link to tag search). date Time stamps (link to calendar). @@ -4118,7 +4118,8 @@ groups carry important information: "Regular expression to match a timestamp time or time range. After a match, the following groups carry important information: 0 the full match -1 date plus weekday, for back referencing to make sure both times are on the same day +1 date plus weekday, for back referencing to make sure + both times are on the same day 2 the first time, range or not 4 the second time, if it is a range.") @@ -5532,7 +5533,7 @@ highlighting was done, nil otherwise." (defun org-restart-font-lock () "Restart `font-lock-mode', to force refontification." - (when (and (boundp 'font-lock-mode) font-lock-mode) + (when font-lock-mode (font-lock-mode -1) (font-lock-mode 1)))