[tepl] docs: list the Amtk sanity checks in the intro
- From: Sébastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [tepl] docs: list the Amtk sanity checks in the intro
- Date: Sun, 30 Jul 2017 16:25:10 +0000 (UTC)
commit 3832ca0435d8c273342f12374085c8847d02342d
Author: Sébastien Wilmet <swilmet gnome org>
Date: Sun Jul 30 18:03:11 2017 +0200
docs: list the Amtk sanity checks in the intro
docs/reference/amtk-intro.xml.in | 31 +++++++++++++++++++++++++++++++
1 files changed, 31 insertions(+), 0 deletions(-)
---
diff --git a/docs/reference/amtk-intro.xml.in b/docs/reference/amtk-intro.xml.in
index 0bcfe52..f25d366 100644
--- a/docs/reference/amtk-intro.xml.in
+++ b/docs/reference/amtk-intro.xml.in
@@ -99,6 +99,37 @@
</itemizedlist>
<refsect1>
+ <title>Sanity checks</title>
+ <para>
+ Amtk has several functions to do various sanity checks. They normally don't
+ impact too much the performances, so it is recommended to always run them,
+ although they could be disabled on production. The functions:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <link
linkend="amtk-action-map-add-action-entries-check-dups">amtk_action_map_add_action_entries_check_dups()</link>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link linkend="amtk-action-info-store-check-all-used">amtk_action_info_store_check_all_used()</link>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Another sanity check, but which cannot be disabled: the
+ <link linkend="AmtkActionInfoCentralStore">AmtkActionInfoCentralStore</link>
+ checks that each <link linkend="AmtkActionInfo">AmtkActionInfo</link>
+ has a unique action name. Which means that
+ <link linkend="AmtkActionInfo">AmtkActionInfo</link>'s provided by a
+ library must be namespaced.
+ </para>
+ </listitem>
+ </itemizedlist>
+</refsect1>
+
+<refsect1>
<title>GTK+ dependency</title>
<para>
Amtk @TEPL_API_VERSION@ depends on GTK+ 3.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]