1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-17 19:30:38 -08:00
Commit graph

471 commits

Author SHA1 Message Date
Juri Linkov
7e8b8da9e3 Fix handling of empty input in describe-variable and describe-symbol
* lisp/help-fns.el (describe-variable): Use 'user-error' like in
'describe-function'.
(describe-symbol): Use empty string for arg SYMBOL when input is empty
and there is no default value.
This allows to signal the error "You didn't specify a function or variable"
instead of displaying help about the symbol 'nil' on empty input.
OTOH, still allows to see help about 'nil' when the input is "nil".
2020-03-06 02:27:32 +02:00
Glenn Morris
b5474ba160 Merge from origin/emacs-27
a3c2d186eb (origin/emacs-27) CC Mode: Fix the handling of two adjacen...
a1abf73c76 Fix combine-change-calls-1 for when buffer-undo-list is t
db37dd2e84 Don't misinterpret doc string as initial value
40b217c2bf Bump checkdoc-version to match library header
60418a1ab2 Explain how to unset mode bindings (Bug#39802)
7cafbbe964 Fix describe-variable on values with circular syntax (Bug#...
592b1cfee9 Improve documentation of next-error-highlight-no-select (b...
2020-03-04 13:57:58 -08:00
Andrea Corallo
6487d4ac5d Merge remote-tracking branch 'savannah/master' into HEAD 2020-03-04 11:07:53 +00:00
Noam Postavsky
7cafbbe964 Fix describe-variable on values with circular syntax (Bug#39805)
* lisp/help-fns.el (describe-variable): Set syntax tables before
calling pp-buffer.
2020-03-03 22:04:48 -05:00
AndreaCorallo
286e21c4e8 Rework `find-lisp-object-file-name'
Rework it for eln new compilation folder layout.
2020-03-03 21:01:37 +00:00
Štěpán Němec
0f94f698aa Use help-fns-short-filename in other describe- commands
The commit

2015-01-16T22:52:15-05:00!monnier@iro.umontreal.ca
24b7f77581
(Improve handling of doc-strings and describe-function for cl-generic)

added 'help-fns-short-filename', which provides file name shortening
smarter than a simple 'file-name-nondirectory' call, but besides the
generic/eieio functions ('cl--generic-describe', 'cl--describe-class',
'eieio-help-constructor'), it is currently only used by
'describe-function' (via 'help-fns-function-description-header').

Make the other help commands use it, too.

(Other than the obvious consistency/maintenance argument, my immediate
motivation for this change is the possibility to customize the file
name abbreviation by advising the function.)

* lisp/help.el (describe-mode): Move to help-fns.el.  The command was
already depending on 'find-lisp-object-file-name' defined there.
* lisp/help-fns.el (describe-variable) (describe-face) (describe-keymap)
(describe-mode): Use 'help-fns-short-filename'.
2020-03-03 10:52:27 -05:00
Andrea Corallo
15aedf3e3d Merge remote-tracking branch 'savannah/master' into HEAD 2020-02-04 15:11:20 +01:00
Stefan Kangas
330228d5c7 Provide default for describe-keymap prompt
* lisp/help-fns.el (describe-keymap): Provide a reasonable
default for prompt.  (Bug#30660)
(help-fns-find-keymap-name)
(help-fns--most-relevant-active-keymap): New functions.

* test/lisp/help-fns-tests.el
(help-fns-test-find-keymap-name): New test.
2020-02-04 02:04:20 +01:00
Stefan Kangas
557b790e0a Add new help command describe-keymap
* lisp/help-fns.el (describe-keymap): New command to show key bindings
for a given keymap.  (Bug#30660)
* doc/emacs/help.texi (Misc Help): Document the new command.
* doc/lispref/keymaps.texi (Scanning Keymaps): Add a cross-reference
to the above documentation.
* etc/NEWS: Announce the new command.

* test/lisp/help-fns-tests.el (help-fns-test-describe-keymap/symbol)
(help-fns-test-describe-keymap/value)
(help-fns-test-describe-keymap/not-keymap)
(help-fns-test-describe-keymap/let-bound)
(help-fns-test-describe-keymap/dynamically-bound-no-file): New tests.

Co-authored-by: Drew Adams <drew.adams@oracle.com>
2020-02-04 02:04:20 +01:00
Andrea Corallo
f4de790bee add native compiled function docstring support 2020-01-01 11:38:11 +01:00
Paul Eggert
365e01cc9f Update copyright year to 2020
Run "TZ=UTC0 admin/update-copyright $(git ls-files)".
2020-01-01 00:59:52 +00:00
Eli Zaretskii
2435f811b9 Make some anonymous faces extend to EOL
* lisp/vc/log-edit.el (log-edit-font-lock-keywords):
* lisp/mpc.el (mpc-separator):
* lisp/help.el (describe-key):
* lisp/help-fns.el (describe-symbol): Make the anonymous faces
extend to EOL.
2019-11-27 18:19:30 +02:00
Juri Linkov
58fde6362f * lisp/help-fns.el (describe-variable): Add quotes to symbol value of origval. 2019-11-03 23:52:23 +02:00
Jimmy Aguilar Mena
bc8db39775 Added face parameter :extend.
This is an initial change to add a parameter :extend that will be used
in the display engine later.
2019-10-14 14:18:39 +02:00
Lars Ingebrigtsen
120f691e99 (help-fns--var-aliases): Fix compilation warning in previous patch. 2019-10-14 07:49:25 +02:00
Lars Ingebrigtsen
c4fcaf5e72 Make `C-h v' list all aliases a variable has
* lisp/help-fns.el (help-fns--var-aliases): New function (bug#15179).
2019-10-14 07:47:53 +02:00
Lars Ingebrigtsen
f2cbc7214f Add more sanity checks to help-fns--globalized-minor-mode
* lisp/help-fns.el (help-fns--globalized-minor-mode): FUNCTION can
be a lambda, so protect against that.
2019-10-09 05:13:07 +02:00
Lars Ingebrigtsen
bc95fc78bb Make the help page mention the customizeable global mode variable
* lisp/help-fns.el (help-fns--customize-variable): Factor out into
own function for reuse.
(help-fns--globalized-minor-mode): Use it to mention the
equivalent variable.

* lisp/emacs-lisp/easy-mmode.el (define-globalized-minor-mode):
Mark globalized minor modes as such (bug#7177).
2019-10-01 16:45:24 +02:00
Stefan Monnier
dddff96a58 * lisp/help-fns.el: Fix missing dependency 2019-09-22 12:54:48 -04:00
Lars Ingebrigtsen
c56fabdfc7 Move describe-face to the new help-fns machinery
* lisp/help-fns.el (describe-face): Move to here from faces.el and
split up (bug#36670).
(help-fns--face-custom-version-info):
(help-fns--face-attributes): Factored out into own functions.
(help-fns-describe-face-functions): New variable.

* lisp/emacs-lisp/subr-x.el (when-let): Add autoload cookie.
2019-09-21 00:45:41 +02:00
Lars Ingebrigtsen
f38a16ee89 Make `describe-function' say that disabled functions are disabled
* lisp/help-fns.el (help-fns--disabled): New function (bug#10853).
(help-fns-describe-function-functions): Add it to the list of
function help functions.
2019-08-17 16:56:13 -07:00
Lars Ingebrigtsen
b3713265cb Rename variables and functions with "auto-load" in their names
* doc/emacs/building.texi (Lisp Libraries): Adjust documentation.

* lisp/help-fns.el (help--symbol-completion-table): Adjust usage.

* lisp/help-fns.el (help-enable-completion-autoload): Change name
from auto-load and declare an obsolete alias (bug#13418).

* lisp/help.el (help-enable-autoload): Ditto.

* lisp/progmodes/vhdl-mode.el: Ditto.
(vhdl-create-mode-menu, vhdl-mode): Adjust usage.
(vhdl-autoload-project): Rename from auto-load and declare an
obsolete alias.
2019-08-15 16:02:20 -07:00
Lars Ingebrigtsen
783eca5715 Make describe-face also output the version information
* lisp/help-fns.el (describe-variable-custom-version-info): Allow
taking a type as an optional input, so this can be used for faces,
too (bug#30527).

* lisp/faces.el (describe-face): Use this to output the version
information.
2019-07-14 18:50:27 +02:00
Lars Ingebrigtsen
636dc37c70 Revert "Make describe-face also output the version information"
This reverts commit a7aae1473c.

The patch broke the build.
2019-07-14 18:37:55 +02:00
Lars Ingebrigtsen
a7aae1473c Make describe-face also output the version information
* lisp/help-fns.el (describe-variable-custom-version-info): Allow
taking a type as an optional input, so this can be used for faces,
too (bug#30527).

* lisp/faces.el (describe-face): Use this to output the version
information.
2019-07-14 17:02:05 +02:00
Stefan Monnier
0b4e003766 Revert "* lisp/calc/calc-ext.el (math-scalarp): Fix typo"
This reverts commit 698ff554ac.
2019-06-26 10:24:59 -04:00
Johan Claesson
699fce296b help-C-file-name shouldn't error out if we can't find the name
* lisp/help-fns.el (help-C-file-name): Make help-C-file-name
return nil instead of signalling an error if we can't find the
file name (bug#17250).

Copyright-paperwork-exempt: yes
2019-06-26 16:06:42 +02:00
Stefan Monnier
698ff554ac * lisp/calc/calc-ext.el (math-scalarp): Fix typo 2019-06-26 10:03:48 -04:00
Juanma Barranquero
33ea72eb3c * help-fns.el (help-fns--first-release): Do not fail if no release is found. 2019-06-03 02:13:57 +02:00
Stefan Monnier
e3029eaadf * lisp/help-fns.el: Make hyperlink for the "first release" info
* lisp/help-fns.el (help-fns--first-release): Return a "button".
(help-fns--mention-first-release): Preserve the string's text-properties.

* lisp/help-mode.el (help-news): New button type.
2019-06-02 11:52:41 -04:00
Paul Eggert
f744797af1 Go back to "Maintainer: emacs-devel@gnu.org"
Restore lines saying "Maintainer: emacs-devel@gnu.org" when there is
no special maintainer for a file.  Although this wasn't documented
it was common practice and removing the lines didn't have consensus.
2019-05-25 14:25:18 -07:00
Glenn Morris
5c21832ae8 Merge from origin/emacs-26
b0da915 (origin/emacs-26, emacs-26) Fix a typo in ELisp manual
400907b Add option to disable help completion autoloading (Bug#28607)
122ba16 Don't segfault on force-window-update of deleted window
015b12e Fix typo in ELisp manual
eadf044 Remove repeated function call in picture.el
1228a90 ; Fix mm-destroy-parts docstring typo
6cfd68d Fix Hideshow key binding typo in Emacs manual
2019-05-22 10:18:51 -07:00
Noam Postavsky
400907b3c1 Add option to disable help completion autoloading (Bug#28607)
* lisp/help-fns.el (help-enable-completion-auto-load): New option.
(help--symbol-completion-table): Consult it.
* doc/emacs/building.texi (Lisp Libraries): Document it.
* etc/NEWS: Announce it.
* doc/lispref/loading.texi (Autoload by Prefix): New section.
(Autoload): Reference it.
2019-05-21 07:37:22 -04:00
Paul Eggert
bef1be8730 Fixes for "Maintainer:" and related lines
Mostly, this just removes "Maintainer: emacs-devel@gnu.org" lines,
which are not that useful.  It also cleans up and regularizes a
few similar lines.
2019-05-19 21:34:27 -07:00
Stefan Monnier
896e580216 * lisp/help-fns.el (help-fns-describe-variable-functions): New hook
(help-fns--compiler-macro, help-fns--parent-mode, help-fns--obsolete)
(help-fns--interactive-only): Indent output by 2 spaces.
(help-fns--side-effects): New function extracted from
describe-function-1.
(help-fns-describe-function-functions): Use it.
(help-fns--first-release, help-fns--mention-first-release): New functions.
(help-fns-function-description-header): Keymaps and macros can't
be interactive.
(help-fns--ensure-empty-line): New function.
(describe-function-1): Use it.
(help-fns--var-safe-local, help-fns--var-risky)
(help-fns--var-ignored-local, help-fns--var-file-local)
(help-fns--var-watchpoints, help-fns--var-obsolete)
(help-fns--var-alias, help-fns--var-bufferlocal): New functions,
extacted from describe-variable.
(describe-variable): Run help-fns-describe-variable-functions instead.
2019-04-12 12:37:00 -04:00
Eli Zaretskii
8eb94161b3 Be more defensive regarding elements of 'load-history'
* lisp/loadhist.el (file-dependents):
* lisp/apropos.el (apropos-library):
* lisp/help-fns.el (help-fns--autoloaded-p, help--loaded-p):
* lisp/emacs-lisp/package.el (package--list-loaded-files):
Don't assume 'load-history' elements must have a string as their
'car'.  (Bug#34462)
2019-03-01 11:44:52 +02:00
Stefan Monnier
35224ac3ae * lisp/help-fns.el (help--load-prefixes): Demote errors from files. 2019-01-08 11:28:00 -05:00
Paul Eggert
ba809612c0 Merge from origin/emacs-26
2fcf2df Fix copyright years by hand
26bed8b Update copyright year to 2019
2814292 Fix value of default frame height.  (Bug#33921)
2018-12-31 17:57:29 -08:00
Paul Eggert
26bed8ba10 Update copyright year to 2019
Run 'TZ=UTC0 admin/update-copyright $(git ls-files)'.
2019-01-01 01:01:13 +00:00
Stefan Monnier
aee434c3e0 * lisp/help-fns.el (describe-symbol): Use help--symbol-completion-table 2018-11-02 16:14:49 -04:00
Paul Eggert
20b858ef13 Prefer \... to control chars in .el literals 2018-03-29 17:43:08 -07:00
Philipp Stephani
f3d0db7f0f Add support for module functions to C-h f (Bug#30163).
* lisp/help-fns.el (help-fns-function-description-header): Handle
module functions.

* test/src/emacs-module-tests.el (module/describe-function-1): New
test.
2018-02-02 20:31:40 +01:00
Paul Eggert
bb267f17f9 Merge from origin/emacs-26
63b04c11d5 Fix copyright years by hand
5c7dd8a783 Update copyright year to 2018
220a9ecba1 Merge from Gnulib
312c565566 Don't add empty keyboard macro to macro ring (Bug#24992)
39ca289a7a Allow customization of decoding of "man" command
f8240815ea * etc/NEWS: Add security consideration note on passphrase ...
0c78822c70 Fix subtle problem with scroll-down when scroll-margin is ...
acd289c5a4 Fix problems with indexing in User manual
b240c7846b * lisp/help.el (describe-key): Only (copy-sequence elt) wh...
e879a5444a * src/buffer.c (Frestore_buffer_modified_p): Fix bug#29846
81b1028b63 Improve documentation of 'inhibit-modification-hooks' and ...
7175496d7a Fix doc string of 'enable-recursive-minibuffers'
5b38406491 Fix documentation of delsel and of killing text

# Conflicts:
#	etc/NEWS
#	etc/refcards/ru-refcard.tex
2018-01-01 01:13:04 -08:00
Paul Eggert
5c7dd8a783 Update copyright year to 2018
Run admin/update-copyright.
2018-01-01 00:57:59 -08:00
Glenn Morris
5f1cf4b5c7 Merge from origin/emacs-26
fc5b8f1 Fix Bug#29149
5622b2e Merge branch 'emacs-26' of git.sv.gnu.org:/srv/git/emacs into...
4da8799 (emacs-26) Fix misbehavior when drawing three-pixel high hori...
1b082c8 MH-E: don't automatically download external-body parts
069f978 ; * lisp/emacs-lisp/byte-run.el: Fix a typo in a comment.
504a56c ; Fix last commit
a34e44e ; Fix last commit
a8892b4 Further fix for Bug#29291
d14923b Fix divider frame params on NS (bug#29352)
b2518ac Spelling fixes

# Conflicts:
#	etc/NEWS
#	test/lisp/net/tramp-tests.el
2017-11-20 13:10:11 -05:00
Paul Eggert
b2518ac750 Spelling fixes
* lisp/help-fns.el (help-fns--analyze-function):
Rename from help-fns--analyse-function.
All uses changed.
2017-11-19 00:21:09 -08:00
Glenn Morris
cda4c74e60 Merge from origin/emacs-26
888e51f220 (origin/emacs-26) Update describe-function for recent Fdoc...
75bb482763 Make flymake's mouse-wheel interaction portable (Bug#28732)
035d7ac7e4 Prevent eldoc from changing the mode line
c9d71b31bf Fix doc strings in simple.el
0d8e4f45d6 Avoid creating inconsistent buffer states in term-char-mode
79d57f4b7a New input method 'usbek-cyrillic'
4587d8e0ef Document 'minibuffer-with-setup-hook'

# Conflicts:
#	etc/NEWS
2017-10-21 09:07:30 -07:00
Glenn Morris
888e51f220 Update describe-function for recent Fdocumentation change
* lisp/help-fns.el (describe-function-1):
Handle Fdocumentation returning either void or invalid.
2017-10-21 09:00:16 -07:00
Stefan Monnier
ef3d8505ec * lisp/help-fns.el (describe-function-1):
Fix help-fns-test-dangling-alias.  (Bug#28918)

(cherry picked from commit e1d42f8f4a)
2017-10-20 16:58:32 -04:00
Stefan Monnier
e1d42f8f4a * lisp/help-fns.el (describe-function-1): Fix help-fns-test-dangling-alias. 2017-10-20 16:04:02 -04:00