Merge pull request #421 from libtom/doc-fix

manual: don't mention obsolete MP_DIV_SMALL
This commit is contained in:
Steffen Jaeckel 2019-10-27 22:06:11 +01:00 committed by GitHub
commit bde40c44a9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -271,7 +271,7 @@ test was invoked. If an error is detected the program will exit with a dump of
numbers it was working with. numbers it was working with.
\section{Build Configuration} \section{Build Configuration}
LibTomMath can configured at build time in three phases we shall call ``depends'', ``tweaks'' and LibTomMath can configured at build time in two phases we shall call ``depends'' and
``trims''. Each phase changes how the library is built and they are applied one after another ``trims''. Each phase changes how the library is built and they are applied one after another
respectively. respectively.
@ -298,22 +298,6 @@ You will also note that the header \texttt{tommath\_class.h} is actually recursi
includes itself twice). This is to help resolve as many dependencies as possible. In the last pass includes itself twice). This is to help resolve as many dependencies as possible. In the last pass
the symbol \texttt{LTM\_LAST} will be defined. This is useful for ``trims''. the symbol \texttt{LTM\_LAST} will be defined. This is useful for ``trims''.
\subsection{Build Tweaks}
A tweak is an algorithm ``alternative''. For example, to provide tradeoffs (usually between size
and space).
They can be enabled at any pass of the configuration phase.
\begin{small}
\begin{center}
\begin{tabular}{|l|l|}
\hline \textbf{Define} & \textbf{Purpose} \\
\hline MP\_DIV\_SMALL & Enables a slower, smaller and equally \\
& functional mp\_div() function \\
\hline
\end{tabular}
\end{center}
\end{small}
\subsection{Build Trims} \subsection{Build Trims}
A trim is a manner of removing functionality from a function that is not required. For instance, A trim is a manner of removing functionality from a function that is not required. For instance,
to perform RSA cryptography you only require exponentiation with odd moduli so even moduli support to perform RSA cryptography you only require exponentiation with odd moduli so even moduli support