defining-kbd-macro

defining-kbd-macro

[Luc Teirlinck]

The value `append' for `defining-kbd-macro' has recently been given
a special meaning.  I propose the following updates to the docstring
and Elisp documentation of `defining-kbd-macro'.  I can install if it
looks OK.

===File ~/commands.texi-diff================================
*** commands.texi	01 Nov 2004 07:02:18 -0600	1.59
--- commands.texi	04 Nov 2004 19:02:11 -0600	
***************
*** 3023,3031 ****
  @defvar defining-kbd-macro
  This variable is non-@code{nil} if and only if a keyboard macro is
  being defined.  A command can test this variable so as to behave
! differently while a macro is being defined.  The commands
! @code{start-kbd-macro} and @code{end-kbd-macro} set this variable---do
! not set it yourself.
  
  The variable is always local to the current terminal and cannot be
  buffer-local.  @xref{Multiple Displays}.
--- 3023,3032 ----
  @defvar defining-kbd-macro
  This variable is non-@code{nil} if and only if a keyboard macro is
  being defined.  A command can test this variable so as to behave
! differently while a macro is being defined.  The value is
! @code{append} while appending to the definition of an existing macro.
! The commands @code{start-kbd-macro}, @code{kmacro-start-macro} and
! @code{end-kbd-macro} set this variable---do not set it yourself.
  
  The variable is always local to the current terminal and cannot be
  buffer-local.  @xref{Multiple Displays}.
============================================================

===File ~/macros.c-diff=====================================
*** macros.c	02 Sep 2003 08:17:58 -0500	1.54
--- macros.c	04 Nov 2004 18:55:43 -0600	
***************
*** 392,398 ****
    defsubr (&Sstore_kbd_macro_event);
  
    DEFVAR_KBOARD ("defining-kbd-macro", defining_kbd_macro,
! 		 doc: /* Non-nil while a keyboard macro is being defined.  Don't set this!  */);
  
    DEFVAR_LISP ("executing-macro", &Vexecuting_macro,
  	       doc: /* Currently executing keyboard macro (string or vector); nil if none executing.  */);
--- 392,399 ----
    defsubr (&Sstore_kbd_macro_event);
  
    DEFVAR_KBOARD ("defining-kbd-macro", defining_kbd_macro,
! 		 doc: /* Non-nil while a keyboard macro is being defined.  Don't set this!
! The value is `append' while appending to the definition of an existing macro.  */);
  
    DEFVAR_LISP ("executing-macro", &Vexecuting_macro,
  	       doc: /* Currently executing keyboard macro (string or vector); nil if none executing.  */);
============================================================

Re: defining-kbd-macro

[Luc Teirlinck]

Actually, I need to make a slight change to the proposed docstring of
`defining-kbd-macro', as otherwise a false hyperlink to the function
`append' would be made:

===File ~/macros.c-diff=====================================
*** macros.c	02 Sep 2003 08:17:58 -0500	1.54
--- macros.c	04 Nov 2004 19:39:34 -0600	
***************
*** 392,398 ****
    defsubr (&Sstore_kbd_macro_event);
  
    DEFVAR_KBOARD ("defining-kbd-macro", defining_kbd_macro,
! 		 doc: /* Non-nil while a keyboard macro is being defined.  Don't set this!  */);
  
    DEFVAR_LISP ("executing-macro", &Vexecuting_macro,
  	       doc: /* Currently executing keyboard macro (string or vector); nil if none executing.  */);
--- 392,400 ----
    defsubr (&Sstore_kbd_macro_event);
  
    DEFVAR_KBOARD ("defining-kbd-macro", defining_kbd_macro,
! 		 doc: /* Non-nil while a keyboard macro is being defined.  Don't set this!
! The value is the symbol `append' while appending to the definition of
! an existing macro.  */);
  
    DEFVAR_LISP ("executing-macro", &Vexecuting_macro,
  	       doc: /* Currently executing keyboard macro (string or vector); nil if none executing.  */);
============================================================

Re: defining-kbd-macro

[Kim F. Storm]

Luc Teirlinck <teirllm@dms.auburn.edu> writes:

> The value `append' for `defining-kbd-macro' has recently been given
> a special meaning.  I propose the following updates to the docstring
> and Elisp documentation of `defining-kbd-macro'.  I can install if it
> looks OK.

Looks fine.

-- 
Kim F. Storm <storm@cua.dk> http://www.cua.dk