From: <den...@us...> - 2010-07-25 16:06:55
|
Revision: 231 http://stdair.svn.sourceforge.net/stdair/?rev=231&view=rev Author: denis_arnaud Date: 2010-07-25 16:06:47 +0000 (Sun, 25 Jul 2010) Log Message: ----------- [Doc] HTML documentation is no longer generated (as it is, nevertheless, specific to each project). Modified Paths: -------------- trunk/stdair/configure.ac trunk/stdair/doc/local/Makefile.am trunk/stdair/doc/local/sources.mk Added Paths: ----------- trunk/stdair/doc/local/index.doc trunk/stdair/doc/sourceforge/howto_release_stdair.html Removed Paths: ------------- trunk/stdair/doc/local/index.doc.in trunk/stdair/doc/sourceforge/howto_release_stdair.html.in Property Changed: ---------------- trunk/stdair/doc/local/ trunk/stdair/doc/sourceforge/ Modified: trunk/stdair/configure.ac =================================================================== --- trunk/stdair/configure.ac 2010-07-24 17:09:19 UTC (rev 230) +++ trunk/stdair/configure.ac 2010-07-25 16:06:47 UTC (rev 231) @@ -222,15 +222,13 @@ stdair/service/Makefile stdair/core/Makefile stdair/batches/Makefile - man/Makefile + man/Makefile doc/Makefile doc/images/Makefile doc/tutorial/Makefile doc/tutorial/src/Makefile doc/local/Makefile - doc/local/index.doc doc/doxygen_html.cfg - doc/sourceforge/howto_release_stdair.html extracppunit/Makefile test/Makefile test/samples/Makefile Property changes on: trunk/stdair/doc/local ___________________________________________________________________ Modified: svn:ignore - Makefile Makefile.in index.doc + Makefile Makefile.in Modified: trunk/stdair/doc/local/Makefile.am =================================================================== --- trunk/stdair/doc/local/Makefile.am 2010-07-24 17:09:19 UTC (rev 230) +++ trunk/stdair/doc/local/Makefile.am 2010-07-25 16:06:47 UTC (rev 231) @@ -1,3 +1,4 @@ +# stdair/doc/local sub-directory include $(top_srcdir)/Makefile.common include $(srcdir)/sources.mk Added: trunk/stdair/doc/local/index.doc =================================================================== --- trunk/stdair/doc/local/index.doc (rev 0) +++ trunk/stdair/doc/local/index.doc 2010-07-25 16:06:47 UTC (rev 231) @@ -0,0 +1,87 @@ +/*! +\mainpage StdAir Documentation + +\htmlonly +<!-- start of main block --> +<div style="width: 100%;"> +<!-- start of left margin --> +<div style="float:right; width:200px; background-color: #eeeeff; + border: 1px solid #b0b0b0; margin: 0 0 10px 20px; padding: 10px; + font-size: 90%;"> + +<b>Getting Started:</b> +<ul> +<li><a href="features.html">Features</a></li> +<li><a href="installation.html">Installation</a></li> +<li><a href="linking.html">Linking with StdAir</a></li> +<li><a href="users_guide.html">Short Introduction to StdAir</a></li> +<li><a href="tutorial.html">Some Tutorial Examples</a></li> +<li><a href="verification.html">StdAir Verification</a></li> +<li><a href="copyright.html">Copyright and License</a></li> +<li><a href="help_wanted.html">Make a Difference</a></li> +<li><a href="authors.html">Authors</a></li> +</ul> + +<a href="http://sourceforge.net/projects/stdair/"><b>StdAir at SourceForge:</b></a> +<ul> +<li><a href="http://sourceforge.net/project/showfiles.php?group_id=267760">Download StdAir</a></li> +<li><a href="http://stdair.sourceforge.net/RPM-GPG-KEY-freshrpms-free">RPM-GPG-Key</a> for StdAir RPMs (save the file, and type 'rpm --import RPM-GPG-KEY-freshrpms-free' as root)</li> +<li><a href="http://sourceforge.net/tracker/?group_id=267760&atid=882290">Bug Reports</a></li> +<li><a href="http://sourceforge.net/tracker/?group_id=267760&atid=882293">Feature Requests</a></li> +<li><a href="http://sourceforge.net/tracker/?group_id=267760&atid=882292">Submit Patches</a></li> +<li><a href="http://sourceforge.net/tracker/?group_id=267760&atid=882291">Support Request</a></li> +<li><a href="http://sourceforge.net/mail/?group_id=267760">Mailing lists</a></li> +<li><a href="http://sourceforge.net/forum/forum.php?forum_id=613897">Discuss about Development issues</a></li> +<li><a href="http://sourceforge.net/forum/forum.php?forum_id=613896">Ask for Help</a></li> +<li><a href="http://sourceforge.net/forum/forum.php?forum_id=613895">Discuss StdAir</a></li> +</ul> + +<b>StdAir Development:</b> +<ul> +<li><a href="http://stdair.svn.sourceforge.net/viewvc/stdair/">SVN Repository</a></li> +<li><a href="codingrules.html">Coding Rules</a></li> +<li><a href="documentation.html">Documentation Rules</a></li> +<li><a href="test.html">Test Rules</a></li> +</ul> + +<b>External Libraries:</b> +<ul> +<li><a href="http://www.gnu.org/software/gsl">GSL</a></li> +</ul> + +</div> +<!-- end of left margin --> +\endhtmlonly + +\section about About StdAir + +StdAir is a C++ library of classes and functions modeling typical +airline IT business objects. For instance, it is used by the Airline +Schedule C++ library project (http://www.sourceforge.net/projects/air-sched). + +StdAir makes an extensive use of existing open-source libraries for +increased functionality, speed and accuracy. In particular <a +href="http://www.boost.org">Boost</a> (<em>C++ STL Extensions</em>) library is +used. + +The StdAir library originates from the department of Operational +Research and Innovation at <a +href="http://www.amadeus.com">Amadeus</a>, Sophia Antipolis, +France. StdAir is released under the terms of the <a +href="http://www.gnu.org/licenses/lgpl.html">GNU Lesser General Public +License</a> (LGPL) for you to enjoy. + +StdAir should work on +<a href="http://en.wikipedia.org/wiki/GNU/Linux">GNU/Linux</a>, +<a href="http://www.sun.com/software/solaris/">Sun Solaris</a>, +Microsoft Windows (with <a href="http://www.cygwin.com/">Cygwin</a>, +<a href="http://www.mingw.org/">MinGW/MSYS</a>, or +<a href="http://msdn.microsoft.com/visualc/">Microsoft Visual C++ .NET</a>) and +<a href="http://www.apple.com/macosx/">Mac OS X</a> operating systems. + +\htmlonly +</div> +<!-- end of main block --> +\endhtmlonly + +*/ Deleted: trunk/stdair/doc/local/index.doc.in =================================================================== --- trunk/stdair/doc/local/index.doc.in 2010-07-24 17:09:19 UTC (rev 230) +++ trunk/stdair/doc/local/index.doc.in 2010-07-25 16:06:47 UTC (rev 231) @@ -1,85 +0,0 @@ -/*! -\mainpage StdAir Documentation - -\htmlonly -<!-- start of main block --> -<div style="width: 100%;"> -<!-- start of left margin --> -<div style="float:right; width:200px; background-color: #eeeeff; border: 1px solid #b0b0b0; margin: 0 0 10px 20px; padding: 10px; font-size: 90%;"> - -<b>Getting Started:</b> -<ul> -<li><a href="features.html">Features</a></li> -<li><a href="installation.html">Installation</a></li> -<li><a href="linking.html">Linking with StdAir</a></li> -<li><a href="users_guide.html">Short Introduction to StdAir</a></li> -<li><a href="tutorial.html">Some Tutorial Examples</a></li> -<li><a href="verification.html">StdAir Verification</a></li> -<li><a href="copyright.html">Copyright and License</a></li> -<li><a href="help_wanted.html">Make a Difference</a></li> -<li><a href="authors.html">Authors</a></li> -</ul> - -<a href="http://sourceforge.net/projects/stdair/"><b>StdAir at SourceForge:</b></a> -<ul> -<li><a href="http://sourceforge.net/project/showfiles.php?group_id=267760">Download StdAir</a></li> -<li><a href="http://stdair.sourceforge.net/RPM-GPG-KEY-freshrpms-free">RPM-GPG-Key</a> for StdAir RPMs (save the file, and type 'rpm --import RPM-GPG-KEY-freshrpms-free' as root)</li> -<li><a href="http://sourceforge.net/tracker/?group_id=267760&atid=882290">Bug Reports</a></li> -<li><a href="http://sourceforge.net/tracker/?group_id=267760&atid=882293">Feature Requests</a></li> -<li><a href="http://sourceforge.net/tracker/?group_id=267760&atid=882292">Submit Patches</a></li> -<li><a href="http://sourceforge.net/tracker/?group_id=267760&atid=882291">Support Request</a></li> -<li><a href="http://sourceforge.net/mail/?group_id=267760">Mailing lists</a></li> -<li><a href="http://sourceforge.net/forum/forum.php?forum_id=613897">Discuss about Development issues</a></li> -<li><a href="http://sourceforge.net/forum/forum.php?forum_id=613896">Ask for Help</a></li> -<li><a href="http://sourceforge.net/forum/forum.php?forum_id=613895">Discuss StdAir</a></li> -</ul> - -<b>StdAir Development:</b> -<ul> -<li><a href="http://stdair.svn.sourceforge.net/viewvc/stdair/">SVN Repository</a></li> -<li><a href="codingrules.html">Coding Rules</a></li> -<li><a href="documentation.html">Documentation Rules</a></li> -<li><a href="test.html">Test Rules</a></li> -</ul> - -<b>External Libraries:</b> -<ul> -<li><a href="http://www.gnu.org/software/gsl">GSL</a></li> -</ul> - -</div> -<!-- end of left margin --> -\endhtmlonly - -\section about About StdAir - -StdAir is a C++ library of classes and functions modeling typical -airline IT business objects. For instance, it is used by the Airline -Schedule C++ library project (http://www.sourceforge.net/projects/air-sched). - -StdAir makes an extensive use of existing open-source libraries for -increased functionality, speed and accuracy. In particular <a -href="http://www.boost.org">Boost</a> (<em>C++ STL Extensions</em>) library is -used. - -The StdAir library originates from the department of Operational -Research and Innovation at <a -href="http://www.amadeus.com">Amadeus</a>, Sophia Antipolis, -France. StdAir is released under the terms of the <a -href="http://www.gnu.org/licenses/lgpl.html">GNU Lesser General Public -License</a> (LGPL) for you to enjoy. - -StdAir should work on -<a href="http://en.wikipedia.org/wiki/GNU/Linux">GNU/Linux</a>, -<a href="http://www.sun.com/software/solaris/">Sun Solaris</a>, -Microsoft Windows (with <a href="http://www.cygwin.com/">Cygwin</a>, -<a href="http://www.mingw.org/">MinGW/MSYS</a>, or -<a href="http://msdn.microsoft.com/visualc/">Microsoft Visual C++ .NET</a>) and -<a href="http://www.apple.com/macosx/">Mac OS X</a> operating systems. - -\htmlonly -</div> -<!-- end of main block --> -\endhtmlonly - -*/ Modified: trunk/stdair/doc/local/sources.mk =================================================================== --- trunk/stdair/doc/local/sources.mk 2010-07-24 17:09:19 UTC (rev 230) +++ trunk/stdair/doc/local/sources.mk 2010-07-25 16:06:47 UTC (rev 231) @@ -1,4 +1,5 @@ doc_local_sources = \ + $(top_srcdir)/doc/local/index.doc \ $(top_srcdir)/doc/local/authors.doc \ $(top_srcdir)/doc/local/codingrules.doc \ $(top_srcdir)/doc/local/copyright.doc \ Property changes on: trunk/stdair/doc/sourceforge ___________________________________________________________________ Modified: svn:ignore - howto_release_stdair.html + Added: trunk/stdair/doc/sourceforge/howto_release_stdair.html =================================================================== --- trunk/stdair/doc/sourceforge/howto_release_stdair.html (rev 0) +++ trunk/stdair/doc/sourceforge/howto_release_stdair.html 2010-07-25 16:06:47 UTC (rev 231) @@ -0,0 +1,180 @@ +<!-- +The following tags are permitted: a, b, blockquote, br, code, dd, div, +dl, dt, em, hr, i, li, ol, p, pre, strong, tt, ul, u. All other tags will be +stripped. All tags aside from the following must be closed: br, hr, li, p. +Failure to close tags may result in HTML output which is not rendered +properly. Any style attributes or on* attributes (such as mouseover) will be +stripped. JavaScript will result in the total stripping of HTML tags from +your input. Please limit your input to properly formed HTML snippets +conforming to the above rules. +--> + +<h2> How to release a new version of StdAir </h2> + + +<p> This document describes briefly the recommended procedure of releasing a + new version of StdAir using a Linux development machine and the SourceForge + project site. </p> + +<p> The following steps are required to make a release of the distribution + package: </p> + +<ul> + +<li> Initialisation: check out locally the full Subversion project:<br> + <code> + cd ~<br> + mkdir -p dev<br> + cd ~/dev<br> + svn co <a href="https://stdair.svn.sourceforge.net/svnroot/stdair">https://stdair.svn.sourceforge.net/svnroot/stdair</a> stdairsvn + </code> +</li> + +<li> Prepare the branch for its creation on the Subversion repository:<br> + <code> + cd ~/dev<br> + cd stdairsvn/branches/stdair<br> + mkdir 0.1.0<br> + svn add 0.1.0<br> + svn ci -m "[Branch 0.1.0] Prepared the branch 0.1.0 to be copied from head + of the trunk." + </code> +</li> + +<li> Check to which Subversion revision the release corresponds to. For instance + the <a href="http://sourceforge.net/apps/trac/stdair/changeset/220/">StdAir + release 0.1.0 corresponds to Subversion revision r218</a>. + The trunk <tt>configure.ac</tt> file specifies a fake release number, namely + 99.99.99, + for current (head) development. When a release is made, two Subversion + revisions are committed with, as the sole change, the release number within + the <tt>configure.ac</tt> file. One revision is committed with the + to-be-released version number (e.g., 0.1.0) and commit message prefixed with + "[Release x.y.z]", and another one with the release number back to + 99.99.99 and message stating "[Release] Back to working version (99.99.99)." + That way, it is then easy to spot the starting point of any release within + the Subversion repository, with something like:<br> + <code>cd ~/dev<br> + cd stdairsvn/trunk/stdair<br> + svn log configure.ac | less</code> +</li> + +<li> Create a release branch by copying the source tree to be released + into the dedicated + <a href="https://sourceforge.net/apps/trac/stdair/browser/branches/stdair">'branches' sub-directory of the Subversion repository</a>, e.g.:<br> + <code> + svn copy -<a href="http://sourceforge.net/apps/trac/stdair/changeset/218">r218</a> \<br> + <a href="https://stdair.svn.sourceforge.net/svnroot/stdair/trunk/stdair">https://stdair.svn.sourceforge.net/svnroot/stdair/trunk/stdair</a> \<br> + <a href="https://stdair.svn.sourceforge.net/svnroot/stdair/branches/stdair/0.1.0/main">https://stdair.svn.sourceforge.net/svnroot/stdair/branches/stdair/0.1.0/main</a> \<br> + -m "[Release] Created the main 0.1.0 release branch, from revision + <a href="http://sourceforge.net/apps/trac/stdair/changeset/218">r218</a>."<br> + </code> + # Check the results:<br> + <code> + firefox -new-tab "<a href="http://sourceforge.net/apps/trac/stdair/browser/branches/stdair/0.1.0/main">http://sourceforge.net/apps/trac/stdair/browser/branches/stdair/0.1.0/main</a>" + </code> +</li> + +<li> Check-out the release StdAir sources from the branch, so that patches +may be made (for instance, on the RPM specification file):<br> + <code> + cd ~/dev<br> + cd stdairsvn/branches/stdair/0.1.0<br> + svn up<br> + cd main + </code> +</li> + +<li> <b>Only if needed</b>, alter a few files on the branch.<br> +<b>Note that the release branch is not the place where to develop for a +release.</b> +The <b>release</b> branch is aimed at keeping track of a release and of all +the patches having made their way into that branch, so that the software +can always be generated according to that release.<br> +Developments for a particular release should be made on the trunk (e.g., by +adding features not activated by default, but activated the release developers +only) or, if really needed, on a dedicated <b>development</b> branch. +</li> + +<li> Create the distribution packages using the following command:<br> + <code> + cd ~/dev<br> + cd stdairsvn/branches/stdair/0.1.0/main<br> + ./autogen.sh && make distcheck<br> + </code> + This will configure, compile and check the package. The output packages will + be named <tt>stdair-0.1.0.tar.gz</tt> and <tt>stdair-0.1.0.tar.bz2</tt>, for + instance. +</li> + +<li> Optionally, generate the RPM package (for instance, for Fedora/RedHat)<br> + <code> + cd ~/dev<br> + cd stdairsvn/branches/stdair/0.1.0/main<br> + ./autogen.sh && make dist<br> + </code> + # To perform this step, autoconf, automake and libtool tools have to be + available in the system.<br> + <code> + cp stdair.spec ~/dev/packages/SPECS \<br> + && cp stdair-0.1.0.tar.bz2 ~/dev/packages/SOURCES<br> + cd ~/dev/packages/SPECS<br> + rpmbuild -ba stdair.spec<br> + rpmlint -i ../SPECS/stdair.spec ../SRPMS/stdair-0.1.0-1.fc13.src.rpm \<br> + ../RPMS/i686/stdair-*<br> + </code> +</li> + +<li> Update the <tt>NEWS</tt> and <tt>ChangeLog</tt> files with appropriate + information, including what has changed since the previous release. Then + commit the changes into the + <a href="https://sourceforge.net/apps/trac/stdair/browser">StdAir's + Subversion (SVN) repository</a>. +</li> + +<li> Create the documentation packages using the following command:<br> + <code>make dist-html</code><br> + The output documentation packages will be + named <tt>stdair-doc-0.1.0.tar.gz</tt> + and <tt>stdair-doc-0.1.0.tar.bz2</tt>, for example. +</li> + +<li> Upload the distribution and documentation packages to the SourceForge + server. Check + <a href="https://sourceforge.net/apps/trac/sourceforge/wiki/Release%20files%20for%20download#SCP">SourceForge help page on uploading software</a>. +</li> + +<li> In order to update the Web site files, either: + <ul> + <li> <a href="https://sourceforge.net/apps/trac/sourceforge/wiki/Shell%20service#Accessingyourfileswithothertools">synchronise + them with rsync and SSH</a>:<br> + <code> + cd ~/dev<br> + cd stdairsvn/branches/stdair/0.1.0/main<br> + rsync -aiv doc/html joe,st...@we...:htdocs/<br> + </code> + where <tt>-aiv</tt> options mean: + <ul> + <li> -a: archive/mirror mode; equals -rlptgoD (no -H,-A,-X)</li> + <li> -v: increase verbosity</li> + <li> -i: output a change-summary for all updates</li> + </ul> + </li> + <li> or use the + <a href="https://sourceforge.net/apps/trac/sourceforge/wiki/Shell%20service">SourceForge Shell service</a>. + </li> + </ul> +</li> + +<li> Do a new post on the + <a href="https://sourceforge.net/apps/wordpress/stdair/wp-admin/">SourceForge hosted WordPress blog</a> and update, if necessary, + <a href="https://sourceforge.net/apps/trac/stdair/report">Trac tickets</a>. +</li> + +<li> Finally, you should send an announcement to + <a href="mailto:std...@li...">std...@li...</a> + (see <a href="https://lists.sourceforge.net/lists/listinfo/stdair-announce">https://lists.sourceforge.net/lists/listinfo/stdair-announce</a> + for the archives)</p> +</li> +</ul> + Deleted: trunk/stdair/doc/sourceforge/howto_release_stdair.html.in =================================================================== --- trunk/stdair/doc/sourceforge/howto_release_stdair.html.in 2010-07-24 17:09:19 UTC (rev 230) +++ trunk/stdair/doc/sourceforge/howto_release_stdair.html.in 2010-07-25 16:06:47 UTC (rev 231) @@ -1,120 +0,0 @@ -<!-- -The following tags are permitted: a, b, blockquote, br, code, dd, div, -dl, dt, em, hr, i, li, ol, p, pre, strong, tt, ul, u. All other tags will be -stripped. All tags aside from the following must be closed: br, hr, li, p. -Failure to close tags may result in HTML output which is not rendered -properly. Any style attributes or on* attributes (such as mouseover) will be -stripped. JavaScript will result in the total stripping of HTML tags from -your input. Please limit your input to properly formed HTML snippets -conforming to the above rules. ---> - -<h2> How to release a new version of StdAir </h2> - - -<p> This document describes briefly the recommended procedure of releasing a -new version of StdAir using SourceForge project site. </p> - - -<p> The following steps are required to prepare and release of the -distribution package: </p> - -<ul> - -<li> Update <tt>NEWS</tt> and <tt>ChangeLog</tt> files with appropriate - information including what has changed since the previous release. Then - commit the changes into the SVN repository. </li> - -<li> Create a release tag by copying the source tree to be released to the - tags subdirectory in the SVN repository, e.g.:<br> -<code>% svn copy https://@PACKAGE@.svn.sourceforge.net/svnroot/@PACKAGE@/trunk https://@PACKAGE@.svn.sourceforge.net/svnroot/@PACKAGE@/tags/release-0-11-0</code> -</li> - -<li> Export a clean, unversioned copy of the StdAir sources using the release - tag:<br> -<code>% svn export https://@PACKAGE@.svn.sourceforge.net/svnroot/@PACKAGE@/tags/release-0-1-0 @PACKAGE@-@VERSION@</code> -</li> - -<li> Regenerate the <tt>configure</tt> script and other autogenerated files - using:<br> -<code>% ./autogen.sh</code><br> -To perform this step, autoconf, automake and libtool tools have to be -available in the system. </li> - -<li> Configure the exported sources:<br> -<code>% ./configure</code> </li> - -<li> Create the distribution packages using the following command:<br> -<code>% make distcheck</code><br> -This will configure, compile and check the package. The output packages will -be named <tt>@PACKAGE@-@VERSION@.tar.gz</tt> and <tt>@PACKAGE@-@VERSION@.tar.bz2</tt>, for -instance. </li> - -<li> Create the documentation packages using the following command:<br> -<code>% make dist-html</code><br> -The output documentation packages will be -named <tt>@PACKAGE@-html-doc-@VERSION@.tar.gz</tt> -and <tt>@PACKAGE@-html-doc-@VERSION@.tar.bz2</tt>, for example. </li> - -<li> Upload the distribution and documentation packages to the SourceForge - server: </li> - -<ul> - -<li> Start ftp connection with the SourceForge upload server:<br> -<code>% ftp upload.sourceforge.net</code> </li> - -<li> Login as <tt>anonymous</tt> and give email as password </li> - -<li> Change remote directory to <tt>/incoming</tt>:<br> -<code>% cd /incoming</code></li> - -<li> Upload packages:<br> -<code>% mput @PACKAGE@*-@VERSION@.tar.*</code> </li> - -</ul> - -<li> Access SourceForge file release interface and add the packages. - Remember to fill in the Release Notes and ChangeLog parts with appropriate - infmormation. </li> - -</ul> - - -<p> In order to update the online HTML documentation, the following -procedure is required: </p> - -<ul> - -<li> Upload the documentation package into the SourceForge shell server:<br> -<code>% scp @PACKAGE@-html-doc-@VERSION@.tar.gz you...@sh...:/home/groups/o/op/@PACKAGE@/htdocs/</code> -</li> - -<li> Login into the SourceForge shell account:<br> -<code>% ssh you...@sh...</code> </li> - -<li> Change the current directory:<br> -<code>% cd /home/groups/o/op/@PACKAGE@/htdocs</code> </li> - -<li> Unpack the uploaded documentation:<br> -<code>% tar zxf @PACKAGE@-html-doc-@VERSION@.tar.gz</code> </li> - -<li> Rename the unpacked directory to <tt>@VERSION@</tt>:<br> -<code>% mv @PACKAGE@-html-doc-@VERSION@ @VERSION@</code> </li> - -<li> Update the <tt>latest</tt> link:<br> -<code>% rm latest; ln -s @VERSION@ latest</code> </li> - -<li> Change the group properties of the uploaded files:<br> -<code>% chmod -R g+w @VERSION@</code> </li> - -<li> Remove the package from the shell server:<br> -<code>% rm @PACKAGE@-html-doc-@VERSION@.tar.gz</code> </li> - -</ul> - -<p> Finally, you should send an announcement to: -<a href="mailto:@PACKAGE@-an...@li..."> -@PACKAGE@-an...@li... </a> </p> - -</ul> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |