NameDateSize

..16-Mar-201612 KiB

.gitignore29-Dec-2012317

AUTHORS29-Dec-20122.4 KiB

autoconf-all.cmd29-Dec-201241

autogen.sh29-Dec-2012227

ChangeLog29-Dec-2012706

ChangeLog.ext-trees29-Dec-2012139.6 KiB

configure.ac29-Dec-201210.9 KiB

COPYING29-Dec-201225.8 KiB

COPYRIGHTS29-Dec-201211.2 KiB

docs/29-Dec-20124 KiB

libsofia-sip-ua/29-Dec-20124 KiB

libsofia-sip-ua-glib/29-Dec-20124 KiB

m4/29-Dec-20124 KiB

Makefile.am29-Dec-20122.2 KiB

open_c/29-Dec-20124 KiB

packages/29-Dec-20124 KiB

README29-Dec-20121.9 KiB

README.developers29-Dec-20124.1 KiB

RELEASE29-Dec-20124.4 KiB

RELEASE.template29-Dec-20122.4 KiB

rules/29-Dec-20124 KiB

s2check/29-Dec-20124 KiB

scripts/29-Dec-20124 KiB

tests/29-Dec-20124 KiB

TODO29-Dec-2012931

utils/29-Dec-20124 KiB

win32/29-Dec-20124 KiB

README

1=============================================================
2README / Sofia-SIP - RFC3261 compliant SIP User-Agent library
3=============================================================
4
5Introduction
6------------
7
8Sofia-SIP is an open-source SIP User-Agent library, compliant
9with the IETF RFC3261 specification. It can be used as
10a building block for SIP client software for uses such as VoIP,
11IM, and many other real-time and person-to-person communication
12services. The primary target platform for Sofia-SIP is
13GNU/Linux. Sofia-SIP is based on a SIP stack developed at
14the Nokia Research Center. Sofia-SIP is licensed under the LGPL.
15
16
17Quick start
18-----------
19
20Sofia-SIP uses the GNU autotools, so building procedure
21is the usual:
22
23sh> sh autogen.sh (if building from darcs)
24sh> ./configure
25sh> make
26sh> make install
27
28See also 'docs/devel_platform_notes.txt' for notes on compiling
29Sofia-SIP in different environments.
30
31See the "options-client-example" (available using darcs at
32http://sofia-sip.org/repos/options-client-example/ or with CVS as
33a module in Sofia-SIP CVS tree) for an example of a small app that
34is utilizing Sofia-SIP, and specifically the libsofia-sip-ua
35library component.
36
37There are also multiple example clients under
38the "sofia-sip/utils" directory:
39
40- sip-options, query using SIP OPTIONS method
41- sip-date, SIP date printer/parser
42
43The Sofia-SIP su submodule also provides some small utilities:
44
45- addrinfo (libsofia-sip-ua/su), resolve host names
46- localinfo (libsofia-sip-ua/su), prints information about
47  local network interfaces
48
49References
50----------
51
52Project website:
53- http://sofia-sip.sourceforge.net
54- http://www.sourceforge.net/projects/sofia-sip
55
56Mailing list:
57- http://sourceforge.net/mail/?group_id=143636
58
59Version control repositories:
60- see the project website (link above)
61
62Licensing
63---------
64
65Sofia-SIP is licensed under terms of the GNU LGPL.
66See the file "COPYING" for more information.
67

README.developers

1===============================================================
2README.developers - Sofia-SIP development practices
3===============================================================
4
5Introduction
6============
7
8This file is a collection of practices and rules for Sofia-SIP
9development. If you have questions, or would like to make
10changes, raise the issue on sofia-sip-devel (see
11http://lists.sourceforge.net/lists/listinfo/sofia-sip-devel ).
12
13
14Important files for developers
15==============================
16
17AUTHORS
18	List of contributors. When contributing new code, add
19	yourself to AUTHORS, and also remember to update the
20	per source file copyright statements.
21
22COPYRIGHTS
23	List of licenses and related copyright statements. While
24	majority of Sofia-SIP is licensed under LGPL, there are
25	a few files with different, but LGPL compatible, licensing
26	terms.
27
28README.developers
29	This file.
30
31TODO
32	Not in active use yet.
33
34<dir>/ChangeLog files
35	All non-trivial changes to the source code should
36	be documented in the ChangeLog files. See also the
37	top-level ChangeLog.
38
39
40Version numbering
41=================
42
43Package version
44---------------
45
46For public releases, the package version is:
47     vMAJOR.MINOR.REVISION, where MINOR is even
48
49For development releases and snaphots the version is one of:
50     vMAJOR.MINOR.REVISION, where minor is odd
51     vMAJOR.MINOR.REVISION.YEAR.MONTH.DAY, where minor is odd
52
53For all releases, the version should be changed in configure.ac
54and committed to Darcs/CVS before making the release package. The person
55doing the release is responsible for updating the version number.
56
57Library interface versions
58--------------------------
59
60Sofia-SIP libraries utilize libtool interface versioning. See
61
62  - http://www.gnu.org/software/libtool/manual.html#Versioning
63  - http://www.gnu.org/software/libtool/manual.html#Using-Automake
64
65The interface versions are set in top-level 'configure.ac' file.
66Additionally, the SONAME version (CURRENT-AGE) is set in the
67same place. These version numbers are available for use as autoconf
68variables (see the library 'Makefile.am' files and
69'packages/sofia-sip.spec.in').
70
71All changes to the library versions should be marked to the
72appropriate library 'ChangeLog' file. The library version should
73be changed at the same time as the first interface change is
74committed since the previous release. The interface version is
75frozen (should be marked to the 'ChangeLog' file) at the time
76the next release is tagged (in other words, intra-release changes
77need not be tracked with libtool versions).
78
79The goal should always be to avoid breaking the API/ABIs until
80absolutely necessary. Interfaces clearly marked as private can
81be changed without change to library interface version, but
82otherwise all public functions, types, variables and definitions
83fall under interface change control.
84
85
86Version control tags
87====================
88
89Tagging releases and snapshots
90------------------------------
91
92- source repository (*)
93    - master Darcs tree at:
94      http://sofia-sip.org/repos/sofia-sip
95    - CVS tree (only used to track major releases) at:
96      http://sourceforge.net/cvs/?group_id=143636
97- tags: rel-sofia-sip-x_y_z
98    - stable and development releases (matches release
99      version sofia-sip-x.y.z)
100- tags: snapshot_rel_YEARMMDD
101    - snapshot releases at
102      http://sofia-sip.sourceforge.net/snapshots/
103
104Notes (*):
105    - Information about Darcs:
106      http://abridgegame.org/darcs/
107      http://lwn.net/Articles/110516/
108
109
110Sending patches
111===============
112
113People without Darcs access
114---------------------------
115
116Send your patches to sofia-sip-devel. Someone from the
117development team (see AUTHORS) will handle the patch.
118
119People with Darcs access
120------------------------
121
122Trivial changes can be committed without review. For non-trivial
123changes, you should first send a proposal to sofia-sip-devel and
124wait for comments. There are no strict approval rules so use of
125common sense is recommended. ;)
126
127Tips for making patches
128-----------------------
129
130- test your patch on a clean checkout from version control system
131- remember to check for updates before pushing your changes
132  to the master repository
133
134
135