[asterisk-commits] russell: branch russell/project_docs r161680 - in /team/russell/project_docs:...
SVN commits to the Asterisk project
asterisk-commits at lists.digium.com
Mon Dec 8 10:25:17 CST 2008
Author: russell
Date: Mon Dec 8 10:25:16 2008
New Revision: 161680
URL: http://svn.digium.com/view/asterisk?view=rev&rev=161680
Log:
Add some info on the status of each Asterisk release
Modified:
team/russell/project_docs/contrib/asterisk-ng-doxygen
team/russell/project_docs/include/asterisk/doxyref.h
team/russell/project_docs/main/asterisk.c
Modified: team/russell/project_docs/contrib/asterisk-ng-doxygen
URL: http://svn.digium.com/view/asterisk/team/russell/project_docs/contrib/asterisk-ng-doxygen?view=diff&rev=161680&r1=161679&r2=161680
==============================================================================
--- team/russell/project_docs/contrib/asterisk-ng-doxygen (original)
+++ team/russell/project_docs/contrib/asterisk-ng-doxygen Mon Dec 8 10:25:16 2008
@@ -178,6 +178,7 @@
# You can put \n's in the value part of an alias to insert newlines.
ALIASES = "extref=\xrefitem extref \"ExtRef\" \"External references\""
+ALIASES += "AsteriskTrunkWarning=\note The information contained on this page may be out of date. To make sure you get the most current information, please make sure that you are using the documentation generated from Asterisk trunk."
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
# sources only. Doxygen will then generate output that is more tailored for C.
Modified: team/russell/project_docs/include/asterisk/doxyref.h
URL: http://svn.digium.com/view/asterisk/team/russell/project_docs/include/asterisk/doxyref.h?view=diff&rev=161680&r1=161679&r2=161680
==============================================================================
--- team/russell/project_docs/include/asterisk/doxyref.h (original)
+++ team/russell/project_docs/include/asterisk/doxyref.h Mon Dec 8 10:25:16 2008
@@ -27,10 +27,11 @@
*/
/*!
- * \page DevDoc Asterisk Developer's Documentation - appendices
+ * \page DevDoc Asterisk Developer's Documentation - Appendices
*
* \section devpolicy Development and Release Policies
- * \arg \ref CodeGuide : The must-read document for all developer's
+ * \arg \ref CodeGuide : The must-read document for all developers
+ * \arg \ref ReleaseStatus : The current support level for various Asterisk releases
* \arg \ref AstCREDITS : A Thank You to contributors (unfortunately out of date)
*
* \section apisandinterfaces Asterisk APIs and Interfaces
@@ -49,7 +50,7 @@
* \arg \ref AstSpeech
*
* \section debugconfig Debugging and Configuration References
- * \arg \ref AstREADME
+ * \arg \ref AstREADME : General Administrator README file
* \arg \ref AstDebug : Hints on debugging
* \arg \ref extref
* \arg \ref ConfigFiles
@@ -64,8 +65,108 @@
* \arg \b Digium: The Asterisk Company http://www.digium.com
*/
+/*!
+ * \page ReleaseStatus Asterisk Releases
+ *
+ * @AsteriskTrunkWarning
+ *
+ * \section warranty Warranty
+ * The following warranty applies to all open source releases of Asterisk:
+ *
+ * NO WARRANTY
+ *
+ * BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+ * FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+ * OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+ * PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+ * OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+ * TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+ * PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+ * REPAIR OR CORRECTION.
+
+ * IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+ * WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+ * REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+ * INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+ * OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+ * TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+ * YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+ * PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGES.
+ *
+ * \section releasestatustypes Release Status Types
+ *
+ * Release management is a essentially an agreement between the development
+ * community and the user community on what kind of updates can be expected
+ * for Asterisk releases, and what types of changes these updates will contain.
+ * Once these policies are established, the development community works very
+ * hard to adhere to them. However, the development community does reserve
+ * the right to make exceptions to these rules for special cases as the need
+ * arises.
+ *
+ * Asterisk releases are in various states of maintenance. The states are
+ * defined here:
+ *
+ * \arg <b>None</b> - This release series is receiving no updates whatsoever.
+ * \arg <b>Security-Only</b> - This release series is receiving updates, but
+ * only to address security issues. Security issues found and fixed in
+ * this release series will be accompanied by a published security advisory
+ * from the Asterisk project.
+ * \arg <b>Full-Support</b> - This release series is receiving updates for all
+ * types of bugs.
+ * \arg <b>Full-Development</b> - Changes in this part of Asterisk include bug
+ * fixes, as well as new features and architectural improvements.
+ *
+ * \section AsteriskReleases Asterisk Maintenance Levels
+ *
+ * \htmlonly
+ * <table border="1">
+ * <tr>
+ * <td><b>Name</b></td>
+ * <td><b>SVN Branch</b></td>
+ * <td><b>Status</b></td>
+ * <td><b>Notes</b></td>
+ * </tr>
+ * <tr>
+ * <td>Asterisk 1.0</td>
+ * <td>/branches/1.0</td>
+ * <td>None</td>
+ * </tr>
+ * <tr>
+ * <td>Asterisk 1.2</td>
+ * <td>/branches/1.2</td>
+ * <td>Security-Only</td>
+ * </tr>
+ * <tr>
+ * <td>Asterisk 1.4</td>
+ * <td>/branches/1.4</td>
+ * <td>Full-Support</td>
+ * </tr>
+ * <tr>
+ * <td>Asterisk 1.6.0</td>
+ * <td>/branches/1.6.0</td>
+ * <td>Full-Support</td>
+ * </tr>
+ * <tr>
+ * <td>Asterisk 1.6.1</td>
+ * <td>/branches/1.6.1</td>
+ * <td>Full-Support</td>
+ * <td>Still in beta</td>
+ * </tr>
+ * <tr>
+ * <td>Asterisk trunk</td>
+ * <td>/trunk</td>
+ * <td>Full-Development</td>
+ * <td>No releases are made directly from trunk.</td>
+ * </tr>
+ * </table>
+ * \endhtmlonly
+ */
+
/*!
* \page CodeGuide Coding Guidelines
+ * \AsteriskTrunkWarning
* \section Coding Guidelines
* This file is in the /doc directory in your Asterisk source tree.
* Make sure to stay up to date with the latest guidelines.
@@ -152,7 +253,7 @@
*/
/*!
- * \page AstREADME : README - the general administrator introduction
+ * \page AstREADME README
* \verbinclude README
*/
Modified: team/russell/project_docs/main/asterisk.c
URL: http://svn.digium.com/view/asterisk/team/russell/project_docs/main/asterisk.c?view=diff&rev=161680&r1=161679&r2=161680
==============================================================================
--- team/russell/project_docs/main/asterisk.c (original)
+++ team/russell/project_docs/main/asterisk.c Mon Dec 8 10:25:16 2008
@@ -22,17 +22,24 @@
* \mainpage Asterisk -- An Open Source Telephony Toolkit
*
* \par Developer Documentation for Asterisk
+ *
* This is the main developer documentation for Asterisk. It is
- * generated by running "make progdocs".
+ * generated by running "make progdocs" from the Asterisk source tree.
+ *
+ * In addition to the information available on the Asterisk source code,
+ * please see the appendices for information on coding guidelines,
+ * release management, commit policies, and more.
+ *
* \par Additional documentation
* \arg \ref Licensing
* \arg \ref DevDoc
* \arg \ref ConfigFiles
*
- * \section copyright Copyright and author
+ * \section copyright Copyright and Author
*
* Copyright (C) 1999 - 2008, Digium, Inc.
- * Asterisk is a trademark registered by Digium, Inc.
+ * Asterisk is a <a href="http://www.digium.com/en/company/view-policy.php?id=Trademark-Policy">registered trademark</a>
+ * of <a href="http://www.digium.com">Digium, Inc</a>.
*
* \author Mark Spencer <markster at digium.com>
* Also see \ref AstCREDITS
@@ -40,9 +47,8 @@
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
* any of the maintainers of this project for assistance;
- * the project provides a web site, mailing lists and IRC
+ * the project provides a web site, mailing lists, and IRC
* channels for your use.
- *
*/
/*! \file
More information about the asterisk-commits
mailing list