Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r62369 - in trunk/libs/filesystem: . doc v3/libs/filesystem/doc
From: bdawes_at_[hidden]
Date: 2010-06-01 10:38:38


Author: bemandawes
Date: 2010-06-01 10:38:37 EDT (Tue, 01 Jun 2010)
New Revision: 62369
URL: http://svn.boost.org/trac/boost/changeset/62369

Log:
Add docs and scripts for dual version support.
Added:
   trunk/libs/filesystem/change_to_v2.bat (contents, props changed)
   trunk/libs/filesystem/change_to_v3.bat (contents, props changed)
   trunk/libs/filesystem/dual_versions.html (contents, props changed)
   trunk/libs/filesystem/version.bat (contents, props changed)
Text files modified:
   trunk/libs/filesystem/doc/index.htm | 20 ++++++++++++++++++--
   trunk/libs/filesystem/v3/libs/filesystem/doc/index.htm | 26 ++++++++++++++++++++++++--
   2 files changed, 42 insertions(+), 4 deletions(-)

Added: trunk/libs/filesystem/change_to_v2.bat
==============================================================================
--- (empty file)
+++ trunk/libs/filesystem/change_to_v2.bat 2010-06-01 10:38:37 EDT (Tue, 01 Jun 2010)
@@ -0,0 +1,37 @@
+@echo off
+rem Change to version 2
+
+rem Copyright Beman Dawes 2010
+
+rem Distributed under the Boost Software License, Version 1.0.
+rem See http://www.boost.org/LICENSE_1_0.txt
+
+echo Change to version 2
+
+if exist src\unique_path.cpp goto versionok
+echo Error: version 2 already in use
+goto done
+:versionok
+
+echo Deleting v3 files...
+
+del ..\..\boost\filesystem.hpp index.html
+del /q ..\..\boost\filesystem
+del /q /s build doc example src test
+
+echo Copying v2 files...
+
+xcopy v2\boost\filesystem.hpp ..\..\boost
+xcopy /i v2\boost\filesystem ..\..\boost\filesystem
+xcopy v2\libs\index.html .
+xcopy /i /s v2\libs\build build
+xcopy /i /s v2\libs\doc doc
+xcopy /i /s v2\libs\example example
+xcopy /i /s v2\libs\src src
+xcopy /i /s v2\libs\test test
+
+echo Copying complete. Version 2 files now ready to use.
+
+echo You must now rebuild Boost.Filesystem object libraries.
+
+:done

Added: trunk/libs/filesystem/change_to_v3.bat
==============================================================================
--- (empty file)
+++ trunk/libs/filesystem/change_to_v3.bat 2010-06-01 10:38:37 EDT (Tue, 01 Jun 2010)
@@ -0,0 +1,55 @@
+@echo off
+rem Change to version 3
+
+rem Copyright Beman Dawes 2010
+
+rem Distributed under the Boost Software License, Version 1.0.
+rem See http://www.boost.org/LICENSE_1_0.txt
+
+echo Change to version 3
+
+if not exist src\unique_path.cpp goto versionok
+echo Error: version 3 already in use
+goto done
+:versionok
+
+if exist v2 goto v2copydone
+
+echo Making a copy of version 2 files...
+
+md v2
+pushd v2
+md boost
+md libs
+popd
+xcopy ..\..\boost\filesystem.hpp v2\boost
+xcopy /i ..\..\boost\filesystem v2\boost\filesystem
+xcopy index.html v2\libs
+xcopy /i /s build v2\libs\build
+xcopy /i /s doc v2\libs\doc
+xcopy /i /s example v2\libs\example
+xcopy /i /s src v2\libs\src
+xcopy /i /s test v2\libs\test
+:v2copydone
+
+echo Deleting v2 files...
+
+del ..\..\boost\filesystem.hpp index.html
+del /q ..\..\boost\filesystem
+del /q /s build doc example src test
+
+echo Copying v3 files...
+
+xcopy v3\boost\filesystem.hpp ..\..\boost
+xcopy /i v3\boost\filesystem ..\..\boost\filesystem
+xcopy v3\libs\index.html .
+xcopy /i /s v3\libs\filesystem\build build
+xcopy /i /s v3\libs\filesystem\doc doc
+xcopy /i /s v3\libs\filesystem\example example
+xcopy /i /s v3\libs\filesystem\src src
+xcopy /i /s v3\libs\filesystem\test test
+
+echo Copying complete. Version 3 files now ready to use.
+
+echo You must now rebuild Boost.Filesystem object libraries.
+:done
\ No newline at end of file

Modified: trunk/libs/filesystem/doc/index.htm
==============================================================================
--- trunk/libs/filesystem/doc/index.htm (original)
+++ trunk/libs/filesystem/doc/index.htm 2010-06-01 10:38:37 EDT (Tue, 01 Jun 2010)
@@ -17,7 +17,8 @@
 <a href="../../../index.htm">
 <img src="../../../boost.png" alt="boost.png (6897 bytes)" align="middle" width="277" height="86" border="0"></a></td>
     <td width="410" align="middle">
- <font size="7">Filesystem Library</font>
+ <font size="7">Filesystem Library<br>
+ Version 2</font>
     </td>
   </tr>
 </table>
@@ -66,6 +67,21 @@
   </tr>
 </table>
 
+<div align="center">
+ <center>
+ <table border="1" cellpadding="10" cellspacing="1" style="border-collapse: collapse" bordercolor="#111111">
+ <tr>
+ <td>
+ <p align="center">This is Version 2 of the Filesystem library.</p>
+ <p align="center">Version 3, a major revision with many new and improved
+ features is also available, but may break some existing code.</p>
+ <p align="center">See Dual Version Support
+ for how to change to Version 3.</td>
+ </tr>
+ </table>
+ </center>
+</div>
+
 <h2><a name="Introduction">Introduction</a></h2>
 <p>The Boost.Filesystem library provides portable facilities to query and
 manipulate paths, files, and directories.</p>
@@ -778,7 +794,7 @@
 
 <hr>
 <p>Revised
-<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->31 May, 2010<!--webbot bot="Timestamp" endspan i-checksum="13955" --></p>
+<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->01 June, 2010<!--webbot bot="Timestamp" endspan i-checksum="19838" --></p>
 
 <p>&copy; Copyright Beman Dawes, 2002-2005</p>
 <p> Use, modification, and distribution are subject to the Boost Software

Added: trunk/libs/filesystem/dual_versions.html
==============================================================================
--- (empty file)
+++ trunk/libs/filesystem/dual_versions.html 2010-06-01 10:38:37 EDT (Tue, 01 Jun 2010)
@@ -0,0 +1,76 @@
+<html>
+
+<head>
+<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
+<meta name="ProgId" content="FrontPage.Editor.Document">
+<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
+<title>Dual Version Support</title>
+<link rel="stylesheet" type="text/css" href="../../doc/html/minimal.css">
+</head>
+
+<body>
+
+<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111">
+ <tr>
+ <td width="277">
+<a href="../../index.htm">
+<img src="../../boost.png" alt="boost.png (6897 bytes)" align="middle" width="300" height="86" border="0"></a></td>
+ <td align="middle">
+ <font size="7">Filesystem<br>
+ Dual Version Support</font>
+ </td>
+ </tr>
+</table>
+
+
+<h2>Version 2 and 3 Dual Support</h2>
+<p>Boost.Filesystem Version 3 is
+major revision with many new and improved features, but has breaking changes
+from Version 2. Most of the breaking changes are in the area of
+internationalization.</p>
+<p>During a transition period covering several Boost releases, both version 2 and version 3 will be supported:</p>
+
+<ul>
+ <li>Both versions 2 and 3 will be included in the Boost distribution.</li>
+ <li>For the Boost 1.44, and longer if necessary, version 2 will be the
+ default.</li>
+ <li>Going forward, version 3 will then become the default.</li>
+ <li>Scripts are provided to determine the version currently in use, and change
+ between versions.</li>
+</ul>
+
+<h2>Scripts</h2>
+
+<p>The scripts for both Windows and Unix-like systems are provided in <code><i>
+boost-root</i>/libs/filesystem</code>. They must be run from that directory.</p>
+
+<h3>Windows</h3>
+
+<ul>
+ <li><code>version.bat</code> - Displays the version
+ number currently in use.</li>
+ <li><code>change_to_v2.bat</code> - Changes
+ version currently in use to version 2.</li>
+ <li><code>change_to_v3.bat</code> - Changes
+ version currently in use to version 3.</li>
+</ul>
+
+<h3>Unix-like operating systems</h3>
+
+<p><i>To be supplied</i></p>
+
+<hr>
+<p>Revised
+<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->01 June, 2010<!--webbot bot="Timestamp" endspan i-checksum="19838" --></p>
+
+<p>© Copyright Beman Dawes, 2010</p>
+<p> Use, modification, and distribution are subject to the Boost Software
+License, Version 1.0. See <a href="http://www.boost.org/LICENSE_1_0.txt">
+www.boost.org/LICENSE_1_0.txt</a></p>
+
+<p>&nbsp;</p>
+
+
+</body>
+
+</html>
\ No newline at end of file

Modified: trunk/libs/filesystem/v3/libs/filesystem/doc/index.htm
==============================================================================
--- trunk/libs/filesystem/v3/libs/filesystem/doc/index.htm (original)
+++ trunk/libs/filesystem/v3/libs/filesystem/doc/index.htm 2010-06-01 10:38:37 EDT (Tue, 01 Jun 2010)
@@ -17,7 +17,8 @@
 <a href="../../../index.htm">
 <img src="../../../boost.png" alt="boost.png (6897 bytes)" align="middle" width="300" height="86" border="0"></a></td>
     <td align="middle">
- <font size="7">Filesystem Library</font>
+ <font size="7">Filesystem Library<br>
+ Version 3</font>
     </td>
   </tr>
 </table>
@@ -47,6 +48,7 @@
     <a href="#Introduction">Introduction</a><br>
     <a href="#Documentation">Documentation</a><br>
     <a href="#Using">Using the library</a><br>
+ Coding guidelines<br>
     <a href="#Cautions">Cautions</a><br>
     <a href="#Headers">Headers</a><br>
     <a href="#Examples">Example programs</a><br>
@@ -59,6 +61,21 @@
   </tr>
   </table>
 
+<div align="center">
+ <center>
+ <table border="1" cellpadding="10" cellspacing="1" style="border-collapse: collapse" bordercolor="#111111">
+ <tr>
+ <td>
+ <p align="center">This is Version 3 of the Filesystem library.</p>
+ <p align="center">Version 3 is major revision with many new and improved
+ features, but has breaking changes from Version 2.</p>
+ <p align="center">See Dual Version Support
+ for how to change to Version 2.</td>
+ </tr>
+ </table>
+ </center>
+</div>
+
 <h2><a name="Introduction">Introduction</a></h2>
 <p>The Boost.Filesystem library provides facilities to manipulate files and directories,
 and the paths that identify them.</p>
@@ -156,6 +173,11 @@
 <p>Boost.Filesystem is implemented as a separately compiled library, so you must install
 binaries in a location that can be found by your linker. If you followed the
 <a href="http://www.boost.org/doc/libs/release/more/getting_started/index.html">Boost Getting Started</a> instructions, that's already been done for you.</p>
+<h2><a name="Coding-guidelines">Coding guidelines</a></h2>
+<p>For new code, defining <code>BOOST_FILESYSTEM_NO_DEPRECATED</code> before
+including filesystem headers is strongly recommended. This prevents inadvertent
+use of old features, particularly legacy function names, that have been replaced
+and are going to go away in the future.</p>
 <h2><a name="Cautions">Cautions</a></h2>
 <p>After reading the tutorial you can dive right into simple,
 script-like programs using the Filesystem Library! Before doing any serious
@@ -428,7 +450,7 @@
 
 <hr>
 <p>Revised
-<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->31 May, 2010<!--webbot bot="Timestamp" endspan i-checksum="13955" --></p>
+<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->01 June, 2010<!--webbot bot="Timestamp" endspan i-checksum="19838" --></p>
 
 <p>&copy; Copyright Beman Dawes, 2002-2005</p>
 <p> Use, modification, and distribution are subject to the Boost Software

Added: trunk/libs/filesystem/version.bat
==============================================================================
--- (empty file)
+++ trunk/libs/filesystem/version.bat 2010-06-01 10:38:37 EDT (Tue, 01 Jun 2010)
@@ -0,0 +1,13 @@
+@echo off
+rem Display version number
+
+rem Copyright Beman Dawes 2010
+
+rem Distributed under the Boost Software License, Version 1.0.
+rem See http://www.boost.org/LICENSE_1_0.txt
+
+if exist src\unique_path.cpp (
+ echo Version 3
+) else (
+ echo Version 2
+)


Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk