Mercurial > pub > dyncall > dyncall
changeset 76:7ca46969e0ad
- tweaks in manual, mainly for html generation
| author | cslag |
|---|---|
| date | Mon, 21 Mar 2016 01:15:37 +0100 |
| parents | a59ae4370202 |
| children | e441ef3ec782 |
| files | doc/manual/callconvs/callconv_arm32.tex doc/manual/callconvs/callconv_arm64.tex doc/manual/callconvs/callconv_mips.tex doc/manual/callconvs/callconv_ppc32.tex doc/manual/callconvs/callconv_sparc.tex doc/manual/callconvs/callconv_x64.tex doc/manual/callconvs/callconv_x86.tex doc/manual/manual_build.tex doc/manual/manual_devel.tex doc/manual/manual_tex4ht.cfg |
| diffstat | 10 files changed, 104 insertions(+), 94 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/manual/callconvs/callconv_arm32.tex Sun Mar 20 18:44:41 2016 +0100 +++ b/doc/manual/callconvs/callconv_arm32.tex Mon Mar 21 01:15:37 2016 +0100 @@ -27,14 +27,14 @@ The word size is 32 bits (and the programming model is LLP64).\\ Basically, this family of microprocessors can be run in 2 major modes:\\ \\ -\begin{tabular}{2 B} +\begin{tabular*}{0.75\textwidth}{2 B} \hline Mode & Description\\ \hline {\bf ARM} & 32bit instruction set\\ {\bf THUMB} & compressed instruction set using 16bit wide instruction encoding\\ \hline -\end{tabular} +\end{tabular*} \\ \\ For more details, take a look at the ARM-THUMB Procedure Call Standard (ATPCS) \cite{ATPCS}, the Procedure Call Standard for the ARM Architecture (AAPCS) \cite{AAPCS}, as well as the Debian ARM EABI port wiki \cite{armeabi}. @@ -55,7 +55,7 @@ In ARM mode, the ARM32 processor has sixteen 32 bit general purpose registers, namely r0-r15:\\ \\ \begin{table}[h] -\begin{tabular}{3 B} +\begin{tabular*}{0.75\textwidth}{3 B} \hline Name & Brief description\\ \hline @@ -69,7 +69,7 @@ {\bf r14} & link register, permanent\\ {\bf r15} & program counter (note: due to pipeline, r15 points to 2 instructions ahead)\\ \hline -\end{tabular} +\end{tabular*} \caption{Register usage on arm32} \end{table} @@ -146,7 +146,7 @@ In THUMB mode, the ARM32 processor family supports eight 32 bit general purpose registers r0-r7 and access to high order registers r8-r15:\\ \\ \begin{table}[h] -\begin{tabular}{3 B} +\begin{tabular*}{0.75\textwidth}{3 B} \hline Name & Brief description\\ \hline @@ -161,7 +161,7 @@ {\bf r14} & link register, permanent\\ {\bf r15} & program counter (note: due to pipeline, r15 points to 2 instructions ahead)\\ \hline -\end{tabular} +\end{tabular*} \caption{Register usage on arm32 thumb mode} \end{table} @@ -255,7 +255,7 @@ \paragraph{Register usage} \begin{table}[h] -\begin{tabular}{3 B} +\begin{tabular*}{0.75\textwidth}{3 B} \hline Name & Brief description\\ \hline @@ -277,7 +277,7 @@ {\bf D16-D31}& Only available in ARMv7, aliases Q8-Q15.\\ {\bf FPSCR} & VFP status register.\\ \hline -\end{tabular} +\end{tabular*} \caption{Register usage on ARM Apple iOS} \end{table} @@ -301,7 +301,7 @@ \paragraph{Register usage} \begin{table}[h] -\begin{tabular}{3 B} +\begin{tabular*}{0.75\textwidth}{3 B} \hline Name & Brief description\\ \hline @@ -325,7 +325,7 @@ {\bf D1-D7} & aliases S2-S15, floating point arguments, double precision\\ {\bf FPSCR} & VFP status register.\\ \hline -\end{tabular} +\end{tabular*} \caption{Register usage on armhf} \end{table} @@ -372,7 +372,7 @@ % Cortex-*: ARMv7, Raspberry Pi 2, ... \begin{table}[h] -\begin{tabular}{lll} +\begin{tabular*}{0.75\textwidth}{lll} Arch & Platforms & Details \\ \hline ARMv4 & & \\ @@ -387,7 +387,7 @@ \hline ARMv8 & iPhone 6 and higher & 64bit support \\ \hline -\end{tabular} +\end{tabular*} \caption{Overview of ARM Architecture, Platforms and Details} \end{table}
--- a/doc/manual/callconvs/callconv_arm64.tex Sun Mar 20 18:44:41 2016 +0100 +++ b/doc/manual/callconvs/callconv_arm64.tex Mon Mar 21 01:15:37 2016 +0100 @@ -43,7 +43,7 @@ as q0-q31, d0-d31 and s0-s31, respectively, depending on their use:\\ \begin{table}[h] -\begin{tabular}{3 B} +\begin{tabular*}{0.75\textwidth}{3 B} \hline Name & Brief description\\ \hline @@ -59,7 +59,7 @@ {\bf SP} & permanent, stack pointer\\ {\bf PC} & program counter\\ \hline -\end{tabular} +\end{tabular*} \caption{Register usage on arm64} \end{table}
--- a/doc/manual/callconvs/callconv_mips.tex Sun Mar 20 18:44:41 2016 +0100 +++ b/doc/manual/callconvs/callconv_mips.tex Mon Mar 21 01:15:37 2016 +0100 @@ -46,7 +46,7 @@ \paragraph{Register usage} \begin{table}[h] -\begin{tabular}{lll} +\begin{tabular*}{0.75\textwidth}{lll} \hline Name & Alias & Brief description\\ \hline @@ -66,7 +66,7 @@ {\bf \$f0,\$f2} & & Float results \\ {\bf \$f1,\$f3,\$f4-\$f11,\$f20-\$f23} & & Float temporaries \\ {\bf \$f12-\$f19} & & Float arguments \\ -\end{tabular} +\end{tabular*} \caption{Register usage on mips32 eabi calling convention} \end{table}
--- a/doc/manual/callconvs/callconv_ppc32.tex Sun Mar 20 18:44:41 2016 +0100 +++ b/doc/manual/callconvs/callconv_ppc32.tex Mon Mar 21 01:15:37 2016 +0100 @@ -44,7 +44,7 @@ \paragraph{Registers and register usage} \begin{table}[h] -\begin{tabular}{3 B} +\begin{tabular*}{0.75\textwidth}{3 B} \hline Name & Brief description\\ \hline @@ -69,7 +69,7 @@ {\bf cr2-cr4} & permanent\\ {\bf cr5-cr7} & scratch\\ \hline -\end{tabular} +\end{tabular*} \caption{Register usage on Darwin PowerPC 32-Bit} \end{table} @@ -155,9 +155,9 @@ \paragraph{Registers and register usage} \begin{table}[h] -\begin{tabular}{3 B} +\begin{tabular*}{0.75\textwidth}{3 B} \hline -Name & Brief description\\ +Name & Brief description\\ \hline {\bf r0} & scratch\\ {\bf r1} & stack pointer\\ @@ -189,7 +189,7 @@ % {\bf cr2-cr4} & permanent\\ % {\bf cr5-cr7} & scratch\\ \hline -\end{tabular} +\end{tabular*} \caption{Register usage on System V ABI PowerPC Processor} \end{table}
--- a/doc/manual/callconvs/callconv_sparc.tex Sun Mar 20 18:44:41 2016 +0100 +++ b/doc/manual/callconvs/callconv_sparc.tex Mon Mar 21 01:15:37 2016 +0100 @@ -40,7 +40,7 @@ \end{itemize} \begin{table}[h] -\begin{tabular}{lll} +\begin{tabular*}{0.75\textwidth}{lll} \hline Name & Alias & Brief description\\ \hline @@ -50,7 +50,7 @@ {\bf \%o1-\%o5 and \%i1-\%i5} & & Output and input argument registers \\ {\bf \%o6 and \%i6} & & Stack and frame pointer \\ {\bf \%o7 and \%i7} & & Return address (caller writes to o7, callee uses i7) \\ -\end{tabular} +\end{tabular*} \caption{Register usage on sparc calling convention} \end{table}
--- a/doc/manual/callconvs/callconv_x64.tex Sun Mar 20 18:44:41 2016 +0100 +++ b/doc/manual/callconvs/callconv_x64.tex Mon Mar 21 01:15:37 2016 +0100 @@ -56,7 +56,7 @@ \paragraph{Registers and register usage} \begin{table}[h] -\begin{tabular}{3 B} +\begin{tabular*}{0.75\textwidth}{3 B} \hline Name & Brief description\\ \hline @@ -76,7 +76,7 @@ {\bf xmm4-xmm5} & scratch, permanent if required by caller\\ {\bf xmm6-xmm15} & permanent\\ \hline -\end{tabular} +\end{tabular*} \caption{Register usage on x64 MS Windows platform} \end{table} @@ -154,7 +154,7 @@ \paragraph{Registers and register usage} \begin{table}[h] -\begin{tabular}{3 B} +\begin{tabular*}{0.75\textwidth}{3 B} \hline Name & Brief description\\ \hline @@ -175,7 +175,7 @@ {\bf st0-st1} & scratch, 16 byte floating point return value\\ {\bf st2-st7} & scratch\\ \hline -\end{tabular} +\end{tabular*} \caption{Register usage on x64 System V (Linux/*BSD)} \end{table}
--- a/doc/manual/callconvs/callconv_x86.tex Sun Mar 20 18:44:41 2016 +0100 +++ b/doc/manual/callconvs/callconv_x86.tex Mon Mar 21 01:15:37 2016 +0100 @@ -46,7 +46,7 @@ \paragraph{Registers and register usage} \begin{table}[h] -\begin{tabular}{3 B} +\begin{tabular*}{0.75\textwidth}{3 B} \hline Name & Brief description\\ \hline @@ -61,7 +61,7 @@ {\bf st0} & scratch, floating point return value\\ {\bf st1-st7} & scratch\\ \hline -\end{tabular} +\end{tabular*} \caption{Register usage on x86 cdecl calling convention} \end{table} @@ -120,7 +120,7 @@ \paragraph{Registers and register usage} \begin{table}[h] -\begin{tabular}{3 B} +\begin{tabular*}{0.75\textwidth}{3 B} \hline Name & Brief description\\ \hline @@ -135,7 +135,7 @@ {\bf st0} & scratch, floating point return value\\ {\bf st1-st7} & scratch\\ \hline -\end{tabular} +\end{tabular*} \caption{Register usage on x86 fastcall (MS) calling convention} \end{table} @@ -197,7 +197,7 @@ \paragraph{Registers and register usage} \begin{table}[h] -\begin{tabular}{3 B} +\begin{tabular*}{0.75\textwidth}{3 B} \hline Name & Brief description\\ \hline @@ -212,7 +212,7 @@ {\bf st0} & scratch, floating point return value\\ {\bf st1-st7} & scratch\\ \hline -\end{tabular} +\end{tabular*} \caption{Register usage on x86 fastcall (GNU) calling convention} \end{table} @@ -271,7 +271,7 @@ \paragraph{Registers and register usage} \begin{table}[h] -\begin{tabular}{3 B} +\begin{tabular*}{0.75\textwidth}{3 B} \hline Name & Brief description\\ \hline @@ -286,7 +286,7 @@ {\bf st0} & scratch, floating point return value\\ {\bf st1-st7} & scratch\\ \hline -\end{tabular} +\end{tabular*} \caption{Register usage on x86 fastcall (Borland) calling convention} \end{table} @@ -347,7 +347,7 @@ \paragraph{Registers and register usage} \begin{table}[h] -\begin{tabular}{3 B} +\begin{tabular*}{0.75\textwidth}{3 B} \hline Name & Brief description\\ \hline @@ -362,7 +362,7 @@ {\bf st0} & scratch, floating point return value\\ {\bf st1-st7} & scratch\\ \hline -\end{tabular} +\end{tabular*} \caption{Register usage on x86 fastcall (Watcom) calling convention} \end{table} @@ -420,7 +420,7 @@ \paragraph{Registers and register usage} \begin{table}[h] -\begin{tabular}{3 B} +\begin{tabular*}{0.75\textwidth}{3 B} \hline Name & Brief description\\ \hline @@ -435,7 +435,7 @@ {\bf st0} & scratch, floating point return value\\ {\bf st1-st7} & scratch\\ \hline -\end{tabular} +\end{tabular*} \caption{Register usage on x86 stdcall calling convention} \end{table} @@ -491,7 +491,7 @@ \paragraph{Registers and register usage} \begin{table}[h] -\begin{tabular}{3 B} +\begin{tabular*}{0.75\textwidth}{3 B} \hline Name & Brief description\\ \hline @@ -506,7 +506,7 @@ {\bf st0} & scratch, floating point return value\\ {\bf st1-st7} & scratch\\ \hline -\end{tabular} +\end{tabular*} \caption{Register usage on x86 thiscall (MS) calling convention} \end{table} @@ -567,7 +567,7 @@ \paragraph{Registers and register usage} \begin{table}[h] -\begin{tabular}{3 B} +\begin{tabular*}{0.75\textwidth}{3 B} \hline Name & Brief description\\ \hline @@ -582,7 +582,7 @@ {\bf st0} & scratch, floating point return value\\ {\bf st1-st7} & scratch\\ \hline -\end{tabular} +\end{tabular*} \caption{Register usage on x86 thiscall (GNU) calling convention} \end{table} @@ -640,7 +640,7 @@ \paragraph{Registers and register usage} \begin{table}[h] -\begin{tabular}{3 B} +\begin{tabular*}{0.75\textwidth}{3 B} \hline Name & Brief description\\ \hline @@ -655,7 +655,7 @@ {\bf st0} & scratch, floating point return value\\ {\bf st1-st7} & scratch\\ \hline -\end{tabular} +\end{tabular*} \caption{Register usage on x86 pascal calling convention} \end{table} @@ -712,7 +712,7 @@ \paragraph{Registers and register usage} \begin{table}[h] -\begin{tabular}{3 B} +\begin{tabular*}{0.75\textwidth}{3 B} \hline Name & Brief description\\ \hline @@ -727,7 +727,7 @@ {\bf st0} & scratch, floating point return value\\ {\bf st1-st7} & scratch\\ \hline -\end{tabular} +\end{tabular*} \caption{Register usage on x86 plan9call calling convention} \end{table}
--- a/doc/manual/manual_build.tex Sun Mar 20 18:44:41 2016 +0100 +++ b/doc/manual/manual_build.tex Mon Mar 21 01:15:37 2016 +0100 @@ -52,18 +52,17 @@ \\ -\begin{tabular}{l l l} -\textbf{{\large Platform}} & Build Tool(s) & Compiler, SDK \\ +\begin{tabular*}{0.75\textwidth}{lll} +\textbf{Platform} & Build Tool(s) & Compiler, SDK \\ \hline -\textbf{{\large Windows}} & nmake,Visual Studio & cl, cygwin (gcc), mingw (gcc) \\ -\textbf{{\large Unix-like}} & GNU/BSD/Sun make & gcc, clang, sunc \\ -\textbf{{\large Plan9}} & mk & 8c \\ -\textbf{{\large Haiku/BeOS}} & GNU make & gcc \\ -\textbf{{\large iOS/iPhone}} & GNU make & gcc and iPhone SDK on Mac OS X \\ -\textbf{{\large Nintendo DS}} & nmake & devkitPro\cite{devkitPro} tools on Windows \\ -\textbf{{\large Playstation Portable}} & GNU make & psptoolchain\cite{psptoolchain} tools \\ - -\end{tabular}\\ +\textbf{Windows} & nmake,Visual Studio & cl, cygwin (gcc), mingw (gcc) \\ +\textbf{Unix-like} & GNU/BSD/Sun make & gcc, clang, sunc \\ +\textbf{Plan9} & mk & 8c \\ +\textbf{Haiku/BeOS} & GNU make & gcc \\ +\textbf{iOS/iPhone} & GNU make & gcc and iPhone SDK on Mac OS X \\ +\textbf{Nintendo DS} & nmake & devkitPro\cite{devkitPro} tools on Windows \\ +\textbf{Playstation Portable} & GNU make & psptoolchain\cite{psptoolchain} tools \\ +\end{tabular*}\\ \pagebreak @@ -80,12 +79,12 @@ Available options (omit for defaults): -\begin{tabular}{ll} +\begin{tabular*}{0.75\textwidth}{ll} {\tt --help} & display help \\ {\tt --prefix=\textit{path}} & specify installation prefix (Unix shell) \\ {\tt --target=\textit{platform}} & MacOSX,iOS,iPhoneSimulator,PSP,... \\ {\tt --sdk=\textit{version}} & SDK version \\ -\end{tabular} +\end{tabular*} \paragraph{Windows flavour, and cross-build from Windows (PSP, NDS, etc.)} @@ -95,23 +94,23 @@ Available options: -\begin{tabular}{ll} -{\tt /?} & display help \\ -{\tt /prefix \textit{path}} & set installation prefix (GNU make only) \\ -{\tt /prefix-bd \textit{path}} & set build directory prefix (GNU make only) \\ -{\tt /target-x86} & build for x86 architecture (default) \\ -{\tt /target-x64} & build for x64 architecture \\ +\begin{tabular*}{0.75\textwidth}{ll} +{\tt /?} & display help \\ +{\tt /prefix \textit{path}} & set installation prefix (GNU make only) \\ +{\tt /prefix-bd \textit{path}} & set build directory prefix (GNU make only) \\ +{\tt /target-x86} & build for x86 architecture (default) \\ +{\tt /target-x64} & build for x64 architecture \\ {\tt /target-psp} & build for PlayStation Portable (homebrew SDK) \\ -{\tt /target-nds-arm} & build for Nintendo DS (devkitPro, ARM mode) \\ +{\tt /target-nds-arm} & build for Nintendo DS (devkitPro, ARM mode) \\ {\tt /target-nds-thumb} & build for Nintendo DS (devkitPro, THUMB mode) \\ -{\tt /tool-msvc} & use Microsoft Visual C++ compiler (default) \\ -{\tt /tool-gcc} & use GNU Compiler Collection \\ -{\tt /asm-ml} & use Microsoft Macro Assembler (default) \\ -{\tt /asm-as} & use the GNU Assembler \\ -{\tt /asm-nasm} & use NASM Assembler \\ -{\tt /config-release} & build release version (default) \\ -{\tt /config-debug} & build debug version \\ -\end{tabular} +{\tt /tool-msvc} & use Microsoft Visual C++ compiler (default) \\ +{\tt /tool-gcc} & use GNU Compiler Collection \\ +{\tt /asm-ml} & use Microsoft Macro Assembler (default) \\ +{\tt /asm-as} & use the GNU Assembler \\ +{\tt /asm-nasm} & use NASM Assembler \\ +{\tt /config-release} & build release version (default) \\ +{\tt /config-debug} & build debug version \\ +\end{tabular*} \paragraph{Plan 9 flavour} @@ -122,9 +121,9 @@ Available options (none, at the moment): -\begin{tabular}{ll} +\begin{tabular*}{0.75\textwidth}{ll} {\tt --help} & display help \\ -\end{tabular} +\end{tabular*} \item Build the static libraries \product{dyncall}, \product{dynload} and \product{dyncallback}
--- a/doc/manual/manual_devel.tex Sun Mar 20 18:44:41 2016 +0100 +++ b/doc/manual/manual_devel.tex Mon Mar 21 01:15:37 2016 +0100 @@ -21,23 +21,23 @@ \section{Developers} \subsection{Noteworthy files in the project root} -\begin{verbatim} -configure -- pre-make configuration tool (unix-shell) -configure.bat -- pre-nmake configuration tool (windows batch) -configure.rc -- pre-mk configuration tool (Plan 9's rc) -CMakeLists.txt-- top-level project information for CMake -Makefile -- GNU/BSD makefile (output of ./configure) -Nmakefile -- MS nmake makefile -mkfile -- Plan 9 mkfile -LICENSE -- license information -README -- quickstart doc -buildsys/ -- build system details and extras -doc/ -- platform specific readme's and manual -dyncall/ -- dyncall library source code -dyncallback/ -- dyncallback library source code -dynload/ -- dynload library source code -test/ -- test suites -\end{verbatim} +\begin{tabular*}{0.75\textwidth}{ll} +{\tt configure} & pre-make configuration tool (unix-shell) \\ +{\tt configure.bat} & pre-nmake configuration tool (windows batch) \\ +{\tt configure.rc} & pre-mk configuration tool (Plan 9's rc) \\ +{\tt CMakeLists.txt} & top-level project information for CMake \\ +{\tt Makefile} & GNU/BSD makefile (output of ./configure) \\ +{\tt Nmakefile} & MS nmake makefile \\ +{\tt mkfile} & Plan 9 mkfile \\ +{\tt LICENSE} & license information \\ +{\tt README} & quickstart doc \\ +{\tt buildsys/} & build system details and extras \\ +{\tt doc/} & platform specific readme's and manual \\ +{\tt dyncall/} & dyncall library source code \\ +{\tt dyncallback/} & dyncallback library source code \\ +{\tt dynload/} & dynload library source code \\ +{\tt test/} & test suites \\ +\end{tabular*} \subsection{Test suites}
--- a/doc/manual/manual_tex4ht.cfg Sun Mar 20 18:44:41 2016 +0100 +++ b/doc/manual/manual_tex4ht.cfg Mon Mar 21 01:15:37 2016 +0100 @@ -51,6 +51,14 @@ % should this really rely on online content (dyncall's .css) even for an offline build? @@@ \Configure{@HEAD}{\HCode{<link rel="stylesheet" href="http://dyncall.org/data/main.css" type="text/css" media="all"/>\Hnewline}} +% Image path prefix can be set here... +%\Configure{IMG} +%{\ht:special{t4ht=<img src="}} +%{\ht:special{t4ht=" alt="}} +%{" } +%{\ht:special{t4ht=" }} +%{\ht:special{t4ht=/>}} + % Make TOC display as nested "ul"s. \Configure{tableofcontents} {}{\tocItem{0}}{}{}{} \ConfigureToc{section} {}{\tocItem{1}{\HCode{<li>}}}{}{} @@ -82,6 +90,7 @@ % of tabular*, which we then mend with the code below. Not sure if % this is just a hack around a tex4ht bug, but it nicely lets us % pick which table should be a picture or not. +% This means: use tabular for pictures, tabular* for text output. @@@ might want to abstract this into \htmlpic or so \Configure{tabular} {\HCode{<table>}} {\HCode{</table>}} @@ -118,6 +127,8 @@ \Configure{textbf}{\Tg<b>}{\Tg</b>} \Configure{emph}{\Tg<em>}{\Tg</em>} +% @@@ list of things that are still open: +% paragraph{xxx} - should probably be forced to always be on newline to reflect pdf %\lstset{ language=C, basicstyle=\ttfamily, numbers=left, %numberstyle=\tiny, numbersep=10pt, showstringspaces=false}