Skip to content

Commit

Permalink
* lisp/emacs-lisp/nadvice.el (advice--make-docstring): Try harder to …
Browse files Browse the repository at this point in the history
…find

the docstring of functions advised before dumping.
* src/doc.c (store_function_docstring): Warn when we don't know where to
put a docstring.
(Fsubstitute_command_keys): Don't advertise the fact that
text-properties are dropped, since we think it's a bug that we'll fix
in 24.5.
  • Loading branch information
monnier committed Mar 20, 2014
1 parent 86b1387 commit 933019e
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 5 deletions.
5 changes: 5 additions & 0 deletions lisp/ChangeLog
@@ -1,3 +1,8 @@
2014-03-20 Stefan Monnier <monnier@iro.umontreal.ca>

* emacs-lisp/nadvice.el (advice--make-docstring): Try harder to find
the docstring of functions advised before dumping (bug#16993).

2014-03-19 Stefan-W. Hahn <stefan.hahn@s-hahn.de> (tiny change)

* ps-print.el (ps-generate-postscript-with-faces):
Expand Down
16 changes: 12 additions & 4 deletions lisp/emacs-lisp/nadvice.el
Expand Up @@ -74,12 +74,19 @@ Each element has the form (WHERE BYTECODE STACK) where:

(defun advice--make-docstring (function)
"Build the raw docstring for FUNCTION, presumably advised."
(let ((flist (indirect-function function))
(docstring nil))
(let* ((flist (indirect-function function))
(docfun nil)
(docstring nil))
(if (eq 'macro (car-safe flist)) (setq flist (cdr flist)))
(while (advice--p flist)
(let ((bytecode (aref flist 1))
(doc (aref flist 4))
(where nil))
;; Hack attack! For advices installed before calling
;; Snarf-documentation, the integer offset into the DOC file will not
;; be installed in the "core unadvised function" but in the advice
;; object instead! So here we try to undo the damage.
(if (integerp doc) (setq docfun flist))
(dolist (elem advice--where-alist)
(if (eq bytecode (cadr elem)) (setq where (car elem))))
(setq docstring
Expand All @@ -101,8 +108,9 @@ Each element has the form (WHERE BYTECODE STACK) where:
"\n")))
(setq flist (advice--cdr flist)))
(if docstring (setq docstring (concat docstring "\n")))
(let* ((origdoc (unless (eq function flist) ;Avoid inf-loops.
(documentation flist t)))
(unless docfun (setq docfun flist))
(let* ((origdoc (unless (eq function docfun) ;Avoid inf-loops.
(documentation docfun t)))
(usage (help-split-fundoc origdoc function)))
(setq usage (if (null usage)
(let ((arglist (help-function-arglist flist)))
Expand Down
6 changes: 6 additions & 0 deletions src/ChangeLog
@@ -1,5 +1,11 @@
2014-03-20 Stefan Monnier <monnier@iro.umontreal.ca>

* doc.c (store_function_docstring): Warn when we don't know where to
put a docstring.
(Fsubstitute_command_keys): Don't advertise the fact that
text-properties are dropped, since we think it's a bug that we'll fix
in 24.5.

* frame.h (SET_FRAME_VISIBLE): Keep frame_garbaged up to date.
* xterm.c (handle_one_xevent) <MapNotify>: Don't garbage the frame.
* frame.c (frame_garbaged): Make "docstring" more precise.
Expand Down
5 changes: 4 additions & 1 deletion src/doc.c
Expand Up @@ -535,6 +535,9 @@ store_function_docstring (Lisp_Object obj, ptrdiff_t offset)
docstring, since we've found a docstring for it. */
if ((ASIZE (fun) & PSEUDOVECTOR_SIZE_MASK) > COMPILED_DOC_STRING)
ASET (fun, COMPILED_DOC_STRING, make_number (offset));
else
message ("No docstring slot for %s",
SYMBOLP (obj) ? SDATA (SYMBOL_NAME (obj)) : "<anonymous>");
}
}

Expand Down Expand Up @@ -707,7 +710,7 @@ as the keymap for future \\=\\[COMMAND] substrings.
thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output.
Return the original STRING if no substitutions are made.
Otherwise, return a new string, without any text properties. */)
Otherwise, return a new string. */)
(Lisp_Object string)
{
char *buf;
Expand Down

0 comments on commit 933019e

Please sign in to comment.