Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r69269 - trunk/libs/filesystem/v3/doc
From: bdawes_at_[hidden]
Date: 2011-02-25 09:06:46

Next message: cppljevans_at_[hidden]: "[Boost-commit] svn:boost r69270 - sandbox/variadic_templates/libs/composite_storage/sandbox/pack"
Previous message: pbristow_at_[hidden]: "[Boost-commit] svn:boost r69268 - sandbox/guild/pool/libs/pool/doc"

Author: bemandawes
Date: 2011-02-25 09:06:44 EST (Fri, 25 Feb 2011)
New Revision: 69269
URL: http://svn.boost.org/trac/boost/changeset/69269

Log:
HTML cleanup. Also fix ANSI/ASCII boo boo and hex/decimal confusion (#5228)
Text files modified:
trunk/libs/filesystem/v3/doc/reference.html | 419 ++++++++++++++++++++-------------------
1 files changed, 216 insertions(+), 203 deletions(-)

Modified: trunk/libs/filesystem/v3/doc/reference.html
==============================================================================
--- trunk/libs/filesystem/v3/doc/reference.html (original)
+++ trunk/libs/filesystem/v3/doc/reference.html 2011-02-25 09:06:44 EST (Fri, 25 Feb 2011)
@@ -66,8 +66,8 @@
    path iterators 
    path deprecated functions 
    path non-member functions 
-    path inserters and extractors 
-  Class filesystem_error 
+    path inserters and extractors 
+  Class filesystem_error 
    <a href="#filesystem_error-members">filesystem_error
 constructors</a> 
    filesystem_error path1 
@@ -142,15 +142,16 @@
and directories. Other types of files, such as symbolic links, may be supported by the
implementation.
<a name="File-system">File system</a>: A collection of files and certain of their attributes.
-<a name="Filename">Filename</a>: The name of a file. Slash and 0
+<a name="Filename">Filename</a>: The name of a file. Slash and
+0x00
characters are not permitted. Implementations may define additional
characters or specific names that are not permitted. Filenames <code>.</code> 
and <code>..</code>  have special meaning. Implementations may define
additional filenames that have special meaning.
<blockquote>
- [Note: Most operating systems prohibit the ANSI control characters
- (0x00-0x31) in filenames.
- Windows prohibits the characters 0x00-0x31, <code>"</code>,<code>
+ [Note: Most operating systems prohibit the ASCII control characters
+ (0x00-0x1F) in filenames.
+ Windows prohibits the characters 0x00-0x1F, <code>"</code>,<code>
 *</code>,<code> :</code>,<code> <</code>,<code> ></code>,<code> ?</code>,<code>
 \</code>,<code> /</code>, and<code> |</code> --end note]
</blockquote>
@@ -310,11 +311,10 @@
 std::istream& operator>>( std::istream& is, path& p );
 std::wistream& operator>>( std::wistream& is, path& p )

- class filesystem_error;
-
- class directory_entry;
+ class filesystem_error;
+ class directory_entry;

- class directory_iterator;
+ class directory_iterator;

 class recursive_directory_iterator;

@@ -325,7 +325,7 @@

 class file_status;

- struct <a name="space_info">space_info</a> // returned by space function
+ struct <a name="space_info">space_info</a> // returned by space function
 {
 uintmax_t capacity;
 uintmax_t free;
@@ -350,7 +350,7 @@

 // operational functions

- path absolute(const path& p, const path& base=current_path());
+ path absolute(const path& p, const path& base=current_path());

 void copy(const path& from, const path& to);
 void copy(const path& from, const path& to, system::error_code& ec);
@@ -373,16 +373,16 @@
 bool create_directory(const path& p);
 bool create_directory(const path& p, system::error_code& ec);

- void create_directory_symlink(const path& to, const path& new_symlink);
- void create_directory_symlink(const path& to, const path& new_symlink, system::error_code& ec);
-
+ void create_directory_symlink(const path& to, const path& new_symlink);
+ void create_directory_symlink(const path& to, const path& new_symlink, system::error_code& ec);
+
 void create_hard_link(const path& to, const path& new_hard_link);
 void create_hard_link(const path& to, const path& new_hard_link, system::error_code& ec);

- void create_symlink(const path& to, const path& new_symlink);
- void create_symlink(const path& to, const path& new_symlink, system::error_code& ec);
+ void create_symlink(const path& to, const path& new_symlink);
+ void create_symlink(const path& to, const path& new_symlink, system::error_code& ec);

- path current_path();
+ path current_path();
 path current_path(system::error_code& ec);
 void current_path(const path& p);
 void current_path(const path& p, system::error_code& ec);
@@ -394,15 +394,15 @@
 bool equivalent(const path& p1, const path& p2);
 bool equivalent(const path& p1, const path& p2, system::error_code& ec);

- uintmax_t file_size(const path& p);
- uintmax_t file_size(const path& p, system::error_code& ec);</pre>
-<pre> uintmax_t hard_link_count(const path& p);
+ uintmax_t file_size(const path& p);
+ uintmax_t file_size(const path& p, system::error_code& ec);
+ uintmax_t hard_link_count(const path& p);
 uintmax_t hard_link_count(const path& p, system::error_code& ec);

- const path& initial_path();
- const path& initial_path(<code>system::error_code& ec</code>);
+ const path& initial_path();
+ const path& initial_path(<code>system::error_code& ec</code>);

- bool is_directory(file_status s);
+ bool is_directory(file_status s);
 bool is_directory(const path& p);
 bool is_directory(const path& p, system::error_code& ec);

@@ -441,10 +441,9 @@
 void resize_file(const path& p, uintmax_t size);
 void resize_file(const path& p, uintmax_t size, system::error_code& ec);

- space_info space(const path& p);
- space_info space(const path& p, system::error_code& ec);
-
- file_status status(const path& p);
+ space_info space(const path& p);
+ space_info space(const path& p, system::error_code& ec);
+ file_status status(const path& p);
 <a href="#file_status">file_status</a> <a href="#status">status</a>(const path& p, system::error_code& ec);

 bool status_known(file_status s);
@@ -868,14 +867,14 @@
 <code>new_extension</code>.
 Returns: <code>*this</code>
</blockquote>
-<pre><code>void <a name="path-swap">swap</a>(path& rhs);</code></pre>
+<pre><code>void <a name="path-swap">swap</a>(path& rhs);</code></pre>
<blockquote>
- Effects:
- Swaps the contents of the two paths.
- Throws: 
- nothing.
- Complexity: 
- constant time.
+ Effects:
+ Swaps the contents of the two paths.
+ Throws: 
+ nothing.
+ Complexity: 
+ constant time.
</blockquote>

<h3> <a name="path-native-format-observers"><code>path</code>
@@ -1070,15 +1069,15 @@
</blockquote>
<pre>bool <a name="path-is_absolute">is_absolute</a>() const;</pre>
<blockquote>
- Returns: <code>true</code>
- if the elements of <code>root_path()</code> uniquely identify a directory, else <code>false</code>.
- [Note: On POSIX,<code>
+ Returns: <code>true</code>
+ if the elements of <code>root_path()</code> uniquely identify a directory, else <code>false</code>.
+ [Note: On POSIX,<code>
 path("/foo").is_absolute()</code> returns <code>true</code>. On Windows, <code>
- path("/foo").is_absolute()</code> returns <code>false</code>. --end note]
+ path("/foo").is_absolute()</code> returns <code>false</code>. --end note]
</blockquote>
<pre>bool <a name="path-is_relative">is_relative</a>() const;</pre>
<blockquote>
- Returns: <code>!is_absolute()</code>.
+ Returns: <code>!is_absolute()</code>.
</blockquote>
<h3> <a name="path-iterators"> <code>
path</code> iterators</a></h3>
@@ -1143,11 +1142,11 @@
const string_type external_directory_string() const { return native(); }</pre>
</blockquote>
<h3> <a name="path-non-member-functions"> <code>path</code>
-non-member functions</a></h3>
-<pre>void swap( path& lhs, path& rhs )</pre>
+non-member functions</a></h3>
+<pre>void swap( path& lhs, path& rhs )</pre>
<blockquote>
- Effects: <code>
- lhs.swap(rhs)</code>.
+ Effects: <code>
+ lhs.swap(rhs)</code>.
</blockquote>
 <pre>bool lexicographical_compare(path::iterator first1, path::iterator last1,
 path::iterator first2, path::iterator last2)</pre>
@@ -1219,8 +1218,8 @@
<blockquote>
 Returns: <code>path(lhs) /= rhs</code>.
</blockquote>
-<h3> <a name="path-non-member-operators"><code>path</code></a><a name="path-inserter-extractor"> inserter
- and extractor</a></h3>
+<h3> <a name="path-non-member-operators"><code>path</code></a><a name="path-inserter-extractor"> inserter
+ and extractor</a></h3>
 The inserter and extractor delimit the string with double-quotes (<code>"</code>)
to ensure that paths with embedded spaces will round trip correctly. Ampersand (<code>&</code>)
is used as an escape character, so the path can itself contain double quotes.
@@ -1228,38 +1227,38 @@
std::basic_ostream<Char, Traits>& operator<<(std::basic_ostream<Char, Traits>& os, const path& p)
</pre>
<blockquote>
- Effects: 
+ Effects: 
 <code>os << <a href="../../../io/doc/quoted_manip.html">
- boost::io::quoted</a>(p.string<std::basic_string<Char>>(), static_cast<Char>('&'));</code>
- Returns:
- <code>os</code>
+ boost::io::quoted</a>(p.string<std::basic_string<Char>>(), static_cast<Char>('&'));</code>
+ Returns:
+ <code>os</code>
</blockquote>
<pre>template <class Char, class Traits>
inline std::basic_istream<Char, Traits>& operator>>(std::basic_istream<Char, Traits>& is, path& p)
</pre>
<blockquote>
- Effects:  
+ Effects:  
 <code> std::basic_string<Char> str; 
        is >>
 <a href="../../../io/doc/quoted_manip.html">boost::io::quoted</a>(str,
 static_cast<Char>('&')); 
-        p = str;</code>
- Returns:
- <code>is</code>
+        p = str;</code>
+ Returns:
+ <code>is</code>
 </blockquote>
<h3><a name="Class-filesystem_error">Class <code>filesystem_error</code></a></h3>
<pre> namespace boost
 {
 namespace filesystem
 {
- class basic_filesystem_error : public system_error
+ class basic_filesystem_error : public system_error
 {
 public:
 filesystem_error();
 filesystem_error(const filesystem_error&);
- filesystem_error(const std::string& what_arg, system::error_code ec);
- filesystem_error(const std::string& what_arg, const path& p1, system::error_code ec);
- filesystem_error(const std::string& what_arg, const path& p1, const path& p2, system::error_code ec);
+ filesystem_error(const std::string& what_arg, system::error_code ec);
+ filesystem_error(const std::string& what_arg, const path& p1, system::error_code ec);
+ filesystem_error(const std::string& what_arg, const path& p1, const path& p2, system::error_code ec);

 filesystem_error& filesystem_error(const filesystem_error&);
 ~filesystem_error();
@@ -1277,7 +1276,7 @@
objects thrown as exceptions to report file system errors from functions described in this
clause.
<h4> <a name="filesystem_error-members"> <code>filesystem_error</code> members</a></h4>
-<pre><a name="filesystem_error-2-arg">filesystem_error</a>(const std::string& what_arg, error_code ec);</pre>
+<pre><a name="filesystem_error-2-arg">filesystem_error</a>(const std::string& what_arg, error_code ec);</pre>
<blockquote>
 Postcondition:
 <table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="46%">
@@ -1287,9 +1286,9 @@
 </tr>
 <tr>
 <td width="18%" bgcolor="#FFFFFF"><code>
- runtime_error::what()</code></td>
- <td width="82%" bgcolor="#FFFFFF">
- <code>what_arg.c_str()</code></td>
+ runtime_error::what()</code></td>
+ <td width="82%" bgcolor="#FFFFFF">
+ <code>what_arg.c_str()</code></td>
 </tr>
 <tr>
 <td width="18%"><code>code()</code></td>
@@ -1305,7 +1304,7 @@
 </tr>
 </table>
</blockquote>
-<pre><a name="filesystem_error-3-arg">filesystem_error</a>(const std::string& what_arg, const path_type& p1, error_code ec);</pre>
+<pre><a name="filesystem_error-3-arg">filesystem_error</a>(const std::string& what_arg, const path_type& p1, error_code ec);</pre>
<blockquote>
 Postcondition:
 <table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="46%">
@@ -1315,9 +1314,9 @@
 </tr>
 <tr>
 <td width="18%" valign="top"><code>
- runtime_error::what()</code></td>
- <td width="82%">
- <code>what_arg.c_str()</code></td>
+ runtime_error::what()</code></td>
+ <td width="82%">
+ <code>what_arg.c_str()</code></td>
 </tr>
 <tr>
 <td width="18%" valign="top"><code>code()</code></td>
@@ -1325,8 +1324,8 @@
 </tr>
 <tr>
 <td width="18%" valign="top"><code>path1()</code></td>
- <td width="82%">Reference to stored copy of
- <code>p1</code></td>
+ <td width="82%">Reference to stored copy of
+ <code>p1</code></td>
 </tr>
 <tr>
 <td width="18%" valign="top"><code>path2().empty()</code></td>
@@ -1334,7 +1333,7 @@
 </tr>
 </table>
</blockquote>
-<pre><a name="filesystem_error-4-arg">filesystem_error</a>(const std::string& what_arg, const path_type& p1, const path_type& p2, error_code ec);</pre>
+<pre><a name="filesystem_error-4-arg">filesystem_error</a>(const std::string& what_arg, const path_type& p1, const path_type& p2, error_code ec);</pre>
<blockquote>
 Postcondition:
 <table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="46%">
@@ -1344,10 +1343,10 @@
 </tr>
 <tr>
 <td width="18%"><code>
- runtime_error::what()</code></td>
- <td width="82%">
+ runtime_error::what()</code></td>
+ <td width="82%">
 
- <code>w</code><code>hat_arg.c_str()</code></td>
+ <code>w</code><code>hat_arg.c_str()</code></td>
 </tr>
 <tr>
 <td width="18%"><code>code()</code></td>
@@ -1355,13 +1354,13 @@
 </tr>
 <tr>
 <td width="18%"><code>path1()</code></td>
- <td width="82%">Reference to stored copy of
- <code>p1</code></td>
+ <td width="82%">Reference to stored copy of
+ <code>p1</code></td>
 </tr>
 <tr>
 <td width="18%"><code>path2()</code></td>
- <td width="82%">Reference to stored copy of
- <code>p2</code></td>
+ <td width="82%">Reference to stored copy of
+ <code>p2</code></td>
 </tr>
 </table>
</blockquote>
@@ -1395,17 +1394,19 @@
 // constructors and destructor
 directory_entry();
 directory_entry(const directory_entry&);
- explicit directory_entry(const path_type& p, file_status st=file_status(), file_status symlink_st=file_status());
+ explicit directory_entry(const path_type& p, file_status st=file_status(), file_status symlink_st=file_status());
 ~directory_entry();

 // modifiers
 directory_entry& operator=(const directory_entry&);
- void assign(const path_type& p, file_status st=file_status(), file_status symlink_st=file_status());
- void replace_filename(const path& p, file_status st=file_status(), file_status symlink_st=file_status());
+ void assign(const path_type& p, file_status st=file_status(), file_status symlink_st=file_status());
+ void replace_filename(const path& p, file_status st=file_status(), file_status symlink_st=file_status());

 // observers
 const path& path() const;
- file_status status(system::error_code& ec) const;
+ file_status status() const;
+ file_status status(system::error_code& ec) const;
+ file_status symlink_status() const;
 file_status symlink_status(system::error_code& ec) const;

 bool operator< (const directory_entry& rhs);
@@ -1415,11 +1416,10 @@
 bool operator<=(const directory_entry& rhs);
 bool operator> (const directory_entry& rhs);
 bool operator>=(const directory_entry& rhs);
-
- private:
+ private:
 path_type m_path; // for exposition only
- mutable file_status m_status; // for exposition only; stat()-like
- mutable file_status m_symlink_status; // for exposition only; lstat()-like
+ mutable file_status m_status; // for exposition only; stat()-like
+ mutable file_status m_symlink_status; // for exposition only; lstat()-like
 };

 } // namespace filesystem
@@ -1462,7 +1462,7 @@
 </tr>
 </table>
</blockquote>
-<pre>explicit directory_entry(const path_type& p, file_status st=file_status(), file_status symlink_st=file_status());</pre>
+<pre>explicit directory_entry(const path_type& p, file_status st=file_status(), file_status symlink_st=file_status());</pre>
<blockquote>
 Postcondition:
 <table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="36%">
@@ -1485,7 +1485,7 @@
 </table>
</blockquote>
<h4> <a name="directory_entry-modifiers"> <code>directory_entry </code>modifiers</a></h4>
-<pre>void assign(const path_type& p, file_status st=file_status(), file_status symlink_st=file_status());</pre>
+<pre>void assign(const path_type& p, file_status st=file_status(), file_status symlink_st=file_status());</pre>
<blockquote>
 Postcondition:
 <table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="36%">
@@ -1507,7 +1507,7 @@
 </tr>
 </table>
</blockquote>
-<pre>void replace_filename(const path& p, file_status st=file_status(), file_status symlink_st=file_status());</pre>
+<pre>void replace_filename(const path& p, file_status st=file_status(), file_status symlink_st=file_status());</pre>
<blockquote>
 Postcondition:
 <table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="43%">
@@ -1534,64 +1534,75 @@
<blockquote>
 Returns: <code>m_path</code>
</blockquote>
-<pre>file_status status(system::error_code& ec) const;</pre>
+<pre>file_status status() const;
+file_status status(system::error_code& ec) const;</pre>
<blockquote>
-Effects:
-As if,
+Effects:
+As if,
 <blockquote>
- <pre>if ( !status_known( m_status ) )
+ <pre>if ( !status_known( m_status ) )
{
 if ( status_known(m_symlink_status) && !is_symlink(m_symlink_status) )
 { m_status = m_symlink_status; }
- else { m_status = status(m_path, ec); }
-}
-else if ( &ec != &boost::throws() ) ec.clear();</pre>
+ else { m_status = status(m_path[, ec]); }
+}</pre>
 </blockquote>
- Returns: <code>m_status</code>
+ Returns: <code>m_status</code>
+
+ Throws: As specified in
+ <a href="#Error-reporting">
+ Error reporting</a>.
+
</blockquote>
-<pre>file_status symlink_status(system::error_code& ec) const;</pre>
+<pre>file_status symlink_status() const;
+file_status symlink_status(system::error_code& ec) const;</pre>
<blockquote>
-Effects:
-As if,
+
+ Effects:
+As if,
 <blockquote>
- <pre>if ( !status_known( m_symlink_status ) )
+ <pre>if ( !status_known( m_symlink_status ) )
{
- m_symlink_status = symlink_status(m_path, ec);
-}
-else if ( &ec != &boost::throws() ) ec.clear();</pre>
+ m_symlink_status = symlink_status(m_path[, ec]);
+}</pre>
 </blockquote>
- Returns: <code>
- m_symlink_status</code>
+ Returns: <code>
+ m_symlink_status</code>
+
+ Throws: As specified in
+ <a href="#Error-reporting">
+ Error reporting</a>.
+
</blockquote>
-<pre>bool operator==(const directory_entry& rhs);</pre>
+<pre>bool operator==(const directory_entry& rhs);</pre>
<blockquote>
- Returns: <code>m_path ==
- rhs.m_path</code>.
+ Returns: <code>m_path ==
+ rhs.m_path</code>.
</blockquote>
-<pre>bool operator!=(const directory_entry& rhs);</pre>
+<pre>bool operator!=(const directory_entry& rhs);</pre>
<blockquote>
- Returns: <code>m_path !=
- rhs.m_path</code>.
+ Returns: <code>m_path !=
+ rhs.m_path</code>.
</blockquote>
-<pre>bool operator< (const directory_entry& rhs);</pre>
+<pre>bool operator< (const directory_entry& rhs);</pre>
<blockquote>
- Returns: <code>m_path <
- rhs.m_path</code>.
+ Returns: <code>m_path <
+ rhs.m_path</code>.
</blockquote>
-<pre>bool operator<=(const directory_entry& rhs);</pre>
+<pre>bool operator<=(const directory_entry& rhs);</pre>
<blockquote>
- Returns: <code>m_path <=
- rhs.m_path</code>.
+ Returns: <code>m_path <=
+ rhs.m_path</code>.
</blockquote>
-<pre>bool operator> (const directory_entry& rhs);</pre>
+<pre>bool operator> (const directory_entry& rhs);</pre>
<blockquote>
- Returns: <code>m_path >
- rhs.m_path</code>.
+ Returns: <code>m_path >
+ rhs.m_path</code>.
</blockquote>
-<pre>bool operator>=(const directory_entry& rhs);</pre>
+<pre>bool operator>=(const directory_entry& rhs);</pre>
<blockquote>
- Returns: <code>m_path >=
- rhs.m_path</code>.
+ Returns: <code>m_path >=
+ rhs.m_path</code>.
</blockquote>
<h3><a name="Class-directory_iterator">Class <code>directory_iterator</code></a></h3>
Objects of type <code>directory_iterator</code> provide standard library
@@ -2002,8 +2013,8 @@
<pre>void <a name="copy_file">copy_file</a>(const path& from, const path& to, BOOST_SCOPED_ENUM(copy_option) option);
void <a name="copy_file2">copy_file</a>(const path& from, const path& to, BOOST_SCOPED_ENUM(copy_option) option, system::error_code& ec);</pre>
<blockquote>
- Effects: If <code>option == copy_option::</code><code>fail_if_exists
- && exists(to)</code>, an error is reported. Otherwise, the contents and attributes of the file <code>from</code>
+ Effects: If <code>option == copy_option::</code><code>fail_if_exists
+ && exists(to)</code>, an error is reported. Otherwise, the contents and attributes of the file <code>from</code>
 resolves to are copied to the file <code>to</code> resolves to.
 Throws: As specified in
 <a href="#Error-reporting">
@@ -2046,27 +2057,27 @@
 <a href="#Error-reporting">
 Error reporting</a>.
</blockquote>
-<pre>void <a name="create_directory_symlink">create_directory_symlink</a>(const path& to, const path& new_symlink);
-void create_directory_symlink(const path& to, const path& new_symlink, system::error_code& ec);</pre>
+<pre>void <a name="create_directory_symlink">create_directory_symlink</a>(const path& to, const path& new_symlink);
+void create_directory_symlink(const path& to, const path& new_symlink, system::error_code& ec);</pre>
<blockquote style="font-size: 10pt">
- Effects:
- Establishes the postcondition, as if by 
- POSIX
- <code>
+ Effects:
+ Establishes the postcondition, as if by 
+ POSIX
+ <code>
 <a href="http://www.opengroup.org/onlinepubs/000095399/functions/symlink.html">
- symlink()</a></code>.
- 
+ symlink()</a></code>.
+ 
 Postcondition: <code>new_symlink</code> resolves to a symbolic link file that
- contains an unspecified representation of <code>to</code>.
+ contains an unspecified representation of <code>to</code>.
 Throws: As specified in
 <a href="#Error-reporting">
 Error reporting</a>.
- [Note:
+ [Note:
 Some operating systems, such as Windows, require symlink creation to
 identify that the link is to a directory. Portable code should use <code>
 create_directory_symlink()</code> to create directory symlinks rather than
- <code>create_symlink()</code> -- end note]
- [Note:
+ <code>create_symlink()</code> -- end note]
+ [Note:
 Some operating systems do not support symbolic links at all or support
 them only for regular files. Windows prior to Vista, for example, did not
 support symbolic links.
@@ -2075,52 +2086,52 @@
 symbolic links regardless of the operating system - the FAT system used on floppy discs, memory cards and flash
 drives,
 for example. Thus symbolic links should only be used if these situations are
- not concerns, or if workarounds are provided. -- end note]
+ not concerns, or if workarounds are provided. -- end note]
 </blockquote>
-<pre>void <a name="create_hard_link">create_hard_link</a>(const path& to, const path& new_hard_link);
-void <a name="create_hard_link2">create_hard_link</a>(const path& to, const path& new_hard_link, system::error_code& ec);</pre>
+<pre>void <a name="create_hard_link">create_hard_link</a>(const path& to, const path& new_hard_link);
+void <a name="create_hard_link2">create_hard_link</a>(const path& to, const path& new_hard_link, system::error_code& ec);</pre>
<blockquote>
- Effects: Establishes the postcondition, as if by
- POSIX
- <code>
+ Effects: Establishes the postcondition, as if by
+ POSIX
+ <code>
 <a href="http://www.opengroup.org/onlinepubs/000095399/functions/link.html">
- link()</a></code>.
- Postcondition:
+ link()</a></code>.
+ Postcondition:
 <ul>
- <li> <code>exists(to) &&
- exists(</code><code>new_hard_link</code><code>) && equivalent(to,
+ <li> <code>exists(to) &&
+ exists(</code><code>new_hard_link</code><code>) && equivalent(to,

- </code><code>new_hard_link</code><code>)</code></li>
- <li>The contents of the file or directory
- <code>to</code> resolves to are unchanged.</li>
+ </code><code>new_hard_link</code><code>)</code></li>
+ <li>The contents of the file or directory
+ <code>to</code> resolves to are unchanged.</li>
 </ul>
 Throws: As specified in
 <a href="#Error-reporting">
 Error reporting</a>.
- [Note:
+ [Note:
 Some operating systems do not support hard links at all or support
 them only for regular files. Some file systems do not support hard
 links regardless of the operating system - the FAT system used on floppy
 discs, memory cards and flash drives, for example. Some file systems limit the
 number of links per file. Thus hard links should only be used if these
- situations are not concerns, or if workarounds are provided. -- end note]
+ situations are not concerns, or if workarounds are provided. -- end note]
 </blockquote>
-<pre>void <a name="create_symlink">create_symlink</a>(const path& to, const path& new_symlink);
-void <a name="create_symlink2">create_symlink</a>(const path& to, const path& new_symlink, system::error_code& ec);</pre>
+<pre>void <a name="create_symlink">create_symlink</a>(const path& to, const path& new_symlink);
+void <a name="create_symlink2">create_symlink</a>(const path& to, const path& new_symlink, system::error_code& ec);</pre>
<blockquote style="font-size: 10pt">
- Effects:
- Establishes the postcondition, as if by 
- POSIX
- <code>
+ Effects:
+ Establishes the postcondition, as if by 
+ POSIX
+ <code>
 <a href="http://www.opengroup.org/onlinepubs/000095399/functions/symlink.html">
- symlink()</a></code>.
- 
+ symlink()</a></code>.
+ 
 Postcondition: <code>new_symlink</code> resolves to a symbolic link file that
- contains an unspecified representation of <code>to</code>.
+ contains an unspecified representation of <code>to</code>.
 Throws: As specified in
 <a href="#Error-reporting">
 Error reporting</a>.
- [Note:
+ [Note:
 Some operating systems do not support symbolic links at all or support
 them only for regular files. Windows prior to Vista, for example, did not
 support symbolic links.
@@ -2129,7 +2140,7 @@
 symbolic links regardless of the operating system - the FAT system used on floppy discs, memory cards and flash
 drives,
 for example. Thus symbolic links should only be used if these situations are
- not concerns, or if workarounds are provided. -- end note]
+ not concerns, or if workarounds are provided. -- end note]
 </blockquote>
<pre>path <a name="current_path">current_path</a>();
path <a name="current_path2">current_path</a>(system::error_code& ec);</pre>
@@ -2151,12 +2162,12 @@
<pre>void current_path(const path& p);
void current_path(const path& p, system::error_code& ec);</pre>
<blockquote>
- Effects:
- Establishes the postcondition, as if by 
- POSIX
- <code>
+ Effects:
+ Establishes the postcondition, as if by 
+ POSIX
+ <code>
 <a href="http://www.opengroup.org/onlinepubs/000095399/functions/chdir.html">
- chdir()</a></code>.
+ chdir()</a></code>.
Postcondition: <code>equivalent(p, current_path())</code>.
Throws: As specified in
<a href="#Error-reporting">
@@ -2165,10 +2176,10 @@
 global state. It may be changed unexpectedly by a third-party or system
 library functions, or by another thread.  -- end note]
</blockquote>
-<pre>bool <a name="exists">exists</a>(file_status s);</pre>
+<pre>bool <a name="exists">exists</a>(file_status s);</pre>
<blockquote>
- Returns:
- <code>status_known(s) && s.type() != file_not_found</code>
+ Returns:
+ <code>status_known(s) && s.type() != file_not_found</code>
 Throws: Nothing.
</blockquote>
<pre>bool <a name="exists2">exists</a>(const path& p);
@@ -2208,20 +2219,22 @@
 <code>nFileSizeLow</code>, <code>ftLastWriteTime.dwLowDateTime</code>, and
 <code>ftLastWriteTime.dwHighDateTime</code>. -- end note]
 </blockquote>
- Throws: <code>filesystem_error</code>
- if <code>(!exists(s1) && !exists(s2)) || (is_other(s1) && is_other(s2))</code>,
+ Throws: <code>filesystem_error</code>
+ if <code>(!exists(s1) && !exists(s2)) || (is_other(s1) && is_other(s2))</code>,
 otherwise as specified in
 <a href="#Error-reporting">
 Error reporting</a>.
</blockquote>
<div dir="ltr">
-<pre>uintmax_t <a name="file_size">file_size</a>(const path& p);
-uintmax_t <a name="file_size2">file_size</a>(const path& p, system::error_code& ec);</pre>
+<pre>uintmax_t <a name="file_size">file_size</a>(const path& p);
+uintmax_t <a name="file_size2">file_size</a>(const path& p, system::error_code& ec);</pre>
</div>
<blockquote>
- Remarks: 
+ 
+ Remarks: 
+ 
 Returns: If <code>exists(p) && is_regular_file(p)</code>, the size
- in bytes
+ in bytes
 of the file <code>p</code> resolves to, determined as if by the value of
 the POSIX <code>
 <a href="http://www.opengroup.org/onlinepubs/000095399/basedefs/sys/stat.h.html">stat</a></code> structure member <code>st_size</code>
@@ -2243,24 +2256,24 @@

</blockquote>

-<pre>const path& <a name="initial_path">initial_path</a>();
-const path& <a name="initial_path">initial_path</a>(<code>system::error_code& ec</code>);</pre>
+<pre>const path& <a name="initial_path">initial_path</a>();
+const path& <a name="initial_path">initial_path</a>(<code>system::error_code& ec</code>);</pre>
<blockquote>
- Returns: 
+ Returns:
 <code>current_path()</code> as of the first call to <code>initial_path()</code>.
- [Note: <code>
+ [Note: <code>
 initial_path()</code> is not thread safe, and may return an undesirable result
 if called subsequent to a change to the current directory. These problems can
 be avoided by calling <code>initial_path()</code> immediately on entry to
- main().  --end note]
+ main().  --end note]
 Throws: For the first call, as specified in
 <a href="#Error-reporting">
 Error reporting</a>. Subsequent calls throw nothing.
</blockquote>
-<pre>bool <code><a name="is_directory">is_directory</a></code>(file_status s);</pre>
+<pre>bool <code><a name="is_directory">is_directory</a></code>(file_status s);</pre>
<blockquote>
- Returns: 
- <code>s.type() == directory_file</code>
+ Returns:
+ <code>s.type() == directory_file</code>
 Throws: Nothing.
</blockquote>
<pre><code>bool <a name="is_directory2">is_directory</a>(const path& p);
@@ -2308,10 +2321,10 @@
 Returns: <code>is_regular_file(status(p, ec))</code>.
 Throws: Nothing.
</blockquote>
-<pre>bool <a name="is_other">is_other</a>(file_status s);</pre>
+<pre>bool <a name="is_other">is_other</a>(file_status s);</pre>
<blockquote>
- Returns:
- <code>return exists(s) && !is_regular_file(s) && !is_directory(s) && !is_symlink(s)</code>
+ Returns:
+ <code>return exists(s) && !is_regular_file(s) && !is_directory(s) && !is_symlink(s)</code>
 Throws: Nothing.
</blockquote>
<pre><code>bool <a name="is_other2">is_other</a>(const path& p);
@@ -2322,10 +2335,10 @@
 Throws: <code>filesystem_error</code>; overload with <code>error_code&</code> throws
 nothing.
</blockquote>
-<pre>bool <a name="is_symlink">is_symlink</a>(file_status s);</pre>
+<pre>bool <a name="is_symlink">is_symlink</a>(file_status s);</pre>
<blockquote>
- Returns: 
- <code>s.type() == symlink_file</code>
+ Returns:
+ <code>s.type() == symlink_file</code>
 Throws: Nothing.
</blockquote>
<pre><code>bool <a name="is_symlink2">is_symlink</a>(const path& p);
@@ -2426,8 +2439,8 @@
 <a href="#Error-reporting">
 Error reporting</a>.
</blockquote>
-<pre>void <a name="resize_file">resize_file</a>(const path& p, uintmax_t new_size);
-void <a name="resize_file2">resize_file</a>(const path& p, uintmax_t new_size, system::error_code& ec);</pre>
+<pre>void <a name="resize_file">resize_file</a>(const path& p, uintmax_t new_size);
+void <a name="resize_file2">resize_file</a>(const path& p, uintmax_t new_size, system::error_code& ec);</pre>
<blockquote>
Postcondition: <code>file_size() == new_size</code>.
Throws: As specified in
@@ -2438,12 +2451,12 @@
 <a href="http://www.opengroup.org/onlinepubs/000095399/functions/truncate.html">
 truncate()</a></code>.
</blockquote>
-<pre>space_info <a name="space">space</a>(const path& p);
-space_info <a name="space2">space</a>(const path& p, system::error_code& ec);</pre>
+<pre>space_info <a name="space">space</a>(const path& p);
+space_info <a name="space2">space</a>(const path& p, system::error_code& ec);</pre>
<blockquote>
- Returns: An object of type <code>
+ Returns: An object of type <code>
 <a href="#space_info">space_info</a></code>. The value of the <code>space_info</code> object is determined as if by
- using POSIX <code>
+ using POSIX <code>
 <a href="http://www.opengroup.org/onlinepubs/000095399/functions/statvfs.html" style="text-decoration: none">
 statvfs()</a></code> to obtain a POSIX struct <code>
 <a href="http://www.opengroup.org/onlinepubs/000095399/basedefs/sys/statvfs.h.html" style="text-decoration: none">
@@ -2451,7 +2464,7 @@
 f_bfree</code>, and <code>f_bavail</code> members by its <code>f_frsize</code>
 member, and assigning the results to the <code>capacity</code>, <code>free</code>,
 and <code>available</code> members respectively. Any members for which the
- value cannot be determined shall be set to -1.
+ value cannot be determined shall be set to -1.
 Throws: As specified in
 <a href="#Error-reporting">
 Error reporting</a>.
@@ -2567,10 +2580,10 @@
 resolution,
 pathname resolution continues using the contents of the symbolic link.
</blockquote>
-<pre>bool <a name="status_known">status_known</a>(file_status s);</pre>
+<pre>bool <a name="status_known">status_known</a>(file_status s);</pre>
<blockquote>
- Returns:
- <code>s.type() != status_error</code>
+ Returns:
+ <code>s.type() != status_error</code>
 Throws: Nothing.
</blockquote>
<pre>file_status <a name="symlink_status">symlink_status</a>(const path& p);
@@ -3236,7 +3249,7 @@
 <tr>
 <td width="16%" valign="top">[<a name="ISO_POSIX">ISO-POSIX</a>]</td>
 <td width="84%">ISO/IEC 9945:2003, IEEE Std 1003.1-2001, and The Open Group
- Base Specifications, Issue 6. Also known as The Single UnixÂ®
+ Base Specifications, Issue 6. Also known as The Single UnixÃ‚Â®
 Specification, Version 3. Available from each of the organizations involved
 in its creation. For example, read online or download from
 <a href="http://www.unix.org/single_unix_specification/">
@@ -3252,11 +3265,11 @@
 </tr>
</table>
<hr>
-© Copyright Beman Dawes, 2002, 2006, 2007, 2009, 2010
+Â© Copyright Beman Dawes, 2002, 2006, 2007, 2009, 2010
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>
Revised
-20 February 2011
+25 February 2011

</body>

Next message: cppljevans_at_[hidden]: "[Boost-commit] svn:boost r69270 - sandbox/variadic_templates/libs/composite_storage/sandbox/pack"
Previous message: pbristow_at_[hidden]: "[Boost-commit] svn:boost r69268 - sandbox/guild/pool/libs/pool/doc"

Date view	Thread view	Subject view	Author view

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