Skip to content

Commit

Permalink
tls_wolfssl: improve documentation regarding compilation
Browse files Browse the repository at this point in the history
  • Loading branch information
rvlad-patrascu committed Jun 10, 2021
1 parent 39f7aef commit ce38c62
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 0 deletions.
2 changes: 2 additions & 0 deletions modules/tls_wolfssl/doc/tls_wolfssl.xml
Expand Up @@ -4,6 +4,7 @@


<!ENTITY admin SYSTEM "tls_wolfssl_admin.xml">
<!ENTITY faq SYSTEM "tls_wolfssl_faq.xml">
<!ENTITY contrib SYSTEM "contributors.xml">

<!-- Include general documentation entities -->
Expand All @@ -20,6 +21,7 @@
<toc></toc>

&admin;
&faq;
&contrib;

&docCopyrights;
Expand Down
24 changes: 24 additions & 0 deletions modules/tls_wolfssl/doc/tls_wolfssl_admin.xml
Expand Up @@ -22,6 +22,30 @@

<section id="dependencies" xreflabel="Dependencies">
<title>Dependencies</title>
<section>
<title>Compilation</title>
<para>
The following packages must be installed before compiling this module:
<itemizedlist>
<listitem>
<para>
<emphasis>autoconf</emphasis>.
</para>
</listitem>
<listitem>
<para>
<emphasis>automake</emphasis>.
</para>
</listitem>
<listitem>
<para>
<emphasis>libtool</emphasis>.
</para>
</listitem>
</itemizedlist>
</para>
</section>

<section>
<title>&osips; Modules</title>
<para>
Expand Down
37 changes: 37 additions & 0 deletions modules/tls_wolfssl/doc/tls_wolfssl_faq.xml
@@ -0,0 +1,37 @@
<!-- Module FAQ -->

<chapter>

<title>&faqguide;</title>
<qandaset defaultlabel="number">
<qandaentry>
<question>
<para>Why do I get the following error when compiling the module?</para>
<programlisting format="linespecific">
make[1]: Entering directory '/usr/local/src/opensips/modules/tls_wolfssl'
/bin/sh: 3: ./autogen.sh: not found
env: './configure': No such file or directory
make[1]: *** [Makefile:15: lib/lib/libwolfssl.a] Error 127
make[1]: Leaving directory '/usr/local/src/opensips/modules/tls_wolfssl'
make: *** [Makefile:197: modules] Error 2
</programlisting>
</question>
<answer>
<para>
If you obtained the OpenSIPS sources by cloning the repository from Github,
without using the <emphasis>--recursive</emphasis> option for the
<emphasis>git clone</emphasis> command, you did not properly fetch the
<emphasis>wolfSSL</emphasis> library code, which is included as a git submodule
pointing to the official <emphasis>wolfSSL</emphasis> repository.
</para>
<para>
In order to fetch the <emphasis>wolfSSL</emphasis> library code you can run:
<programlisting format="linespecific">
git submodule update --init
</programlisting>
</para>
</answer>
</qandaentry>
</qandaset>

</chapter>

0 comments on commit ce38c62

Please sign in to comment.