procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve documentation of byte-code objects

Browse source 
* doc/lispref/compile.texi (Byte-Code Objects): Document the
integer format of the argument descriptor.  (Bug#23061)
This commit is contained in:
Eli Zaretskii 2016-04-02 15:13:00 +03:00
parent 0020047fda
commit 7228eb805d
1 changed files with 18 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

25
doc/lispref/compile.texi
View file

@ -533,8 +533,19 @@ there is no maximum number, but only the first six elements have any
normal use. They are: normal use. They are:
@table @var @table @var
@item arglist @item argdesc
The list of argument symbols. The descriptor of the arguments. This can either be a list of
arguments, as described in @ref{Argument List}, or an integer encoding
the required number of arguments. In the latter case, the value of
the descriptor specifies the minimum number of arguments in the bits
zero to 6, and the maximum number of arguments in bits 8 to 14. If
the argument list uses @code{&rest}, then bit 7 is set; otherwise it's
cleared.
If @var{argdesc} is a list, the arguments will be dynamically bound
before executing the byte code. If @var{argdesc} is an integer, the
arguments will be instead pushed onto the stack of the byte-code
interpreter, before executing the code.
@item byte-code @item byte-code
The string containing the byte-code instructions. The string containing the byte-code instructions.
@ -562,11 +573,11 @@ representation. It is the definition of the command
@code{backward-sexp}. @code{backward-sexp}.
@example @example
#[(&optional arg) #[256
"^H\204^F^@@\301^P\302^H[!\207" "\211\204^G^@@\300\262^A\301^A[!\207"
[arg 1 forward-sexp] [1 forward-sexp]
2 3
254435 1793299
"^p"] "^p"]
@end example @end example