Differences

This shows you the differences between two versions of the page.

--- devel:module-docbook-readme [2013/04/05 13:46]
miconda created
+++ devel:module-docbook-readme [2020/08/12 16:48]
miconda [Kamailio Style]
@@ Line 6: / Line 6: @@
 make modules-readme modules=modules/modname
 </code>
+Note: after the new module has been published to the public git repository, do not generate anymore the README for pushing it to git. Push only the changes to the xml files, because the README is automatically generated by a cron service running on project infrastructure to ensure coherent formatting and avoid conflicts of backporting to older branches. Of course, you can generate it locally to check if the results is the expected one, but then restore the old README without changes -- it can be done with:
+<code>
+rm src/modules/modname/README
+git checkout src/modules/modname/README
+</code>
 ===== Naming Files =====
@@ Line 13: / Line 21: @@
 The docbook file are:
-  * modname.xml - the main docbook file, including other files that have content
+  * modname.xml (e.g., acc.xml) - the main docbook file, including other files that have content
-  * modname_admin.xml - the docbook file that includes content targeting administrators (e.g., short description, dependencies, parameters and functions for the config file, a.s.o.)
+  * modname_admin.xml (e.g., acc_admin.xml) - the docbook file that includes content targeting administrators (e.g., short description, dependencies, parameters and functions for the config file, a.s.o.)
   * modname_devel.xml - the docbook file that includes content targeting developers (e.g., inter module APIs)
@@ Line 42: / Line 50: @@
   * s - statistics
   * e - event routes
+  * v - pseudovariable
 Next is an example showing the id for the section corresponding to parameter **workers** from module **async**:

Kamailio SIP Server Wiki

User Tools

Site Tools

Differences

Page Tools