doc: fix small typos and errors

This commit is contained in:
Marius Gerbershagen 2019-06-21 20:15:31 +02:00
parent ba9ad6c444
commit 06f0a93421
6 changed files with 25 additions and 12 deletions

View file

@ -83,7 +83,7 @@ need to know about all these conventions. There is a preprocessor
(@pxref{Defun preprocessor}) that takes care of the details, by using a
lisp representation of the statements that output values, and of the
function definitions. For instance, the actual source code for
@code{cl_last} in @code{src/c/list.d}
@code{cl_last} in @code{src/c/list.d} is
@example
@verbatim

View file

@ -10,7 +10,7 @@ If you want to extend, fix or simply customize ECL for your own needs,
you should understand how the implementation works.
@cppindex cl_lispunion
@deftp @cind{} cl_lispunion cons big ratio SF DF longfloat complex symbol pack hash array vector base_string string stream random readtable pathname bytecodes bclosure cfun cfunfixed cclosure d instance process queue lock rwlock condition_variable semaphore barrier mailbox cblock foreign frame weak sse
@deftp @cind{} cl_lispunion { cons big ratio SF DF longfloat gencomplex csfloat cdfloat clfloat symbol pack hash array vector base_string string stream random readtable pathname bytecodes bclosure cfun cfunfixed cclosure d instance process queue lock rwlock condition_variable semaphore barrier mailbox cblock foreign frame weak sse }
Union containing all first-class ECL types.
@end deftp
@ -143,6 +143,11 @@ objects. The most important values are:
@cppindex t_longfloat
@c #endif
@cppindex t_complex
@c #ifdef ECL_COMPLEX_FLOAT
@cppindex t_csfloat
@cppindex t_cdfloat
@cppindex t_clfloat
@c #endif
@cppindex t_symbol
@cppindex t_package
@cppindex t_hashtable
@ -425,7 +430,7 @@ if (ECL_CHARACTERP(o) && ECL_BASE_CHAR_P(o))
Each character is assigned an integer code which ranges from 0 to
(ECL_CHAR_CODE_LIMIT-1).
@itemize @bullet
@item @strong{DEPRECATED} @code{CODE_CHAR_LIMIT} equivalent to @code{ECL_CHAR_CODE_LIMIT}
@item @strong{DEPRECATED} @code{CHAR_CODE_LIMIT} equivalent to @code{ECL_CHAR_CODE_LIMIT}
@end itemize
@end defvr
@ -464,8 +469,8 @@ char_equal ignores it.
@cppindex ecl_char_cmp
@cppindex ecl_char_compare
@deftypefun bool ecl_char_cmp (cl_object x, cl_object y)
@deftypefunx bool ecl_char_compare (cl_object x, cl_object y)
@deftypefun int ecl_char_cmp (cl_object x, cl_object y)
@deftypefunx int ecl_char_compare (cl_object x, cl_object y)
Compare the relative order of two characters. @code{char_cmp} takes care
of case and @code{char_compare} converts all characters to uppercase
before comparing them.
@ -535,7 +540,7 @@ pointer depending on @var{x->array.elttype}.
@end deftp
@cppindex cl_elttype
@deftp @cind{} cl_elttype ecl_aet_object ecl_aet_sf ecl_aet_df ecl_aet_bit ecl_aet_fix ecl_aet_index ecl_aet_b8 ecl_aet_i8 ecl_aet_b16 ecl_aet_i16 ecl_aet_b32 ecl_aet_i32 ecl_aet_b64 ecl_aet_i64 ecl_aet_ch ecl_aet_bc
@deftp @cind{} cl_elttype ecl_aet_object ecl_aet_sf ecl_aet_df ecl_aet_lf ecl_aet_csf ecl_aet_cdf ecl_aet_clf ecl_aet_bit ecl_aet_fix ecl_aet_index ecl_aet_b8 ecl_aet_i8 ecl_aet_b16 ecl_aet_i16 ecl_aet_b32 ecl_aet_i32 ecl_aet_b64 ecl_aet_i64 ecl_aet_ch ecl_aet_bc
Each array is of an specialized type which is the type of the elements
of the array. ECL has arrays only a few following specialized types, and
@ -550,6 +555,14 @@ some of those types together with the C constant that denotes that type:
@code{ecl_aet_sf}
@item DOUBLE-FLOAT
@code{ecl_aet_df}
@item LONG-FLOAT
@code{ecl_aet_lf}
@item (COMPLEX SINGLE-FLOAT)
@code{ecl_aet_csf}
@item (COMPLEX DOUBLE-FLOAT)
@code{ecl_aet_cdf}
@item (COMPLEX LONG-FLOAT)
@code{ecl_aet_clf}
@item BIT
@code{ecl_aet_bit}
@item FIXNUM
@ -808,7 +821,7 @@ Equivalent of @code{si_safe_eval}.
@subheading Example
@exindex @code{si_safe_eval}
@example
si_object form = ecl_read_from_cstring("(print 1)");
cl_object form = ecl_read_from_cstring("(print 1)");
si_safe_eval(2, form, ECL_NIL);
si_safe_eval(3, form, ECL_NIL, ecl_make_fixnum(3)); /* on error function will return 3 */
@end example

View file

@ -231,7 +231,7 @@ the resulting compare-and-swap expansions.
@defun mp:remcas symbol
Remove a compare-and-swap expansion. It is an equivalent of
@code{fmakeunbound (setf symbol)} for cas expansions.
@code{fmakunbound (setf symbol)} for cas expansions.
@end defun
@lspindex mp:get-cas-expansion

View file

@ -340,7 +340,7 @@ Environment accessors.
@defun ext:getpid
@defunx ext:getuid
@defunx ext:getcwd &optional (change-default-pathname-defaults NIL)
@defunx ext:chdir directory (change-default-pathname-defaults T)
@defunx ext:chdir directory &optional (change-default-pathname-defaults T)
@defunx ext:file-kind filename follow-symlinks-p
@defunx ext:copy-file filename destination-filename
@defunx ext:chmod filename mode

View file

@ -22,7 +22,7 @@ Common Lisp and C equivalence
@item @clhs{f_cp_rdt.htm,copy-readtable} @tab cl_object cl_copy_readtable(cl_narg narg, ...)
@item @clhs{f_mk_dis.htm,make-dispatch-macro-character} @tab cl_object cl_make_dispatch_macro_character(cl_narg narg, cl_object char, ...)
@item @clhs{f_rd_rd.htm,read} @tab cl_object cl_read(cl_narg narg, ...)
@item @clhs{f_rd_rd.htm,read-preerving-whitespace} @tab cl_object cl_read_preserving_whitespace(cl_narg narg, ...)
@item @clhs{f_rd_rd.htm,read-preserving-whitespace} @tab cl_object cl_read_preserving_whitespace(cl_narg narg, ...)
@item @clhs{f_rd_de1.htm,read-delimited-list} @tab cl_object cl_read_delimited_list(cl_narg narg, cl_object char, ...)
@item @clhs{f_rd_fro.htm,read-from-string} @tab cl_object cl_read_from_string(cl_narg narg, cl_object string, ...)
@item @clhs{f_rdtab1.htm,readtable-case} @tab cl_object cl_readtable_case(cl_object readtable)

View file

@ -4,12 +4,12 @@
@subsection Redefining a defstruct structure
@ansi{} says that consequences of redefining a @code{defstruct} are
undefined. @ecl{} defines this behavior to siganal an error if the new
undefined. ECL defines this behavior to signal an error if the new
structure is not compatible. Structures are incompatible when:
@table @asis
@item They have a different number of slots
This is particularily important for other structures which could have
This is particularly important for other structures which could have
included the current one and for already defined instances.
@item Slot name, type or offset is different