aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--doc/api-changes.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/api-changes.md b/doc/api-changes.md
new file mode 100644
index 0000000..f3b8ac5
--- /dev/null
+++ b/doc/api-changes.md
@@ -0,0 +1,14 @@
1# TO-DO list for API changes
2
3When `nissy.h` is modified, for example because a new API function is added or
4one of the old ones changes signature, all the examples and tools that include
5this file must be adapted. Here is a list:
6
7* Update the tools in `tools/`.
8* Update the shell `shell/shell.c`.
9* Update the python module `python/nissy_module.c` and, if needed, the
10 examples in `python/examples/`.
11* Update the C++ adapter `cpp/nissy.{cpp,h}` and, if needed, the examples in
12 `cpp/examples/`.
13* Update the web adapter `web/adapter.cpp` (based on the C++ header) and,
14 if needed, the example webapp in `web/http/`.

Generated with cgit - Back to sebastiano.tronto.net