From 3cc914a1c3bb83239feb0a5d92b4330b73ff62b7 Mon Sep 17 00:00:00 2001
From: Virgile Prevosto <virgile.prevosto@m4x.org>
Date: Wed, 27 May 2020 13:59:45 +0200
Subject: [PATCH] [devman] documentation for configure_pkg macro
---
doc/developer/advance.tex | 11 ++++++++++-
doc/developer/changes.tex | 5 +++++
2 files changed, 15 insertions(+), 1 deletion(-)
diff --git a/doc/developer/advance.tex b/doc/developer/advance.tex
index 459e80d888a..43d2fda3d05 100644
--- a/doc/developer/advance.tex
+++ b/doc/developer/advance.tex
@@ -199,7 +199,16 @@ on the configuration of new libraries. This is done by calling a
predefined macro called
\texttt{configure\_library}\scodeidxdef{configure.in}{configure\_library}\scodeidxdef{configure.in}{configure\_tools}\footnote{For
tools, there is a macro \texttt{configure\_tool} which works in the
- same way as \texttt{configure\_library}.}.
+ same way as \texttt{configure\_library}.}, or its more specialized version
+\texttt{configure\_pkg}\scodeidxdef{configure.in}{configure\_pkg}.
+
+\texttt{configure\_pkg} is meant to be used for checking the presence of
+OCaml libraries that are managed as
+\texttt{findlib}\footnote{\url{http://projects.camlcity.org/projects/findlib.html}}
+packages, which is the case for most modern OCaml libraries nowadays.
+It takes two arguments, the name of the package (as known by \texttt{findlib}),
+and a message that will be displayed if the package is not found.
+
The \texttt{configure\_library} macro takes three arguments. The first one is
the (uppercase) name of the library, the second one is a filename
which is used by the script to check the availability of the library.
diff --git a/doc/developer/changes.tex b/doc/developer/changes.tex
index ba27c451541..c798e1cde66 100644
--- a/doc/developer/changes.tex
+++ b/doc/developer/changes.tex
@@ -5,6 +5,11 @@
This chapter summarizes the major changes in this documentation between each
\framac release, from newest to oldest.
+\section*{21.0 Scandium}
+\begin{itemize}
+\item \textbf{Configure}: Documentation of \texttt{configure\_pkg} macro.
+\end{itemize}
+
\section*{20.0 Calcium}
\begin{itemize}
\item \textbf{Ptests}: Documentation of the new directive \texttt{MODULE}.
--
GitLab