X-Git-Url: https://git.distorted.org.uk/~mdw/sod/blobdiff_plain/b9d79c4c07134738b826dd84c80e2431e2a0d3c8..6213be581b6fd4836c19af2f7970ecead5f8ae97:/doc/misc.tex diff --git a/doc/misc.tex b/doc/misc.tex index 05cda1f..98e9ef9 100644 --- a/doc/misc.tex +++ b/doc/misc.tex @@ -867,6 +867,19 @@ The following definitions are useful when working with conditions. Dijkstra. \end{describe} + +\subsection{Other exported symbols} + +\begin{describe}{sym}{int} + The symbol @|int| is exported by the @|sod-utilities| package, without + giving it any particular meaning. This is done because it's given + non-conflicting meanings by two different packages, and it's more + convenient for user code not to have to deal with an unnecessary symbol + conflict. Specifically, the @|sod| package wants to define it as a C type + specifier, see \descref{cls}{simple-c-type}; and @|optparse| wants to + define it as an option handler, see \descref{opt}{int}. +\end{describe} + %%%-------------------------------------------------------------------------- \section{Option parser} \label{sec:misc.optparse}