Skip to content

Commit

Permalink
doc: Fix typo's. Always regenerate all docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
wdoekes committed Jun 30, 2014
1 parent b611ee6 commit bcdbf27
Show file tree
Hide file tree
Showing 54 changed files with 235 additions and 251 deletions.
103 changes: 52 additions & 51 deletions Makefile
Expand Up @@ -86,23 +86,24 @@ static_modules_path=$(addprefix modules/, $(static_modules))
extra_sources=$(wildcard $(addsuffix /*.c, $(static_modules_path)))
extra_objs=$(extra_sources:.c=.o)

static_defs= $(foreach mod, $(static_modules), \
static_defs=$(foreach mod, $(static_modules), \
-DSTATIC_$(shell echo $(mod) | tr [:lower:] [:upper:]) )

override extra_defs+=$(static_defs) $(EXTRA_DEFS)
export extra_defs

all_modules=$(wildcard modules/*)
all_modules_basenames=$(patsubst modules/%, %, $(all_modules))

modules=$(filter-out $(addprefix modules/, \
$(exclude_modules) $(static_modules)), \
$(wildcard modules/*))
$(all_modules))
modules:=$(filter-out $(modules), $(addprefix modules/, $(include_modules) )) \
$(modules)
modules_names=$(shell echo $(modules)| \
sed -e 's/modules\/\([^/ ]*\)\/*/\1.so/g' )
modules_basenames=$(shell echo $(modules)| \
sed -e 's/modules\/\([^/ ]*\)\/*/\1/g' )
#modules_names=$(patsubst modules/%, %.so, $(modules))
modules_full_path=$(join $(modules), $(addprefix /, $(modules_names)))
modules_names=$(patsubst modules/%, %.so, $(modules))
modules_basenames=$(patsubst modules/%, %, $(modules))
modules_full_path=$(join $(modules), $(addprefix /, $(modules_names)))


ifeq ($(TLS),)
tls_configs=""
Expand Down Expand Up @@ -264,75 +265,75 @@ tool-xsltproc:
.PHONY: modules-readme
modules-readme: tool-lynx tool-xsltproc
@set -e; \
for r in $(modules_basenames) "" ; do \
for r in $(all_modules_basenames) ""; do \
if [ -d "modules/$$r/doc" ]; then \
cd "modules/$$r/doc" ; \
cd "modules/$$r/doc"; \
if [ -f "$$r".xml ]; then \
echo "" ; \
echo "docbook xml to html: $$r.xml" ; \
echo ""; \
echo "docbook xml to html: $$r.xml"; \
$(DBXML2HTML) -o $$r.html $(DBXML2HTMLPARAMS) $(DBHTMLXSL) \
$$r.xml ; \
echo "docbook html to txt: $$r.html" ; \
$(DBHTML2TXT) $(DBHTML2TXTPARAMS) $$r.html >$$r.txt ; \
echo "docbook txt to readme: $$r.txt" ; \
rm $$r.html ; \
mv $$r.txt ../README ; \
echo "" ; \
fi ; \
cd ../../.. ; \
fi ; \
$$r.xml; \
echo "docbook html to txt: $$r.html"; \
$(DBHTML2TXT) $(DBHTML2TXTPARAMS) $$r.html >$$r.txt; \
echo "docbook txt to readme: $$r.txt"; \
rm $$r.html; \
mv $$r.txt ../README; \
echo ""; \
fi; \
cd ../../..; \
fi; \
done

.PHONY: modules-docbook-txt
modules-docbook-txt: tool-lynx tool-xsltproc
@set -e; \
for r in $(modules_basenames) "" ; do \
for r in $(all_modules_basenames) ""; do \
if [ -d "modules/$$r/doc" ]; then \
cd "modules/$$r/doc" ; \
cd "modules/$$r/doc"; \
if [ -f "$$r".xml ]; then \
echo "" ; \
echo "docbook xml to html: $$r.xml" ; \
echo ""; \
echo "docbook xml to html: $$r.xml"; \
$(DBXML2HTML) -o $$r.html $(DBXML2HTMLPARAMS) $(DBHTMLXSL) \
$$r.xml ; \
echo "docbook html to txt: $$r.html" ; \
$(DBHTML2TXT) $(DBHTML2TXTPARAMS) $$r.html >$$r.txt ; \
rm $$r.html ; \
echo "" ; \
fi ; \
cd ../../.. ; \
fi ; \
$$r.xml; \
echo "docbook html to txt: $$r.html"; \
$(DBHTML2TXT) $(DBHTML2TXTPARAMS) $$r.html >$$r.txt; \
rm $$r.html; \
echo ""; \
fi; \
cd ../../..; \
fi; \
done

.PHONY: modules-docbook-html
modules-docbook-html: tool-xsltproc
@set -e; \
for r in $(modules_basenames) "" ; do \
for r in $(all_modules_basenames) ""; do \
if [ -d "modules/$$r/doc" ]; then \
cd "modules/$$r/doc" ; \
cd "modules/$$r/doc"; \
if [ -f "$$r".xml ]; then \
echo "" ; \
echo "docbook xml to html: $$r.xml" ; \
echo ""; \
echo "docbook xml to html: $$r.xml"; \
$(DBXML2HTML) -o $$r.html $(DBXML2HTMLPARAMS) $(DBHTMLXSL) \
$$r.xml ; \
echo "" ; \
fi ; \
cd ../../.. ; \
fi ; \
$$r.xml; \
echo ""; \
fi; \
cd ../../..; \
fi; \
done

.PHONY: modules-docbook-pdf
modules-docbook-pdf: tool-docbook2pdf
@set -e; \
for r in $(modules_basenames) "" ; do \
for r in $(all_modules_basenames) ""; do \
if [ -d "modules/$$r/doc" ]; then \
cd "modules/$$r/doc" ; \
cd "modules/$$r/doc"; \
if [ -f "$$r".xml ]; then \
echo "" ; \
echo "docbook xml to pdf: $$r.xml" ; \
$(DBXML2PDF) "$$r".xml ; \
fi ; \
cd ../../.. ; \
fi ; \
echo ""; \
echo "docbook xml to pdf: $$r.xml"; \
$(DBXML2PDF) "$$r".xml; \
fi; \
cd ../../..; \
fi; \
done

.PHONY: modules-docbook
Expand Down
2 changes: 1 addition & 1 deletion doc/entities.xml
Expand Up @@ -9,7 +9,7 @@
<!ENTITY osips "OpenSIPS">
<!ENTITY osipsname "Open SIP Server">

<!ENTITY osipssolname "OpenSIPS Solutions>">
<!ENTITY osipssolname "OpenSIPS Solutions">
<!ENTITY osipssol "<ulink url='http://www.opensips-solutions.com/'>www.opensips-solutions.com</ulink>">

<!ENTITY osipshome "http://www.opensips.org/">
Expand Down
9 changes: 4 additions & 5 deletions modules/aaa_radius/README
Expand Up @@ -2,7 +2,7 @@ AAA RADIUS MODULE

Irina-Maria Stanescu

OpenSIPS Solutions>
OpenSIPS Solutions

Edited by

Expand Down Expand Up @@ -35,9 +35,8 @@ Irina-Maria Stanescu

1.4. Exported Functions

1.4.1.
radius_send_auth(input_set_name,output_set_nam
e)
1.4.1. radius_send_auth(input_set_name,
output_set_name)

1.4.2. radius_send_acct(input_set_name)

Expand Down Expand Up @@ -173,7 +172,7 @@ modparam("aaa_radius", "fetch_all_values", 1)

1.4. Exported Functions

1.4.1. radius_send_auth(input_set_name,output_set_name)
1.4.1. radius_send_auth(input_set_name, output_set_name)

This function can be used from the script to make custom radius
authentication request. The function takes two parameters.
Expand Down
2 changes: 1 addition & 1 deletion modules/aaa_radius/doc/aaa_radius_admin.xml
Expand Up @@ -194,7 +194,7 @@ modparam("aaa_radius", "fetch_all_values", 1)
<section>

<title>
<function moreinfo="none">radius_send_auth(input_set_name,output_set_name)</function>
<function moreinfo="none">radius_send_auth(input_set_name, output_set_name)</function>
</title>
<para>
This function can be used from the script to make custom
Expand Down
2 changes: 1 addition & 1 deletion modules/acc/README
Expand Up @@ -18,7 +18,7 @@ Irina-Maria Stanescu

Copyright © 2004-2009 Voice Sistem SRL

Copyright © 2009-2013 OpenSIPS Solutions>
Copyright © 2009-2013 OpenSIPS Solutions
Revision History
Revision $Revision: 8740 $ $Date$
__________________________________________________________
Expand Down
3 changes: 1 addition & 2 deletions modules/b2b_logic/README
Expand Up @@ -17,8 +17,7 @@ Ovidiu Sas

Copyright © 2010 VoIP Embedded, Inc.
Revision History
Revision $Revision: 8137 $ $Date: 2013-01-29 14:35:11 +0200
(Tue, 29 Jan 2013) $
Revision $Revision: 8137 $ $Date$
__________________________________________________________

Table of Contents
Expand Down
18 changes: 8 additions & 10 deletions modules/b2b_sca/README
Expand Up @@ -11,7 +11,7 @@ Ovidiu Sas
Copyright © 2011-2013 VoIP Embedded, Inc.
Revision History
Revision $Rev: 8688 $ $Date: 2012-01-25 13:52:05 -0500 (Wed, 25
Jan 2012) $
Jan 2012) $
__________________________________________________________

Table of Contents
Expand Down Expand Up @@ -224,8 +224,8 @@ modparam("b2b_sca", "appearance_name_addr_spec_param", "")

Example 1.6. Set db_url parameter
...
modparam("b2b_sca", "db_url", "[dbdriver]://[[username]:[password]]@[db
host]/[dbname]")
modparam("b2b_sca", "db_url", "[dbdriver]://[[username]:[password]]@[dbh
ost]/[dbname]")
...

1.4.7. db_mode(integer)
Expand Down Expand Up @@ -293,8 +293,7 @@ modparam("b2b_sca", "watchers_column", "")
Example 1.11. Set app[index]_shared_entity_column parameter
...
modparam("b2b_sca", "app1_shared_entity_column", "first_shared_entity")
modparam("b2b_sca", "app2_shared_entity_column", "second_shared_entity"
)
modparam("b2b_sca", "app2_shared_entity_column", "second_shared_entity")
...

1.4.12. app[index]_call_state_column(string)
Expand Down Expand Up @@ -327,8 +326,7 @@ modparam("b2b_sca", "app2_call_state_column", "second_call_state")
Example 1.13. Set app[index]_call_info_uri_column parameter
...
modparam("b2b_sca", "app1_call_info_uri_column", "first_call_info_uri")
modparam("b2b_sca", "app2_call_info_uri_column", "second_call_info_uri"
)
modparam("b2b_sca", "app2_call_info_uri_column", "second_call_info_uri")
...

1.4.14. app[index]_call_info_appearance_uri_column(string)
Expand All @@ -344,10 +342,10 @@ modparam("b2b_sca", "app2_call_info_uri_column", "second_call_info_uri"
Example 1.14. Set app[index]_call_info_appearance_uri_column
parameter
...
modparam("b2b_sca", "app1_call_info_appearance_uri_column", "first_call
modparam("b2b_sca", "app1_call_info_appearance_uri_column", "first_call_
info_appearance_uri")
modparam("b2b_sca", "app2_call_info_appearance_uri_column", "second_call
_info_appearance_uri")
modparam("b2b_sca", "app2_call_info_appearance_uri_column", "second_cal
l_info_appearance_uri")
...

1.4.15. app[index]_b2bl_key_column(string)
Expand Down
3 changes: 1 addition & 2 deletions modules/carrierroute/README
Expand Up @@ -14,8 +14,7 @@ Henning Westerholt

Copyright © 2007 1&1 Internet AG
Revision History
Revision $Revision$ $Date: 2009-07-21 10:45:05 +0300
(Tue, 21 Jul 2009) $
Revision $Revision: 5901 $ $Date$
__________________________________________________________

Table of Contents
Expand Down
3 changes: 1 addition & 2 deletions modules/cpl-c/README
Expand Up @@ -8,8 +8,7 @@ Bogdan-Andrei Iancu

Copyright © 2003 FhG FOKUS
Revision History
Revision $Revision$ $Date: 2012-02-22 19:29:43 +0200
(Wed, 22 Feb 2012) $
Revision $Revision: 8740 $ $Date$
__________________________________________________________

Table of Contents
Expand Down
3 changes: 1 addition & 2 deletions modules/db_berkeley/README
Expand Up @@ -10,8 +10,7 @@ Will Quan

Copyright © 2007 Cisco Systems
Revision History
Revision $Revision$ $Date: 2009-07-21 10:45:05 +0300
(Tue, 21 Jul 2009) $
Revision $Revision: 5901 $ $Date$
__________________________________________________________

Table of Contents
Expand Down
2 changes: 1 addition & 1 deletion modules/db_cachedb/README
Expand Up @@ -132,7 +132,7 @@ modparam("auth_db","db_url","cachedb://mongodb:mycluster")

Since the NoSQL backends do not usually have a strict schema
involved, we do not provide scripts for creating such schemas,
since the insertion ops will trigger the dinamically creation
since the insertion ops will trigger the dynamically creation
of the schema and info. Still, a specific data collection needs
to be present, and that is the equivalent of the 'version'
table from the SQL. Since most modules check the version table
Expand Down
2 changes: 1 addition & 1 deletion modules/db_http/README
Expand Up @@ -2,7 +2,7 @@ DB_HTTP Module

Andrei Dragus

OpenSIPS Solutions>
OpenSIPS Solutions

Edited by

Expand Down
9 changes: 4 additions & 5 deletions modules/db_mysql/README
Expand Up @@ -10,10 +10,9 @@ Daniel-Constantin Mierla

<miconda@gmail.com>

Copyright 2006 Voice Sistem SRL
Copyright © 2006 Voice Sistem SRL
Revision History
Revision $Revision$ $Date: 2009-07-21 10:45:05 +0300
(Tue, 21 Jul 2009) $
Revision $Revision: 5901 $ $Date$
__________________________________________________________

Table of Contents
Expand Down Expand Up @@ -99,8 +98,8 @@ modparam("db_mysql", "exec_query_threshold", 60000)
retries are done from the driver before it gives up.

The read timeout parameter is ignored on driver versions prior
to "5.1.12", "5.0.25" and "4.1.22". The write timeout parameter
is ignored on version prior to "5.1.12" and "5.0.25", the "4.1"
to 5.1.12”, “5.0.25 and 4.1.22. The write timeout parameter
is ignored on version prior to 5.1.12 and 5.0.25, the 4.1
release don't support it at all.

Default value is 2 (6 sec).
Expand Down
3 changes: 1 addition & 2 deletions modules/db_oracle/README
Expand Up @@ -20,8 +20,7 @@ Iouri Kharon

Copyright © 2007,2008 TRUNK MOBILE, INC.
Revision History
Revision $Revision$ $Date: 2009-07-21 10:45:05 +0300
(Tue, 21 Jul 2009) $
Revision $Revision: 5901 $ $Date$
__________________________________________________________

Table of Contents
Expand Down
17 changes: 8 additions & 9 deletions modules/db_perlvdb/README
Expand Up @@ -10,8 +10,7 @@ Bastian Friedrich

Copyright © 2007 Collax GmbH
Revision History
Revision $Revision$ $Date: 2009-07-21 10:45:05 +0300
(Tue, 21 Jul 2009) $
Revision $Revision: 9599 $ $Date$
__________________________________________________________

Table of Contents
Expand Down Expand Up @@ -62,13 +61,13 @@ Chapter 1. Admin Guide
need database access. Relaying of insert, update, query and
delete operations is supported.

Modules can be configured to use the perlvdb module as database
backend using the db_url_parameter:
Modules can be configured to use the db_perlvdb module as
database backend using the db_url_parameter:
modparam("acc", "db_url", "perlvdb:OpenSIPS::VDB::Adapter::AccountingSIP
trace")

This configuration options tells acc module that it should use
the perlvdb module which will in turn use the Perl class
the db_perlvdb module which will in turn use the Perl class
OpenSIPS::VDB::Adapter::AccountingSIPtrace to relay the
database requests.

Expand Down Expand Up @@ -110,10 +109,10 @@ Chapter 2. Developer Guide

2.2. Base class OpenSIPS::VDB

A client module has to be configured to use the perlvdb module
in conjunction with a Perl class to provide the functions. The
configured class needs to inherit from the base class
OpenSIPS::VDB.
A client module has to be configured to use the db_perlvdb
module in conjunction with a Perl class to provide the
functions. The configured class needs to inherit from the base
class OpenSIPS::VDB.

Derived classes have to implement the necessary functions
"query", "insert", "update" and/or "delete". The client module
Expand Down

0 comments on commit bcdbf27

Please sign in to comment.