[SR-Dev] git:janakj/postgres: - Spelling checked
Jan Janak
jan at iptel.org
Sun Feb 15 18:55:26 CET 2009
Module: sip-router
Branch: janakj/postgres
Commit: dbbb5df46a36f04cddd2b108dc200761117cb2c4
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=dbbb5df46a36f04cddd2b108dc200761117cb2c4
Author: Jan Janak <jan at iptel.org>
Committer: Jan Janak <jan at iptel.org>
Date: Tue Aug 24 08:58:23 2004 +0000
- Spelling checked
- READMEs updated
---
modules/db_postgres/README | 175 +++++++++++++++++++++++++++++---------
modules/db_postgres/aug_sysdep.h | 4 +-
modules/db_postgres/db_mod.c | 4 +-
modules/db_postgres/db_utils.c | 4 +-
modules/db_postgres/db_val.c | 2 +-
5 files changed, 143 insertions(+), 46 deletions(-)
diff --git a/modules/db_postgres/README b/modules/db_postgres/README
index 5ced10b..6e2bd9c 100644
--- a/modules/db_postgres/README
+++ b/modules/db_postgres/README
@@ -1,39 +1,136 @@
-# $Id$
-#
-# README
-#
-# History:
-# --------
-# 2003-04-07 this is a hack, from serctl, to make work with postgres
-#
-# DISCLAIMER:
-# I have yet to get this software working in my production environment.
-# Everything compiles and runs, but not for long. It may or may not be a
-# good starting point for the ser postgres driver.
-#
-# I had a hard time with memory while developing this.
-# So, I decided to incorporate some memory routines that
-# I have been using for years. This didn't fix the problem,
-# but it did make memory management easier.
-#
-# The postgres driver requires that you have postgres installed
-# on your system. You can download this from: www.postgresql.org.
-# For this I used postgres version 7.3.2, but I imagine almost any
-# recent version should work.
-#
-# You will then need to have a postgres database somewhere, and it
-# needs to have the tables created in it. Currently I am supporting
-# 2 tables, location and subscriber. The file createtables.txt contains
-# the table definitions and index definitions.
-#
-# You may wish to load the tables from a 0.8.10 database. The script
-# copy_to_psql can be modified to open your mysql database and it outputs
-# the necessary commands to populate the tables of the postgres database.
-#
-# To use the postgres module in your ser.cfg file is just like using the
-# mysql module. Ie:
-# loadmodule "/usr/local/lib/ser/modules/postgres.so"
-#
-# That's it. Good luck.
-# ---greg
-# Greg Fausak, August.Net Services, greg at august.net
+
+postgres Module
+
+Greg Fausak
+
+ August.net
+
+Edited by
+
+Greg Fausak
+
+ Copyright © 2003 Greg Fausak
+ _________________________________________________________
+
+ Table of Contents
+ 1. User's Guide
+
+ 1.1. Overview
+ 1.2. Dependencies
+
+ 1.2.1. SER Modules
+ 1.2.2. External Libraries or Applications
+
+ 1.3. Exported Parameters
+
+ 1.3.1. param_name (param_type)
+
+ 1.4. Exported Functions
+
+ 1.4.1. function_name(param1, param2)
+
+ 1.5. Installation & Running
+
+ 2. Developer's Guide
+ 3. Frequently Asked Questions
+
+ List of Examples
+ 1-1. Set param_name parameter
+ 1-2. function_name usage
+ _________________________________________________________
+
+Chapter 1. User's Guide
+
+1.1. Overview
+
+ Module description
+ _________________________________________________________
+
+1.2. Dependencies
+
+1.2.1. SER Modules
+
+ The following modules must be loaded before this module:
+
+ * No dependencies on other SER modules.
+ _________________________________________________________
+
+1.2.2. External Libraries or Applications
+
+ The following libraries or applications must be installed
+ before running SER with this module loaded:
+
+ * None.
+ _________________________________________________________
+
+1.3. Exported Parameters
+
+1.3.1. param_name (param_type)
+
+ Param description.
+
+ Default value is "value".
+
+ Example 1-1. Set param_name parameter
+...
+modparam("module", "param_name", "param_value")
+...
+ _________________________________________________________
+
+1.4. Exported Functions
+
+1.4.1. function_name(param1, param2)
+
+ Description
+
+ Meaning of the parameters is as follows:
+
+ * param1 - description.
+ * param2 - description.
+
+ Example 1-2. function_name usage
+...
+function_name("sample_param1", "sample_param2");
+...
+ _________________________________________________________
+
+1.5. Installation & Running
+
+ Notes about installation and running.
+ _________________________________________________________
+
+Chapter 2. Developer's Guide
+
+ The module does not provide any sort of API to use in other
+ SER modules.
+ _________________________________________________________
+
+Chapter 3. Frequently Asked Questions
+
+ 3.1. Where can I find more about SER?
+ 3.2. Where can I post a question about this module?
+ 3.3. How can I report a bug?
+
+ 3.1. Where can I find more about SER?
+
+ Take a look at http://iptel.org/ser.
+
+ 3.2. Where can I post a question about this module?
+
+ First at all check if your question was already answered on
+ one of our mailing lists:
+
+ * http://mail.iptel.org/mailman/listinfo/serusers
+ * http://mail.iptel.org/mailman/listinfo/serdev
+
+ E-mails regarding any stable version should be sent to
+ <serusers at iptel.org> and e-mail regarding development versions
+ or CVS snapshots should be send to <serdev at iptel.org>.
+
+ If you want to keep the mail private, send it to
+ <serhelp at iptel.org>.
+
+ 3.3. How can I report a bug?
+
+ Please follow the guidelines provided at:
+ http://iptel.org/ser/bugs
diff --git a/modules/db_postgres/aug_sysdep.h b/modules/db_postgres/aug_sysdep.h
index 78b594a..42936c2 100644
--- a/modules/db_postgres/aug_sysdep.h
+++ b/modules/db_postgres/aug_sysdep.h
@@ -60,7 +60,7 @@
#define AUG_SYSDEP_H
/*
-** As necessary, detect operating system, cpu, and compiler
+** As necessary, detect operating system, CPU, and compiler
** combinations, and establish defines that describe the
** characteristics and requirements for the combination.
**
@@ -73,7 +73,7 @@
** AUG_NO_xxxx System doesn't have capability xxxx
** AUG_BAD_xxxx System has xxxx, but it's broken
**
-** Every system gets AUG_CONFIGURATION so we can reject unconfigured
+** Every system gets AUG_CONFIGURATION so we can reject misconfigured
** compiles. This should be set to an os/cpu/compiler description.
*/
#undef AUG_CONFIGURATION
diff --git a/modules/db_postgres/db_mod.c b/modules/db_postgres/db_mod.c
index 435b8eb..7f8dd59 100644
--- a/modules/db_postgres/db_mod.c
+++ b/modules/db_postgres/db_mod.c
@@ -3,7 +3,7 @@
*
* Postgres module interface
*
- * Copyright (C) 2001-2003 Fhg Fokus
+ * Copyright (C) 2001-2003 FhG Fokus
*
* This file is part of ser, a free SIP server.
*
@@ -66,7 +66,7 @@ static cmd_export_t cmds[]={
struct module_exports exports = {
"postgres",
cmds,
- 0, /* module paramers */
+ 0, /* module parameters */
mod_init, /* module initialization function */
0, /* response function*/
diff --git a/modules/db_postgres/db_utils.c b/modules/db_postgres/db_utils.c
index e7f8fca..d5febbb 100644
--- a/modules/db_postgres/db_utils.c
+++ b/modules/db_postgres/db_utils.c
@@ -115,7 +115,7 @@ int parse_sql_url(char* _url, char** _user, char** _pass,
/*
- * Remove any tabs and spaces from the begining and the end of
+ * Remove any tabs and spaces from the beginning and the end of
* a string
*/
char* trim(char* _s)
@@ -126,7 +126,7 @@ char* trim(char* _s)
/* Null pointer, there is nothing to do */
if (!_s) return _s;
- /* Remove spaces and tabs from the begining of string */
+ /* Remove spaces and tabs from the beginning of string */
while ((*_s == ' ') || (*_s == '\t')) _s++;
len = strlen(_s);
diff --git a/modules/db_postgres/db_val.c b/modules/db_postgres/db_val.c
index d80ec04..b885341 100644
--- a/modules/db_postgres/db_val.c
+++ b/modules/db_postgres/db_val.c
@@ -351,7 +351,7 @@ int val2str(db_val_t* _v, char* _s, int* _len)
break;
default:
- DBG("val2str(): Unknow data type\n");
+ DBG("val2str(): Unknown data type\n");
return -7;
}
return -8;
More information about the sr-dev
mailing list