mirror of
https://github.com/signalwire/freeswitch.git
synced 2026-10-09 21:14:02 +00:00
merge whitespace fixes from sofia-sip tree
git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@10802 d0543943-73ff-0310-b7d9-9358b9ac24b2
This commit is contained in:
@@ -73,8 +73,8 @@ Code-tree layout
|
||||
================
|
||||
|
||||
Most of the code resides in the libsofia-sip-ua directory.
|
||||
The main library, libsofia-sip-ua.so, is created by
|
||||
collecting object files (for example bnf/bnf_objs.o) from
|
||||
The main library, libsofia-sip-ua.so, is created by
|
||||
collecting object files (for example bnf/bnf_objs.o) from
|
||||
individual modules.
|
||||
|
||||
There are some portability issues with the way the
|
||||
@@ -89,13 +89,13 @@ See sofia-sip/docs/release_management.txt
|
||||
Developer documentation
|
||||
=======================
|
||||
|
||||
Generating reference documentation from source code
|
||||
Generating reference documentation from source code
|
||||
---------------------------------------------------
|
||||
|
||||
The libsofia-sip-ua library has a top-level make target
|
||||
"doxygen" for generating the HTML reference documentation.
|
||||
The pages will be created to libsofia-sip-ua/docs
|
||||
subdirectory.
|
||||
The pages will be created to libsofia-sip-ua/docs
|
||||
subdirectory.
|
||||
|
||||
This special target is primarily meant for use by
|
||||
the Sofia-SIP website admins, but can be used by anyone
|
||||
|
||||
@@ -14,16 +14,16 @@ be at least 1.7. You can avoid running autoreconf explicitly if you use
|
||||
Notes to distributors
|
||||
----------------------
|
||||
|
||||
Build options such as "--disable-stun" (HAVE_SOFIA_STUN) and
|
||||
Build options such as "--disable-stun" (HAVE_SOFIA_STUN) and
|
||||
"--disable-nth" (HAVE_SOFIA_NTH) modify the public library API/ABI,
|
||||
by omitting certain interfaces from the resulting library and installed
|
||||
header files.
|
||||
|
||||
Options such as '--disable-size-compat' modify the library
|
||||
ABI by changing the types used in public library function
|
||||
ABI by changing the types used in public library function
|
||||
signatures.
|
||||
|
||||
Generic POSIX (GNU/Linux, BSD, ...)
|
||||
Generic POSIX (GNU/Linux, BSD, ...)
|
||||
-----------------------------------
|
||||
|
||||
Sofia-SIP should compile out-of-the-box on generic POSIX
|
||||
@@ -35,17 +35,17 @@ The configure script accepts various options. See "./configure --help"
|
||||
for the full list.
|
||||
|
||||
|
||||
Mac OS X
|
||||
Mac OS X
|
||||
--------
|
||||
|
||||
TBD
|
||||
|
||||
Win32 / Mingw
|
||||
Win32 / Mingw
|
||||
-------------
|
||||
|
||||
TBD
|
||||
TBD
|
||||
|
||||
Win32 / Cygwin
|
||||
Win32 / Cygwin
|
||||
--------------
|
||||
|
||||
TBD
|
||||
|
||||
@@ -27,8 +27,8 @@ The release notes should contain the following sections:
|
||||
- maintained in sofia-sip/RELEASE
|
||||
- see diff between cvs/darcs between previous and
|
||||
this version
|
||||
- written in freshmeat.net "Changes:" style
|
||||
- notes on API/ABI interface changes
|
||||
- written in freshmeat.net "Changes:" style
|
||||
- notes on API/ABI interface changes
|
||||
- maintained in sofia-sip/RELEASE
|
||||
- all changes in public interfaces, plus other
|
||||
notes that developers should be aware of
|
||||
@@ -41,7 +41,7 @@ The release notes should contain the following sections:
|
||||
See the RELEASE.template file for a full list of release note
|
||||
sections.
|
||||
|
||||
Making the release tarball
|
||||
Making the release tarball
|
||||
==========================
|
||||
|
||||
- basics: check system clock of the build host ;)
|
||||
@@ -71,15 +71,15 @@ Creating the release notes and updating the website
|
||||
|
||||
- combine the sofia-sip/RELEASE contents with
|
||||
the template found from sfnet_www/templates/relnotes.txt
|
||||
- store the resulting release notes to
|
||||
- store the resulting release notes to
|
||||
sfnet_www/relnotes/relnotes-sofia-sip-x.y.z.txt
|
||||
- add explicit link to the release notes to
|
||||
- add explicit link to the release notes to
|
||||
sfnet_www/download.html (three most recent releases,
|
||||
see guidelines in the html comments)
|
||||
- update sfnet_www/index.html to mention the latest
|
||||
release
|
||||
- commit the change to sf.net website CVS, and run the
|
||||
sfnet_www/put_online.sh script
|
||||
- commit the change to sf.net website CVS, and run the
|
||||
sfnet_www/put_online.sh script
|
||||
|
||||
Uploading the release to sourceforge.net
|
||||
========================================
|
||||
@@ -104,8 +104,8 @@ After release
|
||||
|
||||
- replace the RELEASE file with RELEASE.template, and
|
||||
commit it to master source repository (see sofia-sip/README.developers)
|
||||
- change version in configure.ac from "X.Y.Z" to
|
||||
"X.Y.Zdevel" (as it is in many cases unknown what the
|
||||
- change version in configure.ac from "X.Y.Z" to
|
||||
"X.Y.Zdevel" (as it is in many cases unknown what the
|
||||
next version will be)
|
||||
- make a "tree open for development" commit
|
||||
|
||||
@@ -122,15 +122,15 @@ tree.
|
||||
|
||||
- Always tag the src-tree with "syncuser-fromvcs-to-tovcs-yearmmdd".
|
||||
|
||||
- Add a top-level ChangeLog entry that documents all the
|
||||
- Add a top-level ChangeLog entry that documents all the
|
||||
changes made outside the target tree (what, who and when -
|
||||
for example produced with the "darcs changes --summary"
|
||||
for example produced with the "darcs changes --summary"
|
||||
command).
|
||||
|
||||
Checking API/ABI compatibility
|
||||
==============================
|
||||
|
||||
- Use a unit test binary built against an old library,
|
||||
- Use a unit test binary built against an old library,
|
||||
to verify a new library version (forwards-compatibility).
|
||||
- Use the 'icheck' tool (in Debian) to make comparison
|
||||
between two released versions.
|
||||
|
||||
Reference in New Issue
Block a user