From: Mark Wooding <mdw@distorted.org.uk>
Date: Mon, 5 Aug 2019 13:56:19 +0000 (+0100)
Subject: doc/misc.tex: Mention that `int' is magically exported.
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~mdw/git/sod/commitdiff_plain/f0b1f2bfc04f53416356be951b2655ff26ce7e7f

doc/misc.tex: Mention that `int' is magically exported.

Someone might care.
---

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}