all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
* make-docfile feature/bug while parsing DEFUN
@ 2015-08-30 12:38 Aurélien Aptel
  0 siblings, 0 replies; only message in thread
From: Aurélien Aptel @ 2015-08-30 12:38 UTC (permalink / raw)
  To: Emacs development discussions

Hi,

I ran into a problem where a DEFVAR I added was not detected by
make-docfile resulting in a bad globals.h.

After a lot of hair-pulling I finally found out what was going wrong:
make-docfile cannot parse DEFUN docstrings when they are string
literals instead of comments.

Sample input:

DEFUN ("fun", Ffun, Sfun, 1, 1, 0,
       doc: "Docstring")
  (Lisp_Object foo)
{

}

void syms_of_foo (void)
{
  DEFVAR_LISP ("var1", Var1,
           doc: /* Blah blah.  */);
  DEFVAR_LISP ("var2", Var2,
           doc: /* Blah blah.  */);
}

Results in:

struct emacs_globals {
  Lisp_Object f_Var2;
#define Var2 globals.f_Var2
};

Notice how Var1 was skipped. By simply using doc: /* Docstring */ in
the DEFUN, both DEFVAR are properly parsed.

I don't even know why I was using string literals in the first place.
But there you go, in case someone runs into the same problem...



^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2015-08-30 12:38 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2015-08-30 12:38 make-docfile feature/bug while parsing DEFUN Aurélien Aptel

Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.