Browse code

doc: reorganized the content of doc folder

Daniel-Constantin Mierla authored on 07/12/2016 13:54:42
Showing 1 changed files
1 1
deleted file mode 100644
... ...
@@ -1,132 +0,0 @@
1
-  _                      _                  _    ____ ___ 
2
- | |    ___   __ _  __ _(_)_ __   __ _     / \  |  _ \_ _|
3
- | |   / _ \ / _` |/ _` | | '_ \ / _` |   / _ \ | |_) | | 
4
- | |__| (_) | (_| | (_| | | | | | (_| |  / ___ \|  __/| | 
5
- |_____\___/ \__, |\__, |_|_| |_|\__, | /_/   \_\_|  |___|
6
-            |___/ |___/         |___/                    
7
-                         Ondrej Martinek <ondra@iptel.org>
8
-                                              January 2009
9
-
10
-This document contains the short description of the logging API in Kamailio
11
-for developers.
12
-
13
-Source files:
14
-    dprint.h
15
-    dprint.c
16
-
17
- Compile-time control macros
18
-=============================
19
-
20
-    NO_LOG
21
-	If defined, logging is completely disabled in SER and no messages
22
-        are produced at all
23
-	       
24
-    NO_DEBUG
25
-	If defined, logging messages do not include the source filename and
26
-	line location info
27
-
28
- Logging levels
29
-================
30
-
31
-    L_DBG   ... Debugging message (the lowest level)
32
-    L_INFO  ... Info message
33
-    L_WARN  ... Warning message
34
-    L_ERR   ... Error message
35
-    L_CRIT  ... Critical message
36
-    L_ALERT ... Alert message (the highest level)
37
-
38
-    The levels are implemented as integer macros.
39
-
40
- Related variables
41
-===================
42
-
43
-    debug
44
-	The config.framework setting that contains the current logging level.
45
-	The initial value can be specified by "debug" parameter in ser.cfg or
46
-	by -d options on the command-line.  The default value is L_WARN.
47
-
48
-    log_stderror
49
-	The global variable which specifies whether the log messages should be
50
-	send to the standard error output or syslog (equals to zero).
51
-	Its value can be specified by "log_stderr" parameter in ser.cfg or
52
-	-E option on the command-line.
53
-	
54
-    log_facility
55
-	The config.framework setting that contains the current facility for
56
-	logging to syslog.
57
-	The initial value can be specified by "log_facility" parameter in
58
-	ser.cfg.  The default value is LOG_DAEMON.
59
-
60
- Macro functions
61
-=================
62
-
63
-    * short macro aliases:
64
-	DBG(FMT, ARGS...)   alias for LOG(L_DBG, FMT, ARGS...)
65
-        INFO(FMT, ARGS...)  alias for LOG(L_INFO, FMT, ARGS...)
66
-        WARN(FMT, ARGS...)  alias for LOG(L_WARN, FMT, ARGS...)
67
-        ERR(FMT, ARGS...)   alias for LOG(L_ERR, FMT, ARGS...)
68
-        BUG(FMT, ARGS...)   alias for LOG(L_CRIT, FMT, ARGS...)
69
-        ALERT(FMT, ARGS...) alias for LOG(L_ALERT, FMT, ARGS...)
70
-
71
-    * LOG(LEVEL, FMT, ARGS...) macro
72
-	Prints the log message on stderr or syslog if the current debug level
73
-	is greater or equal to LEVEL.  The message has the following format:
74
-
75
-          - for messages by core:
76
-              PROC(PID) LEVEL: <core> [FILE:LINE]: MESSAGE
77
-
78
-          - for messages by modules:
79
-              PROC(PID) LEVEL: MODULE [FILE:LINE]: MESSAGE
80
-	      
81
-          - for messages by log(), xlog(), xdbg() script funcitons:
82
-              PROC(PID) LEVEL: <script>: MESSAGE
83
-
84
-	PROC is the SER process number and PID is the linux process ID.
85
-        LEVEL is one of "DEBUG", "INFO", "NOTICE", "WARNING", "ERROR",
86
-	"ALERT" and "BUG" strings.  MESSAGE is constructed from printf-like
87
-	arguments FMT and ARGS.
88
-
89
-        [FILE:LINE] location info is not present if NO_DEBUG macro is defined.
90
-  
91
-	Use of shorter aliases is preferred if LEVEL is a preprocess-time
92
-	constant.
93
-	
94
-    * LOG_(LEVEL, PREFIX, FMT, ARGS...) macro
95
-	Prints the log message on stderr or syslog if the current debug level
96
-	is greater or equal to LEVEL.  The message has the following format:
97
-	
98
-              PROC(PID) LEVEL: PREFIXMESSAGE
99
-
100
-	This is an internal macro try to avoid using it.
101
-
102
-
103
-
104
- APPENDIX: Summary of the changes to the original API
105
-======================================================
106
-
107
-  - LOG(LEVEL, FMT, ARGS...) and the short macro corresponding to LEVEL level
108
-    made eqvivalent (eg. LOG(L_DBG, FMT, ARGS...) and DBG(FMT, ARGS...) prints
109
-    always the same message)
110
-
111
-  - changed the format of log messages produced by the macros to include
112
-    the log level, module name, filename, line (if applicable)
113
-     
114
-  - added new, internal LOG_(LEVEL, PREFIX, FORMAT, ARGS...) macro
115
-
116
-  - removed DPrint() and DEBUG() macros, L_DEFAULT log level and dprint()
117
-    function
118
-
119
-!!!
120
-!!! IMPORTANT! READ ME!
121
-!!!
122
-!!!  These changes (mainly the first two) require reformating of the most log
123
-!!!  messages in Kamailio core and module source files.  This step can be done
124
-!!!  automatically by running "scripts/logging/fix-logs-all" script BUT it
125
-!!!  was NOT originally performed because it would have generated too many
126
-!!!  changes in CVS which was discouraged by Andrei.  Instead, the developers
127
-!!!  are expected to run it when ready.
128
-!!!
129
-!!! IMPORTANT! READ ME!
130
-!!!  
131
-
Browse code

doc Remove SVN ID's, remove history, change "SIP-router" and "ser" to "Kamailio"

Olle E. Johansson authored on 10/01/2015 08:47:18
Showing 1 changed files
... ...
@@ -7,7 +7,7 @@
7 7
                          Ondrej Martinek <ondra@iptel.org>
8 8
                                               January 2009
9 9
 
10
-This document contains the short description of the logging API in SIP-router
10
+This document contains the short description of the logging API in Kamailio
11 11
 for developers.
12 12
 
13 13
 Source files:
... ...
@@ -121,7 +121,7 @@ Source files:
121 121
 !!! IMPORTANT! READ ME!
122 122
 !!!
123 123
 !!!  These changes (mainly the first two) require reformating of the most log
124
-!!!  messages in SIP-router core and module source files.  This step can be done
124
+!!!  messages in Kamailio core and module source files.  This step can be done
125 125
 !!!  automatically by running "scripts/logging/fix-logs-all" script BUT it
126 126
 !!!  was NOT originally performed because it would have generated too many
127 127
 !!!  changes in CVS which was discouraged by Andrei.  Instead, the developers
... ...
@@ -130,5 +130,3 @@ Source files:
130 130
 !!! IMPORTANT! READ ME!
131 131
 !!!  
132 132
 
133
-$Id$
Browse code

Formatting and doxygen documentation updates

oej authored on 21/10/2009 08:21:47
Showing 1 changed files
... ...
@@ -7,7 +7,7 @@
7 7
                          Ondrej Martinek <ondra@iptel.org>
8 8
                                               January 2009
9 9
 
10
-This document contains the short description of the logging API in SER
10
+This document contains the short description of the logging API in SIP-router
11 11
 for developers.
12 12
 
13 13
 Source files:
... ...
@@ -121,7 +121,7 @@ Source files:
121 121
 !!! IMPORTANT! READ ME!
122 122
 !!!
123 123
 !!!  These changes (mainly the first two) require reformating of the most log
124
-!!!  messages in SER core and module source files.  This step can be done
124
+!!!  messages in SIP-router core and module source files.  This step can be done
125 125
 !!!  automatically by running "scripts/logging/fix-logs-all" script BUT it
126 126
 !!!  was NOT originally performed because it would have generated too many
127 127
 !!!  changes in CVS which was discouraged by Andrei.  Instead, the developers
Browse code

* logging API updated (see doc/logging-api.txt for details)

- LOG(LEVEL, FMT, ARGS...) and the short macro corresponding to
LEVEL level made eqvivalent (eg. LOG(L_DBG, FMT, ARGS...) and
DBG(FMT, ARGS...) prints always the same message)

- changed the format of log messages produced by the macros
to include the log level, module name, filename, line (if applicable)

- added new, internal LOG_(LEVEL, PREFIX, FORMAT, ARGS...) macro

- removed DPrint() and DEBUG() macros, L_DEFAULT log level and dprint()
function

!!!
!!! IMPORTANT! READ ME!
!!!

These changes (mainly the first two) require reformating of the most log
messages in SER core and module source files. This step can be done
automatically by running "scripts/logging/fix-logs-all" script BUT it
was NOT originally performed because it would have generated too many
changes in CVS which was discouraged by Andrei. Instead, the developers
are expected to run it when ready.

Ondrej Martinek authored on 06/01/2009 17:14:12
Showing 1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,134 @@
1
+  _                      _                  _    ____ ___ 
2
+ | |    ___   __ _  __ _(_)_ __   __ _     / \  |  _ \_ _|
3
+ | |   / _ \ / _` |/ _` | | '_ \ / _` |   / _ \ | |_) | | 
4
+ | |__| (_) | (_| | (_| | | | | | (_| |  / ___ \|  __/| | 
5
+ |_____\___/ \__, |\__, |_|_| |_|\__, | /_/   \_\_|  |___|
6
+            |___/ |___/         |___/                    
7
+                         Ondrej Martinek <ondra@iptel.org>
8
+                                              January 2009
9
+
10
+This document contains the short description of the logging API in SER
11
+for developers.
12
+
13
+Source files:
14
+    dprint.h
15
+    dprint.c
16
+
17
+ Compile-time control macros
18
+=============================
19
+
20
+    NO_LOG
21
+	If defined, logging is completely disabled in SER and no messages
22
+        are produced at all
23
+	       
24
+    NO_DEBUG
25
+	If defined, logging messages do not include the source filename and
26
+	line location info
27
+
28
+ Logging levels
29
+================
30
+
31
+    L_DBG   ... Debugging message (the lowest level)
32
+    L_INFO  ... Info message
33
+    L_WARN  ... Warning message
34
+    L_ERR   ... Error message
35
+    L_CRIT  ... Critical message
36
+    L_ALERT ... Alert message (the highest level)
37
+
38
+    The levels are implemented as integer macros.
39
+
40
+ Related variables
41
+===================
42
+
43
+    debug
44
+	The config.framework setting that contains the current logging level.
45
+	The initial value can be specified by "debug" parameter in ser.cfg or
46
+	by -d options on the command-line.  The default value is L_WARN.
47
+
48
+    log_stderror
49
+	The global variable which specifies whether the log messages should be
50
+	send to the standard error output or syslog (equals to zero).
51
+	Its value can be specified by "log_stderr" parameter in ser.cfg or
52
+	-E option on the command-line.
53
+	
54
+    log_facility
55
+	The config.framework setting that contains the current facility for
56
+	logging to syslog.
57
+	The initial value can be specified by "log_facility" parameter in
58
+	ser.cfg.  The default value is LOG_DAEMON.
59
+
60
+ Macro functions
61
+=================
62
+
63
+    * short macro aliases:
64
+	DBG(FMT, ARGS...)   alias for LOG(L_DBG, FMT, ARGS...)
65
+        INFO(FMT, ARGS...)  alias for LOG(L_INFO, FMT, ARGS...)
66
+        WARN(FMT, ARGS...)  alias for LOG(L_WARN, FMT, ARGS...)
67
+        ERR(FMT, ARGS...)   alias for LOG(L_ERR, FMT, ARGS...)
68
+        BUG(FMT, ARGS...)   alias for LOG(L_CRIT, FMT, ARGS...)
69
+        ALERT(FMT, ARGS...) alias for LOG(L_ALERT, FMT, ARGS...)
70
+
71
+    * LOG(LEVEL, FMT, ARGS...) macro
72
+	Prints the log message on stderr or syslog if the current debug level
73
+	is greater or equal to LEVEL.  The message has the following format:
74
+
75
+          - for messages by core:
76
+              PROC(PID) LEVEL: <core> [FILE:LINE]: MESSAGE
77
+
78
+          - for messages by modules:
79
+              PROC(PID) LEVEL: MODULE [FILE:LINE]: MESSAGE
80
+	      
81
+          - for messages by log(), xlog(), xdbg() script funcitons:
82
+              PROC(PID) LEVEL: <script>: MESSAGE
83
+
84
+	PROC is the SER process number and PID is the linux process ID.
85
+        LEVEL is one of "DEBUG", "INFO", "NOTICE", "WARNING", "ERROR",
86
+	"ALERT" and "BUG" strings.  MESSAGE is constructed from printf-like
87
+	arguments FMT and ARGS.
88
+
89
+        [FILE:LINE] location info is not present if NO_DEBUG macro is defined.
90
+  
91
+	Use of shorter aliases is preferred if LEVEL is a preprocess-time
92
+	constant.
93
+	
94
+    * LOG_(LEVEL, PREFIX, FMT, ARGS...) macro
95
+	Prints the log message on stderr or syslog if the current debug level
96
+	is greater or equal to LEVEL.  The message has the following format:
97
+	
98
+              PROC(PID) LEVEL: PREFIXMESSAGE
99
+
100
+	This is an internal macro try to avoid using it.
101
+
102
+
103
+--------------------------------------------------------------------------------
104
+
105
+ APPENDIX: Summary of the changes to the original API
106
+======================================================
107
+
108
+  - LOG(LEVEL, FMT, ARGS...) and the short macro corresponding to LEVEL level
109
+    made eqvivalent (eg. LOG(L_DBG, FMT, ARGS...) and DBG(FMT, ARGS...) prints
110
+    always the same message)
111
+
112
+  - changed the format of log messages produced by the macros to include
113
+    the log level, module name, filename, line (if applicable)
114
+     
115
+  - added new, internal LOG_(LEVEL, PREFIX, FORMAT, ARGS...) macro
116
+
117
+  - removed DPrint() and DEBUG() macros, L_DEFAULT log level and dprint()
118
+    function
119
+
120
+!!!
121
+!!! IMPORTANT! READ ME!
122
+!!!
123
+!!!  These changes (mainly the first two) require reformating of the most log
124
+!!!  messages in SER core and module source files.  This step can be done
125
+!!!  automatically by running "scripts/logging/fix-logs-all" script BUT it
126
+!!!  was NOT originally performed because it would have generated too many
127
+!!!  changes in CVS which was discouraged by Andrei.  Instead, the developers
128
+!!!  are expected to run it when ready.
129
+!!!
130
+!!! IMPORTANT! READ ME!
131
+!!!  
132
+
133
+--
134
+$Id$