Skip to content

Commit

Permalink
Documentation fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
Lastique committed Mar 23, 2024
1 parent 6f174ba commit a0c8edb
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 19 deletions.
2 changes: 1 addition & 1 deletion doc/index.htm
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ <h4><b>Effects and Postconditions not guaranteed in the presence of race-conditi
existing file &quot;foo&quot; and then creates a directory named &quot;foo&quot;, between the
example code's two calls to <i>is_directory()</i>.</p>
</blockquote>
<h4>E<b>xceptions</b></h4>
<h4><b>Exceptions</b></h4>
<p>Unless otherwise specified, Boost.Filesystem functions throw <i>
<a href="reference.html#basic_filesystem_error-constructors">basic_filesystem_error</a></i>
exceptions to report failures such as I/O errors. Implementations may also use C++ Standard Library functions
Expand Down
31 changes: 15 additions & 16 deletions doc/relative_proposal.html
Original file line number Diff line number Diff line change
Expand Up @@ -115,26 +115,25 @@ <h3><a name="Preliminary-implementation">Preliminary implementation</a></h3>
<a href="https://github.com/boostorg/filesystem/tree/feature/relative2">
github.com/boostorg/filesystem/tree/feature/relative2</a></p>
<h2><a name="Requirements">Requirements</a></h2>
<b><a name="Requirement-1">Requirement 1</a>:</b> Some uses require symlinks be followed; i.e. the path must be resolved in
the actual file system.<p><b><a name="Requirement-2">Requirement 2</a>: </b>Some uses require symlinks not be followed; i.e. the path must not be
<p><b><a name="Requirement-1">Requirement 1</a>:</b> Some uses require symlinks be followed; i.e. the path must be resolved in
the actual file system.</p>
<p><b><a name="Requirement-2">Requirement 2</a>: </b>Some uses require symlinks not be followed; i.e. the path must not be
resolved in the actual file system.</p>
<b><a name="Requirement-3">Requirement 3</a>: </b>Some uses require removing redundant current directory (<i>dot</i>)
or parent directory (<i>dot-dot</i>) placeholders.<p><b>
<a name="Requirement-4">Requirement 4</a>: </b>Some uses do not require removing redundant current directory (<i>dot</i>)
or parent directory (<i>dot-dot</i>) placeholders since the path is known to
be
already in normal form.</p>
<p><b><a name="Requirement-3">Requirement 3</a>: </b>Some uses require removing redundant current directory (<i>dot</i>)
or parent directory (<i>dot-dot</i>) placeholders.</p>
<p><b><a name="Requirement-4">Requirement 4</a>: </b>Some uses do not require removing redundant current directory (<i>dot</i>)
or parent directory (<i>dot-dot</i>) placeholders since the path is known to be already in normal form.</p>
<h2><a name="Issues">Issues</a></h2>
<p><b><a name="Issue-1">Issue 1</a>:</b> What happens if <code>p</code>
and <code>base</code> are themselves relative?</p>
<b><a name="Issue-2">Issue 2</a>:</b> What happens if there is no common prefix? Is this an error, the whole of
<code>p</code> is relative to <code>base</code>, or something else?<p><b>
<a name="Issue-3">Issue 3</a>:</b> What happens if <code>p</code>, <code>base</code>, or both are empty?</p>
<b><a name="Issue-4">Issue 4</a>:</b> What happens if <code>p</code> and <code>base</code> are the same?<p>
<b><a name="Issue-5">Issue 5</a>:</b> How is the &quot;common prefix&quot; determined?</p>
<b><a name="Issue-6">Issue 6</a>:</b> What happens if portions of <code>p</code> or <code>base</code> exist but
the entire path does not exist and yet symlinks need to be followed?<p><b>
<a name="Issue-7">Issue 7</a>:</b> What happens when a symlink in the existing portion of a path is affected
<p><b><a name="Issue-2">Issue 2</a>:</b> What happens if there is no common prefix? Is this an error, the whole of
<code>p</code> is relative to <code>base</code>, or something else?</p>
<p><b><a name="Issue-3">Issue 3</a>:</b> What happens if <code>p</code>, <code>base</code>, or both are empty?</p>
<p><b><a name="Issue-4">Issue 4</a>:</b> What happens if <code>p</code> and <code>base</code> are the same?</p>
<p><b><a name="Issue-5">Issue 5</a>:</b> How is the &quot;common prefix&quot; determined?</p>
<p><b><a name="Issue-6">Issue 6</a>:</b> What happens if portions of <code>p</code> or <code>base</code> exist but
the entire path does not exist and yet symlinks need to be followed?</p>
<p><b><a name="Issue-7">Issue 7</a>:</b> What happens when a symlink in the existing portion of a path is affected
by a directory (<i>dot-dot</i>) placeholder in a later non-existent portion of
the path?</p>
<p><b><a name="Issue-8">Issue 8</a>:</b> Overly complex semantics (and thus
Expand Down
3 changes: 1 addition & 2 deletions doc/tutorial.html
Original file line number Diff line number Diff line change
Expand Up @@ -664,7 +664,6 @@ <h2><a name="Using-path-decomposition">Using path decomposition, plus sorting re

return 0;
}<!-- end include file --></pre>
</blockquote>
</td>
</tr>
</table>
Expand Down Expand Up @@ -1077,7 +1076,7 @@ <h2><a name="Class path-iterators-etc">Class path: Iterators, observers, composi
<pre>$ ./path_info /foo bar baa.txt

composed path:
operator<<()---------: "/foo/bar/baa.txt"
operator&lt;&lt;()---------: "/foo/bar/baa.txt"
make_preferred()-----: "/foo/bar/baa.txt"

elements:
Expand Down

0 comments on commit a0c8edb

Please sign in to comment.