[Git][cmucl/cmucl][master] 6 commits: Restore hevea support for buliding cmu-user
Raymond Toy
rtoy at common-lisp.net
Tue Mar 6 04:18:42 UTC 2018
Raymond Toy pushed to branch master at cmucl / cmucl
Commits:
e3c4759d by Philip Fominykh at 2018-02-13T00:20:33-05:00
Restore hevea support for buliding cmu-user
- - - - -
3be1f5ba by Philip Fominykh at 2018-02-13T00:22:15-05:00
Improved function signature rendering in cmu-user html version
- - - - -
ccd159f1 by Philip Fominykh at 2018-03-05T00:59:37-05:00
Remove extra paragraph generation in Hevea definitions.
Added argument #5 to \layout to act as prelude. Putting index and
spacing commands there eliminates extra paragraph.
- - - - -
7b9be9a8 by Philip Fominykh at 2018-03-05T01:01:53-05:00
Hevea cmu-user generation cleanups.
- - - - -
9b55c3e4 by Philip Fominykh at 2018-03-05T01:03:02-05:00
Merge branch 'master' into pfominykh-cmu-user-fixes
- - - - -
efc3d8c5 by Raymond Toy at 2018-03-06T04:18:37+00:00
Merge branch 'pfominykh-cmu-user-fixes' into 'master'
Restore hevea support for cmu-user
See merge request cmucl/cmucl!35
- - - - -
10 changed files:
- src/docs/cmu-user/Makefile
- src/docs/cmu-user/aliens.tex
- src/docs/cmu-user/cmu-user.hva
- src/docs/cmu-user/cmucl.css
- src/docs/cmu-user/cross-referencing.tex
- src/docs/cmu-user/debugger.tex
- src/docs/cmu-user/extensions.tex
- src/docs/cmu-user/introduction.tex
- src/docs/cmu-user/ipc.tex
- src/docs/cmu-user/unicode.tex
Changes:
=====================================
src/docs/cmu-user/Makefile
=====================================
--- a/src/docs/cmu-user/Makefile
+++ b/src/docs/cmu-user/Makefile
@@ -70,7 +70,7 @@ all: cmu-user.pdf
# the "-fix" option to hevea makes it run as many times as necessary
# to resolve all cross-references and generate an index.
-%.html : %.tex $(FILES)
+%.html : %.tex $(FILES) cmu-user.hva
$(HEVEA) -fix cmu-user.hva $<
$(HACHA) -tocbis $@
-$(TIDY) -m *.html
@@ -105,6 +105,7 @@ clean:
rm -f *.log *.bbl *.blg *.ps *.pdf *.aux *.lof *.toc *.out *.ilg
rm -f *.vdx *.cdx *.tdx *.fdx *.idx *.cnd *.fnd *.tnd *.vnd *.haux
rm -f *.html *.hcnd *.htnd *.hvnd *.hfnd *.htoc
+ rm -f cmu-user.css
index:
makeindex cmu-user.tdx -o cmu-user.tnd
=====================================
src/docs/cmu-user/aliens.tex
=====================================
--- a/src/docs/cmu-user/aliens.tex
+++ b/src/docs/cmu-user/aliens.tex
@@ -295,7 +295,7 @@ This section describes the basic operations on Alien values.
\subsection{Alien Access Operations}
-\begin{defun}{alien:}{deref}{\args{\var{pointer-or-array} \amprest \var{indices}}}
+\begin{defun}{alien:}{deref}{\args{\var{pointer-or-array} \amprest{} \var{indices}}}
This function returns the value pointed to by an Alien pointer or
the value of an Alien array element. If a pointer, an optional
@@ -766,7 +766,7 @@ and two return values (\var{a} and \var{i}).
macro:
\begin{defmac}{alien:}{def-callback}{\var{name} (\var{return-type}
- \mstar{(arg-name arg-type)}) \ampbody\ body}
+ \mstar{(arg-name arg-type)}) \ampbody{} \var{body}}
This macro defines a Lisp function that can be called from C and a
Lisp variable. The arguments to the function must be alien types,
and the return type must also be an alien type. This Lisp function
@@ -789,7 +789,7 @@ macro:
\code{def-callback} macro.
\end{defmac}
-\begin{defmac}{alien:}{callback-funcall}{\var{callback-name} \amprest
+\begin{defmac}{alien:}{callback-funcall}{\var{callback-name} \amprest{}
\var{args}}
This macro does the necessary stuff to call the callback named
\var{callback-name} with the given arguments.
=====================================
src/docs/cmu-user/cmu-user.hva
=====================================
--- a/src/docs/cmu-user/cmu-user.hva
+++ b/src/docs/cmu-user/cmu-user.hva
@@ -4,18 +4,24 @@
% to HTML using Hevea. By Luc Maranget and Eric Marsden.
\newif\ifhmode\hmodefalse
-\newcommand{\xspace}{}
+\newcommand{\pdfinfo}[1]{\@print{<!--} #1 \@print{-->}}
\let\hbox\mbox
\def\hfil{}
\def\hfill{}
\newcommand{\parbox}[3][]{\mbox{#3}}
\newcommand{\lengthtest}[1]{true}
\newenvironment{minipage}[2][]{}{}
-\newcommand{\layout}[4][]
- {\@open{DIV}{align=left}
+\newcommand{\layout}[5][]
+ {\@open{DIV}{align=left}#5%
[#4] \\
+ \begin{tabbing}
\fcnname{#1}\fcnname{#2} #3 \@print{ }
+ \end{tabbing}
\@close{DIV}}
+\newcommand{\keys}[1]{\code{\&key}\@print{ }\= #1}
+
+\renewcommand{\textgreater}{\@print{>}}
+\renewcommand{\textless}{\@print{<}}
% \newcommand{\layout}[4][]
% {\begin{tabular}
@@ -26,13 +32,12 @@
% \end{tabular}}
-\newcommand{\fcntype}[1]{\@open{TT}{class=function-type}#1\@close{TT}}
-\newcommand{\argtype}[1]{\@open{TT}{class=argument-type}#1\@close{TT}}
-\newcommand{\fcnname}[1]{\@open{TT}{class=function-name}#1\@close{TT}}
-\newcommand{\var}[1]{\@open{TT}{class=variable}#1\@close{TT}}
-\newcommand{\code}[1]{\@open{TT}{class=code}#1\@close{TT}}
-\newcommand{\file}[1]{\@open{TT}{class=filename}#1\@close{TT}}
-
+\newcommand{\fcntype}[1]{\@styleattr{TT}{class=function-type}#1\@clearstyle}
+\newcommand{\argtype}[1]{\@styleattr{TT}{class=argument-type}#1\@clearstyle}
+\newcommand{\fcnname}[1]{\@styleattr{TT}{class=function-name}#1\@clearstyle}
+\newcommand{\var}[1]{\@styleattr{TT}{class=variable}#1\@clearstyle}
+\newcommand{\code}[1]{\@styleattr{TT}{class=code}#1\@clearstyle}
+\newcommand{\file}[1]{\@styleattr{TT}{class=filename}#1\@clearstyle}
%% Define a new type
%%
@@ -40,40 +45,40 @@
%% some description
%% \end{deftp}
\newenvironment{deftp}[3]
- {\par\bigskip\index[types]{#2|textbf}%
- \layout{#2}{\var{#3}}{#1}
+ {\layout{#2}{\var{#3}}{#1}%
+ {\bigskip\index[types]{#2|textbf}}
\begin{quote}}
{\end{quote}}
%% Define a function
%%
-%% \begin{defun}{pkg}{name}{params}
+%% \begin{defun}[suffix]{pkg}{name}{params}
%% \defunx[pkg]{name}{params}
%% description of function
%% \end{defun}
-\newenvironment{defun}[3]
- {\par\defunvspace\fnindexbold{#2}\label{FN:#2}%
- \layout[#1]{#2}{#3}{Function}
+\newenvironment{defun}[4][]
+ {\layout[#2]{#3}{#4}{Function}%
+ {\defunvspace\fnindexbold{#3}\label{FN:#3#1}}
\begin{quote}}
{\end{quote}}
\newcommand{\defunx}[3][\mbox{}]{%
- \par\fnindexbold{#2}\label{FN:#2}%
- \layout[#1]{#2}{#3}{Function}}
+ \layout[#1]{#2}{#3}{Function}%
+ {\fnindexbold{#2}\label{FN:#2}}}
%% Define a macro
%%
-%% \begin{defmac}{pkg}{name}{params}
+%% \begin{defmac}[suffix]{pkg}{name}{params}
%% \defmacx[pkg]{name}{params}
%% description of macro
%% \end{defmac}
-\newenvironment{defmac}[3]{%
- \par\defunvspace\fnindexbold{#2}\label{FN:#2}%
- \layout[#1]{#2}{#3}{Macro}
+\newenvironment{defmac}[4][]{%
+ \layout[#2]{#3}{#4}{Macro}%
+ {\defunvspace\fnindexbold{#3}\label{FN:#3#1}}
\begin{quote}}
{\end{quote}}
\newcommand{\defmacx}[3][\mbox{}]{%
- \par\fnindexbold{#2}\label{FN:#2}%
- \layout[#1]{#2}{#3}{Function}}
+ \layout[#1]{#2}{#3}{Function}%
+ {\fnindexbold{#2}\label{FN:#2}}}
%% Define a variable
%%
@@ -82,13 +87,13 @@
%% description of defvar
%% \end{defvar}
\newenvironment{defvar}[2]{%
- \par\defunvspace\vrindexbold{#2}\label{VR:#2}
- \layout[#1]{*#2*}{}{Variable}
+ \layout[#1]{*#2*}{}{Variable}%
+ {\defunvspace\vrindexbold{#2}\label{VR:#2}}
\begin{quote}}
{\end{quote}}
\newcommand{\defvarx}[2][\mbox{}]{%
- \par\vrindexbold{#2}\label{VR:#2}
- \layout[#1]{*#2*}{}{Variable}}
+ \layout[#1]{*#2*}{}{Variable}%
+ {\vrindexbold{#2}\label{VR:#2}}}
%% Define a constant
%%
@@ -97,11 +102,12 @@
%% description of defconst
%% \end{defconst}
\newenvironment{defconst}[2]{%
- \defunvspace\defconstx[#1]{#2}
+ \layout[#1]{#2}{}{Constant}%
+ {\defunvspace}
\begin{quote}}
{\end{quote}}
\newcommand{\defconstx}[2][\mbox{}]{%
- \layout[#1]{#2}{}{Constant}}
+ \layout[#1]{#2}{}{Constant}{}}
@@ -110,10 +116,10 @@
{\@open{BLOCKQUOTE}{class=example}\begin{alltt}}
{\end{alltt}\@close{BLOCKQUOTE}}
\newenvironment{lisp}
- {\@open{BLOCKQUOTE}{CLASS=lisp} \begin{alltt}}
+ {\@open{BLOCKQUOTE}{CLASS=lisp}\begin{alltt}}
{\end{alltt}\@close{BLOCKQUOTE}}
-\newcommand{\cmucl}{CMUCL}
-
+\newcommand{\cmucl}{{\scshape cmucl}}
+
% there are no page numbers in HTML, so we need to override certain
% cross-referencing macros
@@ -134,7 +140,7 @@
% disable ``this document generated by'' footer
-\setcounter{footer}{0}
+\def\@footer{}
% \htmlhead{\@print{
% <a href="../../">CMUCL</a> ->
@@ -165,12 +171,19 @@
\setcounter{cuttingdepth}{10}
\input{report.hva}
-\input{fancysection.hva}
+%%\input{fancysection.hva}
+\usepackage{color}
\definecolor{chapter}{rgb}{1, 1, 0.74}
\definecolor{part}{rgb}{1, 1, 0.81}
\definecolor{section}{rgb}{1, 1, 0.83}
\definecolor{subsection}{rgb}{1, 1, 0.89}
\definecolor{subsubsection}{rgb}{1, 1, 0.93}
+\newstyle{.chapter}{padding:0.5ex;background-color:\@getstylecolor{chapter}}
+\newstyle{.section} {padding:.5ex;background-color:\@getstylecolor{section}}%
+\newstyle{.subsection} {padding:0.3ex;background-color:\@getstylecolor{subsection}}%
+\newstyle{.subsubsection} {padding:0.5ex;background-color:\@getstylecolor{subsubsection}}%
+\newstyle{.paragraph} {padding:0.5ex;background-color:\@getstylecolor{paragraph}}%
\renewcommand{\@bodyargs}{}
+
% EOF
=====================================
src/docs/cmu-user/cmucl.css
=====================================
--- a/src/docs/cmu-user/cmucl.css
+++ b/src/docs/cmu-user/cmucl.css
@@ -35,7 +35,7 @@ h3 {
.code {
background: #faf0e6;
border:solid #faf0e6 1px;
- white-space:pre;
+ white-space:pre-line;
}
.technical {
=====================================
src/docs/cmu-user/cross-referencing.tex
=====================================
--- a/src/docs/cmu-user/cross-referencing.tex
+++ b/src/docs/cmu-user/cross-referencing.tex
@@ -142,7 +142,7 @@ source file), and so is identified by the XREF facility by a string.
\end{defun}
-\begin{defun}{xref:}{xref-context-file}{context}
+\begin{defun}{xref:}{xref-context-file}{\var{context}}
Return the truename (in the sense of the variable
\vindexed{compile-file-truename}) of the source file from which the
referencing forms were compiled. This slot will be \nil{} if the
@@ -150,7 +150,7 @@ source file), and so is identified by the XREF facility by a string.
listener.
\end{defun}
-\begin{defun}{xref:}{xref-context-source-path}{context}
+\begin{defun}{xref:}{xref-context-source-path}{\var{context}}
Return a list of positive integers identifying the form that
contains the cross-reference. The first integer in the source-path
is the number of the top-level form containing the cross-reference
=====================================
src/docs/cmu-user/debugger.tex
=====================================
--- a/src/docs/cmu-user/debugger.tex
+++ b/src/docs/cmu-user/debugger.tex
@@ -998,8 +998,7 @@ printing of the trace information and conditional breakpoints on
function entry or exit.
\begin{defmac}{}{trace}{%
- \args{\mstar{option global-value} \mstar{name \mstar{option
- value}}}}
+ \args{\mstar{option global-value} \mstar{name \mstar{option value}}}}
\code{trace} is a debugging tool that prints information when
specified functions are called. In its simplest form:
=====================================
src/docs/cmu-user/extensions.tex
=====================================
--- a/src/docs/cmu-user/extensions.tex
+++ b/src/docs/cmu-user/extensions.tex
@@ -162,9 +162,7 @@ IEEE floating point specifies four possible rounding modes:
\findexed{truncate} function.
\end{Lentry}
-\paragraph{Warning:}
-
-Although the rounding mode can be changed with
+Warning: Although the rounding mode can be changed with
\code{set-floating-point-modes}, use of any value other than the
default (\kwd{nearest}) can cause unusual behavior, since it will
affect rounding done by \llisp{} system code as well as rounding in
@@ -267,7 +265,7 @@ These functions can be used to modify or read the floating point modes:
To make handling control of floating-point exceptions, the following
macro is useful.
-\begin{defmac}{ext:}{with-float-traps-masked}{traps \ampbody\ body}
+\begin{defmac}{ext:}{with-float-traps-masked}{\var{traps} \ampbody\ \var{body}}
\code{body} is executed with the selected floating-point exceptions
given by \code{traps} masked out (disabled). \code{traps} should be
a list of possible floating-point exceptions that should be ignored.
@@ -839,7 +837,7 @@ finalization is used to close the underlying file descriptor.
\section{Describe}
-\begin{defun}{}{describe}{ \args{\var{object} \&optional{} \var{stream}}}
+\begin{defun}{}{describe}{ \args{\var{object} \ampoptional{} \var{stream}}}
The \code{describe} function prints useful information about
\var{object} on \var{stream}, which defaults to
@@ -1947,7 +1945,8 @@ way to browse the library.
\section{Generalized Function Names}
-\begin{defmac}{ext:}{define-function-name-syntax}{name (var) \ampbody\ body}
+\begin{defmac}{ext:}{define-function-name-syntax}{%
+ \var{name} (\var{var}) \ampbody\ \var{body}}
Define lists starting with the symbol \code{name} as a new extended
function name syntax.
@@ -1969,7 +1968,7 @@ way to browse the library.
user-defined package.
\end{defmac}
-\begin{defun}{ext:}{valid-function-name-p}{name}
+\begin{defun}{ext:}{valid-function-name-p}{\var{name}}
Returns two values:
\begin{itemize}
@@ -1999,7 +1998,7 @@ function is called and
standardized method combinations like \code{progn}, \code{and}, etc.
\end{itemize}
-\begin{defgeneric}[-generic]{pcl:}{no-primary-method}{gf \&rest args}
+\begin{defgeneric}[-generic]{pcl:}{no-primary-method}{\var{gf} \amprest{} \var{args}}
In \cmucl, this generic function is called in the above erroneous
cases. The parameter \code{gf} is the generic function being
called, and \code{args} is a list of actual arguments in the generic
@@ -2007,7 +2006,7 @@ function is called and
\end{defgeneric}
\begin{defmethod}[-standard]{pcl:}{no-primary-method}{%
- (gf standard-generic-function) \&rest args}
+ (\var{gf} \argtype{standard-generic-function}) \amprest{} \var{args}}
This method signals a continuable error of type
\code{pcl:no-primary-method-error}.
\end{defmethod}
@@ -2292,7 +2291,7 @@ methods, as it would be the case when a function is inlined somewhere
else. Because of this, the function \code{pcl:flush-emf-cache} is
provided for forcing such an update of effective methods.
-\begin{defun}{pcl:}{flush-emf-cache}{\&optional gf}
+\begin{defun}{pcl:}{flush-emf-cache}{\ampoptional{} \var{gf}}
Flush cached effective method functions. If \code{gf} is supplied,
it should be a generic function metaobject or the name of a generic
function, and this function flushes all cached effective methods for
@@ -2341,7 +2340,7 @@ when the generic function is called depending on the value of
Support for sealing classes and generic functions have been
implemented. Please note that this interface is subject to change.
-\begin{defmac}{pcl:}{seal}{name (var) \amprest\ specifiers}
+\begin{defmac}{pcl:}{seal}{\var{name} (\var{var}) \amprest{} \var{specifiers}}
Seal \code{name} with respect to the given specifiers; \code{name}
can be the name of a class or generic-function.
@@ -2352,7 +2351,7 @@ implemented. Please note that this interface is subject to change.
Sealing violations signal an error of type \code{pcl:sealed-error}.
\end{defmac}
-\begin{defun}{pcl:}{unseal}{name-or-object}
+\begin{defun}{pcl:}{unseal}{\var{name-or-object}}
Remove seals from \code{name-or-object}.
\end{defun}
@@ -2438,8 +2437,8 @@ extensions.
\subsection{Extensions}
-\begin{defun}{}{constantly}{value \&optional val1 val2 \&rest
- more-values}
+\begin{defun}{}{constantly}{%
+ \var{value} \ampoptional{} \var{val1} \var{val2} \amprest{} \var{more-values}}
As an extension, \cmucl{} allows \code{constantly} to accept more
than one value which are returned as multiple values.
\end{defun}
@@ -2502,7 +2501,7 @@ innermost fwrapper object. Likewise, if a function is fwrapped,
\code{(setf fdefinition)} will set the primary function in the
innermost fwrapper.
-\begin{defmac}{fwrappers:}{define-fwrapper}{name lambda-list \ampbody{} body}
+\begin{defmac}{fwrappers:}{define-fwrapper}{\var{name} \var{lambda-list} \ampbody{} \var{body}}
This macro is like \code{defun}, but defines a function named
\var{name} that can be used as an fwrapper definition.
@@ -2518,8 +2517,8 @@ innermost fwrapper.
arguments.
\end{defmac}
-\begin{defun}{fwrappers:}{fwrap}{function-name fwrapper \&key type
- user-data}
+\begin{defun}{fwrappers:}{fwrap}{\var{function-name} \var{fwrapper} %
+ \keys{\kwd{type} \kwd{user-data}}}
This function wraps function \code{function-name} in an fwrapper
\var{fwrapper} which was defined with \code{define-fwrapper}.
@@ -2534,58 +2533,58 @@ innermost fwrapper.
Value is the fwrapper object created.
\end{defun}
-\begin{defun}{fwrappers:}{funwrap}{function-name \&key type test}
+\begin{defun}{fwrappers:}{funwrap}{\var{function-name} \keys{\kwd{type} \kwd{test}}}
Remove fwrappers from the function named \var{function-name}. If
\var{type} is supplied, remove fwrappers whose type is \code{equal}
to \var{type}. If \var{test} is supplied, remove fwrappers
satisfying \var{test}.
\end{defun}
-\begin{defun}{fwrappers:}{find-fwrapper}{function-name \&key type test}
+\begin{defun}{fwrappers:}{find-fwrapper}{\var{function-name} \keys{\kwd{type} \kwd{test}}}
Find an fwrapper of \var{function-name}. If \var{type} is supplied,
find an fwrapper whose type is \code{equal} to \var{type}. If
\var{test} is supplied, find an fwrapper satisfying \var{test}.
\end{defun}
-\begin{defun}{fwrappers:}{update-fwrapper}{fwrapper}
+\begin{defun}{fwrappers:}{update-fwrapper}{\var{fwrapper}}
Update the funcallable instance function of the fwrapper object
\var{fwrapper} from the definition of its function that was
defined with \code{define-fwrapper}. This can be used to update
fwrappers after changing a \code{define-fwrapper}.
\end{defun}
-\begin{defun}{fwrappers:}{update-fwrappers}{function-name \&key type test}
+\begin{defun}{fwrappers:}{update-fwrappers}{\var{function-name} \keys{\kwd{type} \kwd{test}}}
Update fwrappers of \var{function-name}; see \code{update-fwrapper}.
If \var{type} is supplied, update fwrappers whose type is
\code{equal} to \var{type}. If \var{test} is supplied, update fwrappers
satisfying \var{test}.
\end{defun}
-\begin{defun}{fwrappers:}{set-fwrappers}{function-name fwrappers}
+\begin{defun}{fwrappers:}{set-fwrappers}{\var{function-name} \var{fwrappers}}
Set \var{function-names}'s fwrappers to elements of the list
\var{fwrappers}, which is assumed to be ordered from outermost to
innermost. \var{fwrappers} null means remove all fwrappers.
\end{defun}
-\begin{defun}{fwrappers:}{list-fwrappers}{function-name}
+\begin{defun}{fwrappers:}{list-fwrappers}{\var{function-name}}
Return a list of all fwrappers of \var{function-name}, ordered
from outermost to innermost.
\end{defun}
-\begin{defun}{fwrappers:}{push-fwrapper}{fwrapper function-name}
+\begin{defun}{fwrappers:}{push-fwrapper}{\var{fwrapper} \var{function-name}}
Prepend fwrapper \var{fwrapper} to the definition of
\var{function-name}. Signal an error if \var{function-name} is an
undefined function.
\end{defun}
-\begin{defun}{fwrappers:}{delete-fwrapper}{fwrapper function-name}
+\begin{defun}{fwrappers:}{delete-fwrapper}{\var{fwrapper} \var{function-name}}
Remove fwrapper \var{fwrapper} from the definition of
\var{function-name}. Signal an error if \var{function-name} is an
undefined function.
\end{defun}
-\begin{defmac}{fwrappers:}{do-fwrappers}{(var fdefn \ampoptional{}
- result) \ampbody{} body}
+\begin{defmac}{fwrappers:}{do-fwrappers}{(\var{var} \var{fdefn} \ampoptional{}
+ \var{result}) \ampbody{} \var{body}}
Evaluate \var{body} with \var{var} bound to consecutive fwrappers of
\var{fdefn}. Return \var{result} at the end. Note that \var{fdefn}
must be an \code{fdefn} object. You can use
@@ -2772,18 +2771,18 @@ that order.
beginning of this list.
\end{defvar}
-\begin{defmac}{ext:}{defmodule}{name \amprest{} files}
+\begin{defmac}{ext:}{defmodule}{\var{name} \amprest{} \var{files}}
Defines a module by registering the files that need to be loaded
when the module is required. If \var{name} is a symbol, its print
name is used after downcasing it.
\end{defmac}
-\begin{defun}{ext:}{module-provide-cmucl-defmodule}{module-name}
+\begin{defun}{ext:}{module-provide-cmucl-defmodule}{\var{module-name}}
This function is the module-provider for modules registered by a
\code{ext:defmodule} form.
\end{defun}
-\begin{defun}{ext:}{module-provide-cmucl-library}{module-name}
+\begin{defun}{ext:}{module-provide-cmucl-library}{\var{module-name}}
This function is the module-provider for \cmucl's libraries,
including Gray streams, simple streams, CLX, CLM, Hemlock,
\emph{etc}.
@@ -2830,7 +2829,7 @@ recording of strings, call \code{intl:translation-enable}.
Disablle recording of translatable strings.
\end{defun}
-\begin{defun}{intl:}{setlocale}{\ampoptional{} locale}
+\begin{defun}{intl:}{setlocale}{\ampoptional{} \var{locale}}
Sets the locale to the locale specified by \var{locale}. If
\var{locale} is not give or is \nil, the locale is determined by
look at the environment variables \code{LANGUAGE}, \code{LC\_ALL},
@@ -2840,19 +2839,19 @@ recording of strings, call \code{intl:translation-enable}.
The default locale is ``C''.
\end{defun}
-\begin{defun}{intl:}{textdomain}{domain}
+\begin{defun}{intl:}{textdomain}{\var{domain}}
Set the default domain to the domain specified by \var{domain}.
Typically, this only needs to be done at the top of each source
file. This is used to \code{gettext} and \code{ngettext} to set the
domain for the message string.
\end{defun}
-\begin{defmac}{intl:}{gettext}{string}
+\begin{defmac}{intl:}{gettext}{\var{string}}
Look up the specified string, \var{string}, in the current message
domain and return its translation.
\end{defmac}
-\begin{defun}{intl:}{dgettext}{domain string}
+\begin{defun}{intl:}{dgettext}{\var{domain} \var{string}}
Look up the specified string, \var{string}, in the message domain,
\var{domain}. The translation is returned.
@@ -2861,14 +2860,14 @@ recording of strings, call \code{intl:translation-enable}.
\code{intl::dump-pot-files}.)
\end{defun}
-\begin{defmac}{intl:}{ngettext}{singular plural n}
+\begin{defmac}{intl:}{ngettext}{\var{singular} \var{plural} \var{n}}
Look up the singular or plural form of a message in the default
domain. The singular form is \var{singular}; the plural is
\var{plural}. The number of items is specified by \var{n} in case
the correct translation depends on the actual number of items.
\end{defmac}
-\begin{defun}{intl:}{dngettext}{domain singular plural n}
+\begin{defun}{intl:}{dngettext}{\var{domain} \var{singular} \var{plural} \var{n}}
Look up the singular or plural form of a message in the specified
domain, \var{domain}. The singular form is \var{singular}; the
plural is \var{plural}. The number of items is specified by \var{n}
@@ -2880,8 +2879,7 @@ recording of strings, call \code{intl:translation-enable}.
created. (See \code{intl::dump-pot-files}.)
\end{defun}
-\begin{defun}{intl::}{dump-pot-files}{\keys copyright
- output-directory}
+\begin{defun}{intl::}{dump-pot-files}{\keys{\kwd{copyright} \kwd{output-directory}}}
Dumps the translatable strings recorded by \code{dgettext} and
\code{dngettext}. The message template file (pot file) is written
to a file in the directory specified by \var{output-directory}, and
@@ -2895,7 +2893,7 @@ recording of strings, call \code{intl:translation-enable}.
This is a list of directory pathnames where the translations can be found.
\end{defvar}
-\begin{defun}{intl:}{install}{\ampoptional{} (rt *readtable*)}
+\begin{defun}{intl:}{install}{\ampoptional{} (\var{rt} \var{*readtable*})}
Installs reader macros and comment reader into the specified
readtable as explained below. The readtable defaults to
\var{*readtable*}.
=====================================
src/docs/cmu-user/introduction.tex
=====================================
--- a/src/docs/cmu-user/introduction.tex
+++ b/src/docs/cmu-user/introduction.tex
@@ -80,7 +80,7 @@ See also \verb|cmucl(1)|. Currently \cmucl{} accepts the following
switches:
\begin{Lentry}
-\item[\code{--help}] Same as \code{-help}.
+\item[\code{-{}-help}] Same as \code{-help}.
\item[\code{-help}] Print ou the command line options and exit.
=====================================
src/docs/cmu-user/ipc.tex
=====================================
--- a/src/docs/cmu-user/ipc.tex
+++ b/src/docs/cmu-user/ipc.tex
@@ -161,7 +161,7 @@ could use \code{prin1-to-string} locally, send the string, and use
\end{defmac}
\begin{defmac}{wire:}{remote-value-bind}{%
- \args{\var{wire} (\mstar{variable}) remote-form
+ \args{\var{wire} (\mstar{variable}) \var{remote-form}
\mstar{local-forms}}}
\code{remote-value-bind} is similar to \code{multiple-value-bind}
=====================================
src/docs/cmu-user/unicode.tex
=====================================
--- a/src/docs/cmu-user/unicode.tex
+++ b/src/docs/cmu-user/unicode.tex
@@ -348,10 +348,10 @@ this encoding and handle the surrogate pairs correctly.
\begin{defun}{}{string=}{\args \var{s1} \var{s2} \keys{\kwd{start1}
\kwd{end1} \kwd{start2} \kwd{end2}}}
\defunx{string/=}{\args \var{s1} \var{s2} \keys{\kwd{start1} \kwd{end1} \kwd{start2} \kwd{end2}}}
- \defunx{string$<$}{\args \var{s1} \var{s2} \keys{\kwd{start1} \kwd{end1} \kwd{start2} \kwd{end2}}}
- \defunx{string$>$}{\args \var{s1} \var{s2} \keys{\kwd{start1} \kwd{end1} \kwd{start2} \kwd{end2}}}
- \defunx{string$<$=}{\args \var{s1} \var{s2} \keys{\kwd{start1} \kwd{end1} \kwd{start2} \kwd{end2}}}
- \defunx{string$>$=}{\args \var{s1} \var{s2} \keys{\kwd{start1} \kwd{end1} \kwd{start2} \kwd{end2}}}
+ \defunx{string\textless}{\args \var{s1} \var{s2} \keys{\kwd{start1} \kwd{end1} \kwd{start2} \kwd{end2}}}
+ \defunx{string\textgreater}{\args \var{s1} \var{s2} \keys{\kwd{start1} \kwd{end1} \kwd{start2} \kwd{end2}}}
+ \defunx{string\textless=}{\args \var{s1} \var{s2} \keys{\kwd{start1} \kwd{end1} \kwd{start2} \kwd{end2}}}
+ \defunx{string\textgreater=}{\args \var{s1} \var{s2} \keys{\kwd{start1} \kwd{end1} \kwd{start2} \kwd{end2}}}
The string comparison is done in codepoint order. (This is
different from just comparing the order of the individual characters
due to surrogate pairs.) Unicode collation is not done.
@@ -443,7 +443,7 @@ The Unicode data base is stored in compressed form in the file
\file{ext-formats:unidata.bin}. If this file is not found, Unicode
support is severely reduced; you can only use ASCII characters.
-\begin{defun}{}{open}{\args \var{filename} \amprest \var{options}
+\begin{defun}{}{open}{\args \var{filename} \amprest{} \var{options}
\keys{\kwd{direction} \kwd{element-type} \kwd{if-exists}
\kwd{if-does-not-exist} \morekeys \kwd{class} \kwd{mapped}
\kwd{input-handle} \kwd{output-handle}
@@ -497,7 +497,7 @@ support is severely reduced; you can only use ASCII characters.
formats and composing external formats.
\end{defun}
-\begin{defun}{extensions:}{describe-external-format}{external-format}
+\begin{defun}{extensions:}{describe-external-format}{\var{external-format}}
Print a description of the given \var{external-format}. This may
cause the external format to be loaded (silently) if it is not
already loaded.
@@ -627,12 +627,12 @@ An external format basically needs two functions:
external format is defined using the macro
\code{stream::define-external-format}.
-\begin{defmac}[base]{stream:}{define-external-format}{\args \var{name}
- (\keys{\var{base} \var{min} \var{max} \var{size}
- \var{documentation}})
+% tricky
+\begin{defmac}[base]{stream::}{define-external-format}{\args \var{name}
+ (\keys{\kwd{base} \kwd{min} \kwd{max} \kwd{size} \kwd{documentation}})
(\amprest{} \var{slots})
- \morekeys{\var{octets-to-code} \var{code-to-octets}
- \var{flush-state} \var{copy-state}}}
+ \\
+ \= \ampoptional{} \var{octets-to-code} \var{code-to-octets} \var{flush-state} \var{copy-state}}
If \kwd{base} is not given, this defines a new external format of
@@ -726,7 +726,7 @@ external format is defined using the macro
\subsection{Composing External Formats}
\begin{defmac}{stream:}{define-composing-external-format}{\args \var{name}
- (\keys{\var{min} \var{max} \var{size} \var{documentation}}) \var{input}
+ (\keys{\kwd{min} \kwd{max} \kwd{size} \kwd{documentation}}) \var{input}
\var{output}}
This is the same as \code{define-external-format}, except that a
composing external format is created.
View it on GitLab: https://gitlab.common-lisp.net/cmucl/cmucl/compare/52a93a052ba57908d30861466fa5372e8fc1c0da...efc3d8c54676c1aec136a2817be6100bdc395563
---
View it on GitLab: https://gitlab.common-lisp.net/cmucl/cmucl/compare/52a93a052ba57908d30861466fa5372e8fc1c0da...efc3d8c54676c1aec136a2817be6100bdc395563
You're receiving this email because of your account on gitlab.common-lisp.net.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mailman.common-lisp.net/pipermail/cmucl-cvs/attachments/20180306/b0f02625/attachment-0001.html>
More information about the cmucl-cvs
mailing list