summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorManuel Pégourié-Gonnard <mpg@elzevir.fr>2010-11-05 19:42:55 +0100
committerManuel Pégourié-Gonnard <mpg@elzevir.fr>2010-11-11 15:52:24 +0100
commitec78724a1df80ff8d5f10c8c2241bfaff270d71d (patch)
treecaa61bacb0c744d70c5a4eb07274a44916019b9b
parentca07dd609c306a6448ec301168a87df28aa250f0 (diff)
downloadluatexbase-ec78724a1df80ff8d5f10c8c2241bfaff270d71d.tar.gz
mcb doc: mention test=example and compatibility
-rw-r--r--TODO2
-rw-r--r--luatexbase-mcb.dtx17
2 files changed, 17 insertions, 2 deletions
diff --git a/TODO b/TODO
index f3036f5..b3ada22 100644
--- a/TODO
+++ b/TODO
@@ -17,7 +17,5 @@ declaration and no declaration?
mcb
---
-- doc: make an "example" section
-- doc: add a word about compatibility
- code: verify that the return value of callback.register is checked
- check type of all callbacks (& list)
diff --git a/luatexbase-mcb.dtx b/luatexbase-mcb.dtx
index 9af132f..9e91065 100644
--- a/luatexbase-mcb.dtx
+++ b/luatexbase-mcb.dtx
@@ -141,6 +141,11 @@ See source file '\inFileName' for details.
%
% \section{Documentation}
%
+% Before we start, let me mention that test files are provided (they should be
+% in the same directory as this PDF file). You can have a look at them,
+% compile them and have a look at the log, if you want examples of how this
+% module works.
+%
% \subsection{Managing functions in callbacks}
%
% \luatex provides an extremely interesting feature, named callbacks. It
@@ -256,6 +261,18 @@ See source file '\inFileName' for details.
% support for this was removed. It may be added back (as well as support for
% other split callbacks) if it appears there is an actual need for it.
%
+% \subsection{Compatibility}
+%
+% Some callbacks have a calling convention that varies depending on the
+% version of \luatex used. This package \emph{does not} try to track the type
+% of the callbacks in every possible version of \luatex. The types are based
+% on the last stable beta version (0.60.2 at the time this doc is written).
+%
+% However, for callbacks that have the same calling convention for every
+% version of \luatex, this package should work with the same range of \luatex
+% version as other packages in the \pk{luatexbase} bundle (currently, 0.25.4
+% to 0.60.2).
+%
% \section{Implementation}
%
% \subsection{\tex package}