tutorials:makefile-system - sip-router.org

[ Please fill or disable this placeholder (:wiki:site_notice) ]

You are here: start » tutorials » makefile-system

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

====== SIP Router Makefile System ======

===== Generate Main Binary =====

<code>
make
</code>

===== Generate Modules =====

<code>
make modules
make modules_k
make modules_s
</code>

===== Generate README For Modules =====

  * all READMEs for modules located in directory **modules**
<code>
make modules-readme
</code>
  * all READMEs for modules located in directory **modules_k**
<code>
make modules_k-readme
</code>
  * all READMEs for modules located in directory **modules_s**
<code>
make modules_s-readme
</code>
  * README for one module. Example for **modules_k/dispatcher**:
<code>
make modules-readme modules=modules_k/dispatcher
</code>

or

<code>
make -C modules_k/dispatcher/doc readme
</code>

===== Generate Different Formats For Modules Documentation =====

Available formats:
* txt - text plain
* xhtml - single xhtml file
* html - html files (chunks) split by sections
* pdf - PDF file

Command to generate a specific format for a module:
<code>
make modules-doc doc_format=format modules=path/to/module
</code>

Example: generate single xhtml file for **auth** module:
<code>
make modules-doc doc_format=xhtml modules=modules_k/auth
</code>

Trace: • devel • sip-router-repository • quick-start-guide

Navigation

Search

Toolbox

QR Code