Skip to content

Commit bb8b8d7

Browse files
committed
Tiny fixes to recent native compilation docs
For discussion, see the following thread: https://lists.gnu.org/r/emacs-devel/2021-05/msg00347.html * doc/lispref/compile.texi (Native Compilation): Fix grammar in @ref online label. (Native-Compilation Functions): Consistently unhyphenate 'sub-process'. Fix grammar. (Native-Compilation Variables): Fix @cindex entry.
1 parent d3344e0 commit bb8b8d7

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

doc/lispref/compile.texi

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -801,13 +801,13 @@ The @code{silly-loop} function is somewhat more complex:
801801

802802
@cindex native code
803803
In addition to the byte-compilation, described in @ref{Byte
804-
Compilation, previous chapter}, Emacs can also optionally compile Lisp
805-
function definitions into a true compiled code, known as @dfn{native
806-
code}. This feature uses the @file{libgccjit} library, which is part
807-
of the GCC distribution, and requires that Emacs be built with support
808-
for using that library. It also requires to have GCC and Binutils
809-
(the assembler and linker) available on your system for you to be able
810-
to native-compile Lisp code.
804+
Compilation, the previous chapter}, Emacs can also optionally compile
805+
Lisp function definitions into a true compiled code, known as
806+
@dfn{native code}. This feature uses the @file{libgccjit} library,
807+
which is part of the GCC distribution, and requires that Emacs be
808+
built with support for using that library. It also requires to have
809+
GCC and Binutils (the assembler and linker) available on your system
810+
for you to be able to native-compile Lisp code.
811811

812812
@vindex native-compile@r{, a Lisp feature}
813813
To determine whether the current Emacs process can produce and load
@@ -857,7 +857,7 @@ specified, the former takes precedence.
857857
@section Native-Compilation Functions
858858
@cindex native-compilation functions
859859

860-
Native-Compilation is implemented as side effect of
860+
Native-Compilation is implemented as a side effect of
861861
byte-compilation (@pxref{Byte Compilation}). Thus, compiling Lisp
862862
code natively always produces its byte code as well, and therefore all
863863
the rules and caveats of preparing Lisp code for byte compilation
@@ -892,14 +892,14 @@ argument @var{function-or-file} can be a function symbol, a Lisp form,
892892
or a name (a string) of the file which contains the Emacs Lisp source
893893
code to compile. If the optional argument @var{output} is provided,
894894
it must be a string specifying the name of the file to write the
895-
compiled code. Otherwise, if @var{function-or-file} is a function or
896-
a Lisp form, this function returns the compiled object, and if
897-
@var{function-or-file} is a file name, the function returns the full
898-
absolute name of the file it created for the compiled code. The
895+
compiled code into. Otherwise, if @var{function-or-file} is a
896+
function or a Lisp form, this function returns the compiled object,
897+
and if @var{function-or-file} is a file name, the function returns the
898+
full absolute name of the file it created for the compiled code. The
899899
output file is by default given the @file{.eln} extension.
900900

901901
This function runs the final phase of the native compilation, which
902-
invokes GCC via @file{libgccjit}, in a separate sub-process, which
902+
invokes GCC via @file{libgccjit}, in a separate subprocess, which
903903
invokes the same Emacs executable as the process that called this
904904
function.
905905
@end defun
@@ -913,12 +913,12 @@ attempt to compile all the other files, and will terminate with a
913913
non-zero status code.
914914
@end defun
915915

916-
Native compilation can be run entirely asynchronously, in a
917-
sub-process of the main Emacs process. This leaves the main Emacs
918-
process free to use while the compilation runs in the background.
919-
This is the method used by Emacs to natively-compile any Lisp file or
920-
byte-compiled Lisp file that is loaded into Emacs, when no
921-
natively-compiled file for it is available.
916+
Native compilation can be run entirely asynchronously, in a subprocess
917+
of the main Emacs process. This leaves the main Emacs process free to
918+
use while the compilation runs in the background. This is the method
919+
used by Emacs to natively-compile any Lisp file or byte-compiled Lisp
920+
file that is loaded into Emacs, when no natively-compiled file for it
921+
is available.
922922

923923
@defun native-compile-async files &optional recursively load selector
924924
This function compiles the named @var{files} asynchronously. The
@@ -944,12 +944,12 @@ or the directory should be selected for compilation.
944944

945945
On systems with multiple CPU execution units, when @var{files} names
946946
more than one file, this function will normally start several
947-
compilation sub-processes in parallel, under the control of
947+
compilation subprocesses in parallel, under the control of
948948
@code{native-comp-async-jobs-number} (@pxref{Native-Compilation
949949
Variables}).
950950
@end defun
951951

952-
The following function allows Lisp program to test whether
952+
The following function allows Lisp programs to test whether
953953
native-compilation is available at runtime.
954954

955955
@defun native-comp-available-p
@@ -962,7 +962,7 @@ whether native-compilation is available should use this predicate.
962962

963963
@node Native-Compilation Variables
964964
@section Native-Compilation Variables
965-
@cindex native-compilation variable
965+
@cindex native-compilation variables
966966

967967
This section documents the variables that control
968968
native-compilation.

0 commit comments

Comments
 (0)