diff options
| author | Lorry Tar Creator <lorry-tar-importer@baserock.org> | 2015-04-08 03:09:47 +0000 |
|---|---|---|
| committer | <> | 2015-05-05 14:37:32 +0000 |
| commit | f2541bb90af059680aa7036f315f052175999355 (patch) | |
| tree | a5b214744b256f07e1dc2bd7273035a7808c659f /libs/filesystem/doc | |
| parent | ed232fdd34968697a68783b3195b1da4226915b5 (diff) | |
| download | boost-tarball-master.tar.gz | |
Imported from /home/lorry/working-area/delta_boost-tarball/boost_1_58_0.tar.bz2.HEADboost_1_58_0master
Diffstat (limited to 'libs/filesystem/doc')
| -rw-r--r-- | libs/filesystem/doc/deprecated.html | 16 | ||||
| -rw-r--r-- | libs/filesystem/doc/design.htm | 8 | ||||
| -rw-r--r-- | libs/filesystem/doc/do_list.html | 4 | ||||
| -rw-r--r-- | libs/filesystem/doc/faq.htm | 23 | ||||
| -rw-r--r-- | libs/filesystem/doc/index.htm | 38 | ||||
| -rw-r--r-- | libs/filesystem/doc/issue_reporting.html | 224 | ||||
| -rw-r--r-- | libs/filesystem/doc/portability_guide.htm | 19 | ||||
| -rw-r--r-- | libs/filesystem/doc/reference.html | 19 | ||||
| -rw-r--r-- | libs/filesystem/doc/release_history.html | 36 | ||||
| -rw-r--r-- | libs/filesystem/doc/styles.css | 19 | ||||
| -rw-r--r-- | libs/filesystem/doc/tickets.html | 2 | ||||
| -rw-r--r-- | libs/filesystem/doc/tutorial.html | 20 | ||||
| -rw-r--r-- | libs/filesystem/doc/v3.html | 19 | ||||
| -rw-r--r-- | libs/filesystem/doc/v3_design.html | 37 |
14 files changed, 385 insertions, 99 deletions
diff --git a/libs/filesystem/doc/deprecated.html b/libs/filesystem/doc/deprecated.html index ed553447e..9ba05e2a7 100644 --- a/libs/filesystem/doc/deprecated.html +++ b/libs/filesystem/doc/deprecated.html @@ -4,9 +4,9 @@ <meta http-equiv="Content-Language" content="en-us"> <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"> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Filesystem Deprecated Features</title> -<link rel="stylesheet" type="text/css" href="../../../doc/src/minimal.css"> +<link href="styles.css" rel="stylesheet"> </head> <body> @@ -22,17 +22,19 @@ </tr> </table> -<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" bgcolor="#D7EEFF" width="100%"> +<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" + bordercolor="#111111" bgcolor="#D7EEFF" width="100%"> <tr> - <td><a href="index.htm">Filesystem Home</a> - <a href="release_history.html">Releases</a> - <a href="reference.html">Reference</a> + <td><a href="index.htm">Home</a> <a href="tutorial.html">Tutorial</a> + <a href="reference.html">Reference</a> <a href="faq.htm">FAQ</a> + <a href="release_history.html">Releases</a> <a href="portability_guide.htm">Portability</a> <a href="v3.html">V3 Intro</a> <a href="v3_design.html">V3 Design</a> <a href="deprecated.html">Deprecated</a> + <a href="issue_reporting.html">Bug Reports </a> </td> </table> @@ -373,7 +375,7 @@ function can trivially be provided by a user.</p> <hr> <p>Revised -<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->20 March, 2012<!--webbot bot="Timestamp" endspan i-checksum="28814" --></p> +<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->29 December, 2014<!--webbot bot="Timestamp" endspan i-checksum="38652" --></p> <p>© Copyright Beman Dawes, 2002-2005, 2010</p> <p> Use, modification, and distribution are subject to the Boost Software diff --git a/libs/filesystem/doc/design.htm b/libs/filesystem/doc/design.htm index a44b2b23e..07977cac8 100644 --- a/libs/filesystem/doc/design.htm +++ b/libs/filesystem/doc/design.htm @@ -4,9 +4,9 @@ <meta http-equiv="Content-Language" content="en-us"> <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"> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Boost Filesystem Library Design</title> -<link rel="stylesheet" type="text/css" href="../../../doc/src/minimal.css"> +<link href="styles.css" rel="stylesheet"> </head> <body bgcolor="#FFFFFF"> @@ -340,9 +340,9 @@ Variable Considered Harmful</i>, ACM SIGPLAN Notices, 8, 2, 1973, pp. 23-34</td> <hr> <p>Revised -<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->20 March, 2012<!--webbot bot="Timestamp" endspan i-checksum="28814" --></p> +<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->26 December, 2014<!--webbot bot="Timestamp" endspan i-checksum="38646" --></p> -<p>© Copyright Beman Dawes, 2002</p> +<p>© Copyright Beman Dawes, 2002</p> <p> Use, modification, and distribution are subject to the Boost Software License, Version 1.0. (See accompanying file <a href="../../../LICENSE_1_0.txt"> LICENSE_1_0.txt</a> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt"> diff --git a/libs/filesystem/doc/do_list.html b/libs/filesystem/doc/do_list.html index 655880327..b6fc3eb8f 100644 --- a/libs/filesystem/doc/do_list.html +++ b/libs/filesystem/doc/do_list.html @@ -4,7 +4,7 @@ <meta http-equiv="Content-Language" content="en-us"> <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"> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Do List</title> <style type="text/css"> body { font-family: sans-serif; margin: 1em; } @@ -137,7 +137,7 @@ to return paths with fewer elements.]</pre> </ul> <hr> -<p>© Copyright Beman Dawes, 2010</p> +<p>© Copyright Beman Dawes, 2010</p> <p>Distributed under 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> diff --git a/libs/filesystem/doc/faq.htm b/libs/filesystem/doc/faq.htm index 85b64dc0e..ec177c23c 100644 --- a/libs/filesystem/doc/faq.htm +++ b/libs/filesystem/doc/faq.htm @@ -4,9 +4,9 @@ <meta http-equiv="Content-Language" content="en-us"> <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"> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Filesystem FAQ</title> -<link rel="stylesheet" type="text/css" href="../../../doc/src/minimal.css"> +<link href="styles.css" rel="stylesheet"> </head> <body> @@ -22,22 +22,23 @@ </tr> </table> -<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" bgcolor="#D7EEFF" width="100%"> +<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" + bordercolor="#111111" bgcolor="#D7EEFF" width="100%"> <tr> - <td><a href="index.htm">Filesystem Home</a> - <a href="release_history.html">Releases</a> - <a href="reference.html">Reference</a> + <td><a href="index.htm">Home</a> <a href="tutorial.html">Tutorial</a> + <a href="reference.html">Reference</a> <a href="faq.htm">FAQ</a> + <a href="release_history.html">Releases</a> <a href="portability_guide.htm">Portability</a> <a href="v3.html">V3 Intro</a> <a href="v3_design.html">V3 Design</a> <a href="deprecated.html">Deprecated</a> + <a href="issue_reporting.html">Bug Reports </a> </td> - </tr> </table> -<h1 dir="ltr"> +<h1> Frequently Asked Questions</h1> <h2>General questions</h2> <p><b>Why not support a concept of specific kinds of file systems, such as posix_file_system or windows_file_system.</b></p> @@ -45,7 +46,7 @@ Frequently Asked Questions</h1> library. Features specific to a particular operating system or file system can always be accessed by using the operating system's API.</p> -<h2 dir="ltr"> +<h2> Class <code><font size="6">path</font></code> questions </h2> <p><b>Why base the generic pathname format on POSIX?</b></p> <p><a href="design.htm#POSIX-01">POSIX</a> is an ISO Standard. It is the basis for the most familiar @@ -140,8 +141,8 @@ functions, while operations performed by the operating system are provided as free functions.</p> <hr> <p>Revised -<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->20 March, 2012<!--webbot bot="Timestamp" endspan i-checksum="28814" --></p> -<p>© Copyright Beman Dawes, 2002</p> +<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->29 December, 2014<!--webbot bot="Timestamp" endspan i-checksum="38652" --></p> +<p>© Copyright Beman Dawes, 2002</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>
\ No newline at end of file diff --git a/libs/filesystem/doc/index.htm b/libs/filesystem/doc/index.htm index acfad5884..526f26543 100644 --- a/libs/filesystem/doc/index.htm +++ b/libs/filesystem/doc/index.htm @@ -4,18 +4,20 @@ <meta http-equiv="Content-Language" content="en-us"> <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"> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Filesystem Home</title> -<link rel="stylesheet" type="text/css" href="../../../doc/src/minimal.css"> +<link href="styles.css" rel="stylesheet"> </head> <body> -<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111"> +<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> +<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<br> Version 3</font> @@ -23,22 +25,24 @@ </tr> </table> -<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" bgcolor="#D7EEFF" width="100%"> +<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" + bordercolor="#111111" bgcolor="#D7EEFF" width="100%"> <tr> - <td><a href="index.htm">Filesystem Home</a> - <a href="release_history.html">Releases</a> - <a href="reference.html">Reference</a> + <td><a href="index.htm">Home</a> <a href="tutorial.html">Tutorial</a> + <a href="reference.html">Reference</a> <a href="faq.htm">FAQ</a> + <a href="release_history.html">Releases</a> <a href="portability_guide.htm">Portability</a> <a href="v3.html">V3 Intro</a> <a href="v3_design.html">V3 Design</a> <a href="deprecated.html">Deprecated</a> + <a href="issue_reporting.html">Bug Reports</a> </td> - </tr> </table> -<table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" align="right"> +<table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse" + bordercolor="#111111" align="right"> <tr> <td width="100%" bgcolor="#D7EEFF" align="center"> <i><b>Contents</b></i></td> @@ -60,7 +64,7 @@ with acknowledgements</a></td> </tr> </table> - +<p></p> <div align="center"> <center> <table border="1" cellpadding="10" cellspacing="1" style="border-collapse: collapse" bordercolor="#111111"> @@ -316,9 +320,17 @@ syntax.</p> <h2><a name="Change-history">Version history</a></h2> +<h3>Version 4</h3> + +<p><b>Under development </b>- Add support for the +<a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4099.html">ISO +C++ File System Technical Specification</a>. The Filesystem TS is based on +Boost.Filesystem Version 3, with only a small number of changes. Most user code +written for Version 3 should work unchanged with Version 4.</p> + <h3>Version 3</h3> -<p>Boost <span style="background-color: #FFFF00">1.??.0 - ???, 2010</span> - Internationalization via single class <code>path</code>. +<p>Boost 1.44.0 - June, 2010 - Internationalization via single class <code>path</code>. More uniform error handling.</p> <p>Peter Dimov suggested use of a single path class rather than a <code>basic_path</code> @@ -451,7 +463,7 @@ version 1.31.0. </p> <hr> <p>Revised -<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->20 March, 2012<!--webbot bot="Timestamp" endspan i-checksum="28814" --></p> +<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->10 January, 2015<!--webbot bot="Timestamp" endspan i-checksum="38885" --></p> <p>© Copyright Beman Dawes, 2002-2005</p> <p> Use, modification, and distribution are subject to the Boost Software diff --git a/libs/filesystem/doc/issue_reporting.html b/libs/filesystem/doc/issue_reporting.html new file mode 100644 index 000000000..44b80b2b6 --- /dev/null +++ b/libs/filesystem/doc/issue_reporting.html @@ -0,0 +1,224 @@ +<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=utf-8"> +<title>Filesystem issue reporting</title> +<link href="styles.css" rel="stylesheet"> +</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 Bug Reporting</font> + </td> + </tr> +</table> + +<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" + bordercolor="#111111" bgcolor="#D7EEFF" width="100%"> + <tr> + <td><a href="index.htm">Home</a> + <a href="tutorial.html">Tutorial</a> + <a href="reference.html">Reference</a> + <a href="faq.htm">FAQ</a> + <a href="release_history.html">Releases</a> + <a href="portability_guide.htm">Portability</a> + <a href="v3.html">V3 Intro</a> + <a href="v3_design.html">V3 Design</a> + <a href="deprecated.html">Deprecated</a> + <a href="issue_reporting.html">Bug Reports </a> + </td> +</table> + +<p>Boost.Filesystem issues such as bug reports or feature requests should be +reported via a <a href="https://svn.boost.org/trac/boost/newticket">Boost Trac ticket</a>.</p> +<p><a href="https://github.com/boostorg/filesystem/pulls">GitHub pull requests</a> +are encouraged, too, although anything beyond really trivial fixes needs a trac +ticket.</p> +<h3>Bug reports</h3> +<p>A timely response to your bug report is much more likely if <b>the problem can +be immediately reproduced without guesswork and regression tests can be easily +created</b>. </p> +<p>You need to provide the following:</p> +<ol> + <li>A simple test program +that:<ul> + <li>Illustrates the problem, and</li> + <li>Automatically yields an unambiguous pass or fail result - returning zero + for pass and non-zero for fail is preferred, and </li> + <li>Can be used as the basis for adding tests to Boost.Filesystem's + regression test suite.</li> + </ul> + </li> + <li>The compiler, standard library, platform, and Boost version you + used to build and run your test program.</li> + <li>A description of how to build and run the test program. + </li> + <li>A copy of the output from the test + program, if any.</li> + <li>An email address for follow-up questions.</li> +</ol> +<p>See <a href="#Rationale">Rationale</a> to find out why the above is needed.</p> +<p>For a mostly automatic framework to provide the above, read on!</p> +<h3>Bug reporting framework</h3> +<p>The directory <code><boost-root>/libs/filesystem/bug></code> provides a bug test program (<code><a href="#bug-cpp">bug.cpp</a></code>) +and a build file (<code>Jamfile.v2</code>). Here is what you need to do:</p> +<ol> + <li>Add one or more test cases to <code><a href="#bug-cpp">bug.cpp</a></code> + using any text or program editor.</li> + <li><a href="#Build-and-test">Build and test</a>.</li> + <li>Attach copies of the <a href="#Test-output">Test output</a> and test + program to the <a href="https://svn.boost.org/trac/boost/newticket">Trac + ticket</a>.</li> +</ol> +<p>That's it! When you complete those steps, you will be done!</p> +<p>The test output supplies all of the basic information about the compiler, std +library, platform, Boost version, and command line, and the test cases you have +added should make it easy for the library maintainer to reproduce the problem. </p> +<h3>Using the framework</h3> +<h4><a name="bug-cpp"><code>bug.cpp</code></a></h4> +<p>Here is <code>bug.cpp</code> as supplied. To report a real bug, use +<code>BOOST_TEST</code> and <code>BOOST_TEST_EQ</code> macros to build your own +test cases. You can delete the three tests already in <code>bug.cpp</code>:</p> +<blockquote> + <pre>#include <boost/detail/lightweight_test_report.hpp> +#include <boost/filesystem.hpp> + +namespace fs = boost::filesystem; + +int test_main(int, char*[]) // note name +{ + BOOST_TEST(2 + 2 == 5); // one convertible-to-bool argument; this one fails! + BOOST_TEST_EQ(4 + 4, 9); // two EqualityComparible arguments; this one fails! + BOOST_TEST(fs::exists(".")); // should pass, so nothing should be reported + + return ::boost::report_errors(); // required +} +</pre> +</blockquote> +<h4><a name="Build-and-test">Build and test</a></h4> + + +<p>POSIX-like systems:</p> + + +<blockquote> + <pre>cd <boost-root>/libs/filesystem/bug +../../../b2 -a +bin/bug</pre> +</blockquote> +<p>Windows:</p> +<blockquote> + <pre>cd <boost-root>\libs\filesystem\bug +..\..\..\b2 -a +bin\bug</pre> +</blockquote> +<h4><a name="Test-output">Test output</a></h4> + + +<p>Running the test on Windows produced this test output:</p> + + +<blockquote> + + +<pre>Microsoft Visual C++ version 14.0 +Dinkumware standard library version 610 +Win32 +Boost version 1.58.0 +Command line: bin\bug +bug.cpp(10): test '2 + 2 == 5' failed in function + 'int __cdecl test_main(int,char *[])' +bug.cpp(11): test '4 + 4 == 9' failed in function + 'int __cdecl test_main(int,char *[])': '8' != '9' +2 errors detected.</pre> +</blockquote> +<p>The test framework runs <code>test_main()</code> from a <code>try</code> +block with a <code>catch</code> block that reports exceptions via <code> +std::exception what()</code>. So the output will differ if an exception is +thrown.</p> +<h2>Background information</h2> +<p>You should now have enough information to file an easy-to-reproduce bug +report. So you can skip reading the rest of this page unless you need to do +something a bit out of the ordinary.</p> +<h3><a name="b2-command-line-options"><code>b2</code> command line</a></h3> +<p><code>b2</code> (formerly <code>bjam</code>) usage: <code>b2 +[options] [properties] [target]</code></p> +<p>Boost.Build b2 has many options, properties, and targets, but you will not +need most of them for bug reporting. Here are a few you might find helpful:</p> +<p><b>Options</b></p> +<blockquote> + <p><code>-a</code> Rebuild everything rather than + just out-of-date targets. Used in the example build above to ensure libraries + are built with the same setup as the test program.</p> +</blockquote> +<p><b>Properties</b></p> +<blockquote> + <p><code>address-model=<i>n n</i></code> is 32 or 64. + Explicitly request either 32-bit or 64-bit code generation. This typically + requires that your compiler is appropriately configured.</p> + <p><code>variant=</code><i>string string </i>is + <code>debug</code> or <code>release</code>.</p> + <p><code>toolset=</code><i>string</i> The C++ + compiler to use. For example, <code>gcc-4.9</code>, <code>clang-3.3</code>, + <code>or msvc-14.0</code>.</p> + <p><code>include=</code><i>string </i> + Additional include paths for C and C++ compilers.</p> + <p><code>cxxflags=</code><i>string </i> + Custom options to pass to the C++ compiler.</p> + <p><code>define=</code><i>string</i> + Additional macro definitions for C and C++ compilers. <i>string</i> should be + either <code class="computeroutput">SYMBOL</code> or + <code class="computeroutput">SYMBOL=VALUE</code></p> +</blockquote> +<h3><a name="Rationale">Rationale</a></h3> +<p>Here is the request list again, with rationale added:</p> +<ol> + <li>A simple test program +that:<ul> + <li dir="ltr"> + <p dir="ltr">Illustrates the problem <b>[Code communicates more clearly than + prose. If it looks like it will it will take some time to figure out exactly what the + problem is, or worse yet, might result in a wild-goose chase, the bug report + gets set aside to be worked on later and then is often forgotten.] </b>and</li> + <li>Automatically yields an unambiguous pass or fail result - returning zero + for pass and non-zero for fail is preferred <b>[Prevents + miscommunications and allows use in automatic regression tests.]</b>, and </li> + <li>Can be used as the basis for adding tests to Boost.Filesystem's + regression test suite <b>[With good test cases fixes come easier and + regressions become less likely]</b>.</li> + </ul> + </li> + <li>The compiler, standard library, platform, and Boost version you + used to build and run your test program. <b>[The implementation includes much + platform dependent code, and also depends on the other factors mentioned. Know + these things upfront brings the bug report into focus without having to ask + for more information. ]</b></li> + <li>A description of how to build and run the test program. <b>[If b2 + (formerly known as bjam) is used as the build engine, this is not a concern, + but otherwise much more information is needed.]</b></li> + <li>A copy of the output from the test + program, if any. <b>[Avoids misinterpreting results.]</b></li> + <li>An email address for follow-up questions.<b> [Trac comments are the + primary means of response, but it is disheartening when a trac question is not + answered and there is no email address attached for followup.]</b></li> +</ol> +<hr> +<p>Revised +<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->28 January, 2015<!--webbot bot="Timestamp" endspan i-checksum="38902" --></p> +<p>© Copyright Beman Dawes, 2014</p> +<p> Distributed under 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> + + +</body> + +</html>
\ No newline at end of file diff --git a/libs/filesystem/doc/portability_guide.htm b/libs/filesystem/doc/portability_guide.htm index 54b5a748c..676c25cb3 100644 --- a/libs/filesystem/doc/portability_guide.htm +++ b/libs/filesystem/doc/portability_guide.htm @@ -4,9 +4,9 @@ <meta http-equiv="Content-Language" content="en-us"> <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"> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Portability Guide</title> -<link rel="stylesheet" type="text/css" href="../../../doc/src/minimal.css"> +<link href="styles.css" rel="stylesheet"> </head> <body bgcolor="#FFFFFF"> @@ -16,19 +16,20 @@ Name Portability Guide</h1> -<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" bgcolor="#D7EEFF" width="100%"> +<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" + bordercolor="#111111" bgcolor="#D7EEFF" width="100%"> <tr> - <td><a href="index.htm">Filesystem Home</a> - <a href="release_history.html">Releases</a> - <a href="reference.html">Reference</a> + <td><a href="index.htm">Home</a> <a href="tutorial.html">Tutorial</a> + <a href="reference.html">Reference</a> <a href="faq.htm">FAQ</a> + <a href="release_history.html">Releases</a> <a href="portability_guide.htm">Portability</a> <a href="v3.html">V3 Intro</a> <a href="v3_design.html">V3 Design</a> <a href="deprecated.html">Deprecated</a> + <a href="issue_reporting.html">Bug Reports </a> </td> - </tr> </table> <p> @@ -228,9 +229,9 @@ portability yet not overly restrict expressiveness.</p> <hr> <p>Revised -<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->20 March, 2012<!--webbot bot="Timestamp" endspan i-checksum="28814" --></p> +<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->29 December, 2014<!--webbot bot="Timestamp" endspan i-checksum="38652" --></p> -<p>© Copyright Beman Dawes, 2002, 2003</p> +<p>© Copyright Beman Dawes, 2002, 2003</p> <p> Use, modification, and distribution are subject to the Boost Software License, Version 1.0. (See accompanying file <a href="../../../LICENSE_1_0.txt"> LICENSE_1_0.txt</a> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt"> diff --git a/libs/filesystem/doc/reference.html b/libs/filesystem/doc/reference.html index 366bacafd..b6ff10f25 100644 --- a/libs/filesystem/doc/reference.html +++ b/libs/filesystem/doc/reference.html @@ -1,5 +1,5 @@ <html> -<!-- © Copyright Beman Dawes, 2002, 2006, 2007, 2009, 2010, 2011 --> +<!-- © Copyright Beman Dawes, 2002, 2006, 2007, 2009, 2010, 2011 --> <!-- Distributed under the Boost Software License, Version 1.0. --> <!-- See http://www.boost.org/LICENSE_1_0.txt --> @@ -9,7 +9,7 @@ <meta http-equiv="Content-Language" content="en-us"> <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"> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title> Filesystem Reference @@ -17,7 +17,7 @@ <style type="text/css"> /* - © Copyright Beman Dawes, 2007 + © Copyright Beman Dawes, 2007 Distributed under the Boost Software License, Version 1.0. See www.boost.org/LICENSE_1_0.txt @@ -60,18 +60,17 @@ del { background-color:#FFA0A0 } <table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" bgcolor="#D7EEFF" width="100%"> <tr> - <td><a href="index.htm">Filesystem Home</a> - <a href="release_history.html">Releases</a> - <a href="reference.html">Reference</a> + <td><a href="index.htm">Home</a> <a href="tutorial.html">Tutorial</a> + <a href="reference.html">Reference</a> <a href="faq.htm">FAQ</a> + <a href="release_history.html">Releases</a> <a href="portability_guide.htm">Portability</a> <a href="v3.html">V3 Intro</a> <a href="v3_design.html">V3 Design</a> <a href="deprecated.html">Deprecated</a> + <a href="issue_reporting.html">Bug Reports </a> </td> - </td> - </tr> </table> <h1>Reference Documentation</h1> @@ -3734,12 +3733,12 @@ multiple string types. His idea became the basis for the version 3 path design.< </table> <hr> > -<p><font size="2">© Copyright Beman Dawes, 2002, 2006, 2007, 2009, 2010, 2011</font></p> +<p><font size="2">© Copyright Beman Dawes, 2002, 2006, 2007, 2009, 2010, 2011</font></p> <p><font size="2">Distributed under the Boost Software License, Version 1.0. See </font> <a href="http://www.boost.org/LICENSE_1_0.txt"><font size="2">www.boost.org/LICENSE_1_0.txt</font></a></p> <p><font size="2">Revised -<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B %Y" startspan -->16 July 2012<!--webbot bot="Timestamp" endspan i-checksum="18787" --></font></p> +<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B %Y" startspan -->29 December 2014<!--webbot bot="Timestamp" endspan i-checksum="39176" --></font></p> </body></html>
\ No newline at end of file diff --git a/libs/filesystem/doc/release_history.html b/libs/filesystem/doc/release_history.html index c7587fab5..89aebd71d 100644 --- a/libs/filesystem/doc/release_history.html +++ b/libs/filesystem/doc/release_history.html @@ -4,9 +4,9 @@ <meta http-equiv="Content-Language" content="en-us"> <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"> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Filesystem Release History</title> -<link rel="stylesheet" type="text/css" href="../../../doc/src/minimal.css"> +<link href="styles.css" rel="stylesheet"> </head> <body> @@ -22,20 +22,38 @@ </tr> </table> -<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" bgcolor="#D7EEFF" width="100%"> +<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" + bordercolor="#111111" bgcolor="#D7EEFF" width="100%"> <tr> - <td><a href="../../../index.htm">Boost Home</a> - <a href="index.htm">Library Home</a> <a href="reference.html">Reference</a> + <td><a href="index.htm">Home</a> <a href="tutorial.html">Tutorial</a> + <a href="reference.html">Reference</a> <a href="faq.htm">FAQ</a> + <a href="release_history.html">Releases</a> <a href="portability_guide.htm">Portability</a> <a href="v3.html">V3 Intro</a> <a href="v3_design.html">V3 Design</a> <a href="deprecated.html">Deprecated</a> + <a href="issue_reporting.html">Bug Reports </a> </td> - </tr> </table> +<h2>1.58.0</h2> +<ul> + <li>Rewrite Windows implementation of temp_directory_path() to (1) avoid + GetTempPath() failure if path length > 130 (ticket #5300) and (2) provide a + more sensible sequence of directories than provided by GetTempPath(), per + boost list discussion "[filesystem] temp_directory_path() behavior on + Windows". The new sequence is:<ol> + <li><i><code>%TMP%</code></i></li> + <li><i><code>%TEMP%</code></i></li> + <li><code><i>%LOCALAPPDATA%</i>/Temp</code></li> + <li><code><i>%USERPROFILE%</i>/Temp</code></li> + <li><code><i>GetWindowsDirectoryW()</i>/Temp</code></li> + </ol> + </li> +</ul> + <h2>1.57.0</h2> <ul> <li>Rework class <code>path</code> locale and codecvt implementation for increased reliability. @@ -88,7 +106,7 @@ Solaris 10. (Chris Stylianou)</li> <li>Minor fixes and code cleanup.</li> <li>Update IDE projects to Visual Studio 2013.</li> - <li>Remove unused <code>const char colon</code> to clear clang warning. (Jürgen + <li>Remove unused <code>const char colon</code> to clear clang warning. (J?gen Hunold)</li> <li>Add BOOST_NOEXCEPT to <code>class filesystem_error</code>.</li> <li>Change <code>perms::all_all</code> and <code>perms::perms_mask</code> to @@ -259,8 +277,8 @@ </ul> <hr> <p>Revised -<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->29 October, 2014<!--webbot bot="Timestamp" endspan i-checksum="38757" --></p> -<p>© Copyright Beman Dawes, 2011</p> +<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->03 February, 2015<!--webbot bot="Timestamp" endspan i-checksum="40532" --></p> +<p>© Copyright Beman Dawes, 2011</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>
\ No newline at end of file diff --git a/libs/filesystem/doc/styles.css b/libs/filesystem/doc/styles.css new file mode 100644 index 000000000..6e6b17060 --- /dev/null +++ b/libs/filesystem/doc/styles.css @@ -0,0 +1,19 @@ +body +{ + font-family: sans-serif; + max-width: 6.5in; + margin: 0px auto; + font-size: 85%; +} + ins {background-color: #CCFFCC;} + del {background-color: #FFCACA;} + pre {background-color: #D7EEFF; font-size: 100%;} + code {font-size: 110%;} + table{font-size: 100%;} + + /* + © Copyright Beman Dawes, 2014 + Distributed under the Boost Software License, Version 1.0. + See www.boost.org/LICENSE_1_0.txt + */ +
\ No newline at end of file diff --git a/libs/filesystem/doc/tickets.html b/libs/filesystem/doc/tickets.html index 79c2d1ada..054acb403 100644 --- a/libs/filesystem/doc/tickets.html +++ b/libs/filesystem/doc/tickets.html @@ -4,7 +4,7 @@ <meta http-equiv="Content-Language" content="en-us"> <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"> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Filesystem Tickets</title> </head> diff --git a/libs/filesystem/doc/tutorial.html b/libs/filesystem/doc/tutorial.html index 0dbebec09..72db485e0 100644 --- a/libs/filesystem/doc/tutorial.html +++ b/libs/filesystem/doc/tutorial.html @@ -4,9 +4,9 @@ <meta http-equiv="Content-Language" content="en-us"> <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"> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Filesystem Tutorial</title> -<link rel="stylesheet" type="text/css" href="../../../doc/src/minimal.css"> +<link href="styles.css" rel="stylesheet"> </head> <body> @@ -22,20 +22,22 @@ </tr> </table> -<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" bgcolor="#D7EEFF" width="100%"> +<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" + bordercolor="#111111" bgcolor="#D7EEFF" width="100%"> <tr> - <td><a href="index.htm">Filesystem Home</a> - <a href="release_history.html">Releases</a> - <a href="reference.html">Reference</a> + <td><a href="index.htm">Home</a> <a href="tutorial.html">Tutorial</a> + <a href="reference.html">Reference</a> <a href="faq.htm">FAQ</a> + <a href="release_history.html">Releases</a> <a href="portability_guide.htm">Portability</a> <a href="v3.html">V3 Intro</a> <a href="v3_design.html">V3 Design</a> <a href="deprecated.html">Deprecated</a> + <a href="issue_reporting.html">Bug Reports </a> </td> - </tr> </table> + <p> <a href="#Introduction">Introduction</a><br> <a href="#Preliminaries">Preliminaries</a><br> @@ -1117,11 +1119,11 @@ It has a documentation. </p> <hr> -<p>© Copyright Beman Dawes 2010</p> +<p>© Copyright Beman Dawes 2010</p> <p>Distributed under 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>Revised -<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B %Y" startspan -->20 March 2012<!--webbot bot="Timestamp" endspan i-checksum="27254" --></p> +<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B %Y" startspan -->29 December 2014<!--webbot bot="Timestamp" endspan i-checksum="39176" --></p> </body> diff --git a/libs/filesystem/doc/v3.html b/libs/filesystem/doc/v3.html index 3b75140a2..062c56c2e 100644 --- a/libs/filesystem/doc/v3.html +++ b/libs/filesystem/doc/v3.html @@ -3,9 +3,9 @@ <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"> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Filesystem V3 Intro</title> -<link rel="stylesheet" type="text/css" href="../../../doc/src/minimal.css"> +<link href="styles.css" rel="stylesheet"> <body> @@ -21,19 +21,20 @@ </tr> </table> -<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" bgcolor="#D7EEFF" width="100%"> +<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" + bordercolor="#111111" bgcolor="#D7EEFF" width="100%"> <tr> - <td><a href="index.htm">Filesystem Home</a> - <a href="release_history.html">Releases</a> - <a href="reference.html">Reference</a> + <td><a href="index.htm">Home</a> <a href="tutorial.html">Tutorial</a> + <a href="reference.html">Reference</a> <a href="faq.htm">FAQ</a> + <a href="release_history.html">Releases</a> <a href="portability_guide.htm">Portability</a> <a href="v3.html">V3 Intro</a> <a href="v3_design.html">V3 Design</a> <a href="deprecated.html">Deprecated</a> + <a href="issue_reporting.html">Bug Reports </a> </td> - </tr> </table> <h1>Boost Filesystem Version 3</h1> @@ -140,11 +141,11 @@ cycle, and then Version 3 will become the default version.</p> </ul> <hr> -<p>© Copyright Beman Dawes, 2009</p> +<p>© Copyright Beman Dawes, 2009</p> <p>Distributed under 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>Revised -<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B %Y" startspan -->20 March 2012<!--webbot bot="Timestamp" endspan i-checksum="27254" --></p> +<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B %Y" startspan -->29 December 2014<!--webbot bot="Timestamp" endspan i-checksum="39176" --></p> </body> diff --git a/libs/filesystem/doc/v3_design.html b/libs/filesystem/doc/v3_design.html index cea4f1225..5f1326daa 100644 --- a/libs/filesystem/doc/v3_design.html +++ b/libs/filesystem/doc/v3_design.html @@ -4,40 +4,44 @@ <meta http-equiv="Content-Language" content="en-us"> <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"> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>Filesystem V3 Design</title> -<link rel="stylesheet" type="text/css" href="../../../doc/src/minimal.css"> +<link href="styles.css" rel="stylesheet"> </head> <body> -<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111"> +<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" + bordercolor="#111111"> <tr> <td> <a href="../../../index.htm"> -<img src="../../../boost.png" alt="boost.png (6897 bytes)" align="middle" border="0" width="300" height="86"></a></td> +<img src="../../../boost.png" alt="boost.png (6897 bytes)" align="middle" border="0" + width="300" height="86"></a></td> <td align="middle"> <font size="7">Filesystem Version 3<br> Design</font></td> </tr> </table> -<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" bgcolor="#D7EEFF" width="100%"> +<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" + bordercolor="#111111" bgcolor="#D7EEFF" width="100%"> <tr> - <td><a href="index.htm">Filesystem Home</a> - <a href="release_history.html">Releases</a> - <a href="reference.html">Reference</a> + <td><a href="index.htm">Home</a> <a href="tutorial.html">Tutorial</a> + <a href="reference.html">Reference</a> <a href="faq.htm">FAQ</a> + <a href="release_history.html">Releases</a> <a href="portability_guide.htm">Portability</a> <a href="v3.html">V3 Intro</a> <a href="v3_design.html">V3 Design</a> <a href="deprecated.html">Deprecated</a> + <a href="issue_reporting.html">Bug Reports </a> </td> - </tr> </table> -<table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" align="right"> +<table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse" + bordercolor="#111111" align="right"> <tr> <td width="100%" bgcolor="#D7EEFF" align="center"> <i><b>Contents</b></i></td> @@ -65,7 +69,8 @@ path type that accommodated multiple character types and encodings would be more flexible. Although I wasn't willing to stop development at that time to explore how this idea might be implemented, or to break from the pattern for Internationalization used the C++ standard library, I've often thought about -Peter's suggestion. With the advent of C++0x <code>char16_t</code> and <code>char32_t</code> character +Peter's suggestion. With the advent of C++0x <code>char16_t</code> and <code>char32_t</code> +character types, the <code>basic_path</code> class template approach becomes even more unwieldy, so it is time to revisit the problem in light of Peter's suggestion.</p> @@ -133,7 +138,8 @@ flexible user code.</p> </ul> <h2><a name="Details">Details</a></h2> -<table border="1" cellpadding="4" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="100%"> +<table border="1" cellpadding="4" cellspacing="0" style="border-collapse: collapse" + bordercolor="#111111" width="100%"> <tr> <td width="33%" colspan="3"> <p align="center"><b><i>Encoding </i></b><i><b>Conversions</b></i></td> @@ -175,14 +181,15 @@ been consistently applied to all applicable functions.</p> <h2><a name="Acknowledgements">Acknowledgements</a></h2> <p>Peter Dimov suggested the idea of a single path class that could cope with -multiple character types and encodings. Walter Landry contributed both the design and implementation of the copy_any, +multiple character types and encodings. Walter Landry contributed both the design +and implementation of the copy_any, copy_directory, copy_symlink, and read_symlink functions.</p> <hr> <p>Revised -<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->20 March, 2012<!--webbot bot="Timestamp" endspan i-checksum="28814" --></p> +<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->29 December, 2014<!--webbot bot="Timestamp" endspan i-checksum="38652" --></p> -<p>© Copyright Beman Dawes, 2008</p> +<p>© Copyright Beman Dawes, 2008</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> |