[sr-dev] git:5.5:97f9ede8: secsipid: note about libsecsipid location and failure return codes

[Daniel-Constantin Mierla]

Module: kamailio
Branch: 5.5
Commit: 97f9ede8b82cff8063c3fd1908d3c323997e9566
URL: https://github.com/kamailio/kamailio/commit/97f9ede8b82cff8063c3fd1908d3c323997e9566

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2021-06-01T10:59:32+02:00

secsipid: note about libsecsipid location and failure return codes

(cherry picked from commit 59719a1ac97337ca7f8b83b0e8a9d63bf6ec0c7e)

---

Modified: src/modules/secsipid/doc/secsipid_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/97f9ede8b82cff8063c3fd1908d3c323997e9566.diff
Patch: https://github.com/kamailio/kamailio/commit/97f9ede8b82cff8063c3fd1908d3c323997e9566.patch

---

diff --git a/src/modules/secsipid/doc/secsipid_admin.xml b/src/modules/secsipid/doc/secsipid_admin.xml
index 1e22e371fb..0d7147c35f 100644
--- a/src/modules/secsipid/doc/secsipid_admin.xml
+++ b/src/modules/secsipid/doc/secsipid_admin.xml
@@ -30,6 +30,17 @@
 		loads "secsipid_proc.so" in child init callback in order to initialize
 		the "libsecsipid" per child process.
 	</para>
+	<para>
+		The libsecsipid is provided by secsipidx project:
+		<ulink url="https://github.com/asipto/secsipidx">https://github.com/asipto/secsipidx</ulink>.
+	</para>
+	<para>
+		In case of failure, the functions in this module return error codes
+		(the negative values) listed in the code of libsecsipid, pretty much
+		at the top of:
+		<ulink url="https://github.com/asipto/secsipidx/blob/main/secsipid/secsipid.go"
+			>https://github.com/asipto/secsipidx/blob/main/secsipid/secsipid.go</ulink>.
+	</para>
 	</section>
 	<section>
 	<title>Dependencies</title>