Commit 109c1d14 authored by Pekka Pessi's avatar Pekka Pessi

Added release_management.txt (kv)

darcs-hash:20051011145442-65a35-7da957551af9019d55e18ce006ff8c306baa6db0.gz
parent b72f8c21
......@@ -3,28 +3,27 @@ Sofia-SIP build system README
=============================
:Author: Kai Vehmanen <kai -dot vehmanen -at- nokia -dot- com>
:Version: 20050722-4
:Author: Pekka Pessi <pekka -dot pessi -at- nokia -dot- com>
:Version: 20051011-5
:Formatting: reStructuredText, http://docutils.sourceforge.net/rst.html
------------
Introduction
------------
============
The Sofia-SIP build system practices are documented in this
file. The instructions are aimed at developers.
-----------
Quick start
-----------
===========
To build Sofia-IP::
sh> ``./autogen.sh`` (if building from a fresh CVS checkout)
sh> ``./configure``
sh> ``make``
--------------
sh> ``./autogen.sh`` (if building from a fresh CVS checkout)
sh> ``./configure``
sh> ``make``
Autotool notes
--------------
==============
Macros
------
......@@ -52,9 +51,8 @@ Those developers who need to often modify configure.ac, Makefile.am
and macro files, can enable maintainer mode with configure
option '--enable-maintainer-mode'.
-------------
Running tests
-------------
=============
Sofia-SIP has quite complete suite of test cases. It is prudent to
run them while making changes and before committing them to revision
......@@ -63,9 +61,8 @@ time. Therefore, they are run only if the environment variable
EXPENSIVE_CHECKS has been set. EXPENSIVE_CHECKS is also set by the build
system if configure option '--enable-expensive-checks' has been used.
----------------
Code-tree layout
----------------
================
Most of the code resides in the libsofia-sip-ua directory.
The main library, libsofia-sip-ua.so, is created by
......@@ -76,21 +73,13 @@ There are some portability issues with the way the
shared library is currently built, and we are looking
for ways to improve the situation.
---------------
Making releases
---------------
===============
Checklist
---------
See sofia-sip/docs/release_management.txt
- check contents of configure.ac (especially the version number)
- ``make distchek``
- upload the resulting tar.gz file to Source forge and make an
announcement on the sofia-sip-devel@lists.sourceforge.net mailing list
-----------------------
Developer documentation
-----------------------
=======================
Generating reference documentation from source code
---------------------------------------------------
......
===================================
Sofia-SIP release management README
===================================
:Author: Kai Vehmanen <kai -dot vehmanen -at- nokia -dot- com>
:Version: 20051011-1
:Formatting: reStructuredText, http://docutils.sourceforge.net/rst.html
Introduction
============
This README contains instructions for making
new Sofia-SIP releases.
Links to other resources
========================
sofia-sip/README.developers
The release notes
=================
The release notes should contain the following
sections:
- about Sofia-SIP
- copied verbatim from sofia-sip/README
- list of changes since last release
- maintained in sofia-sip/RELEASE
- notes on API/ABI interface changes
- maintained in sofia-sip/RELEASE
- contributors to this release
- maintained in sofia-sip/RELEASE
- also sofia-sip/AUTHORS should be updated
Making the release tarball
==========================
- update the version number in sofia-sip/configure.ac
- make sure everything that is supposed to be in the
release is in CVS
- tag CVS-tree with release tag: 'REL_x_y_z', where
x_y_z is the version number (see README.developers)
- run 'make distcheck' (requires automake-1.7 or newer)
- calculate md5 and sha1 hashes using md5sum and sha1sum,
and copy the values to the release-notes
- release file using
- upload the resulting tar.gz file to Sourceforge
- sent the release annoucement to the
sofia-sip-devel@lists.sourceforge.net mailing list (see
section below making the release notes)
Creating the release notes
==========================
- combine the sofia-sip/RELEASE contents with
the template found from sfnet_www/templates/relnotes.txt
- store the release notes to
sfnet_www/relnotes/relnotes-sofia-sip-x.y.z.txt
- commit the change to CVS, and run the
sfnet_www/put_online.sh script at the sourceforge.net
shell server
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment