diff options
author | redi <redi@138bc75d-0d04-0410-961f-82ee72b054a4> | 2015-10-16 13:55:12 +0000 |
---|---|---|
committer | redi <redi@138bc75d-0d04-0410-961f-82ee72b054a4> | 2015-10-16 13:55:12 +0000 |
commit | 3ae856eb0ace68b9f15ec5811a1a3ee8fd9d9602 (patch) | |
tree | 86e4e4aad4fb74150b42a6cdb1915a7855b37747 /libstdc++-v3/doc/xml/manual | |
parent | 9d0e3e3a33034c696d99e19bb3496916e5f45a68 (diff) | |
download | gcc-3ae856eb0ace68b9f15ec5811a1a3ee8fd9d9602.tar.gz |
Document options for Filesystem TS library
* doc/xml/manual/configure.xml: Document
--enable-libstdcxx-filesystem-ts option.
* doc/xml/manual/status_cxx2014.xml: Document libstdc++fs.a.
* doc/xml/manual/using.xml: Likewise.
* doc/html/*: Regenerate.
git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/trunk@228914 138bc75d-0d04-0410-961f-82ee72b054a4
Diffstat (limited to 'libstdc++-v3/doc/xml/manual')
-rw-r--r-- | libstdc++-v3/doc/xml/manual/configure.xml | 9 | ||||
-rw-r--r-- | libstdc++-v3/doc/xml/manual/status_cxx2014.xml | 6 | ||||
-rw-r--r-- | libstdc++-v3/doc/xml/manual/using.xml | 33 |
3 files changed, 46 insertions, 2 deletions
diff --git a/libstdc++-v3/doc/xml/manual/configure.xml b/libstdc++-v3/doc/xml/manual/configure.xml index 2f558d2b7d7..ac383cf7fa7 100644 --- a/libstdc++-v3/doc/xml/manual/configure.xml +++ b/libstdc++-v3/doc/xml/manual/configure.xml @@ -411,6 +411,15 @@ </para> </listitem></varlistentry> + <varlistentry><term><code>--enable-libstdcxx-filesystem-ts</code>[default]</term> + <listitem> + <para>Build <filename class="libraryfile">libstdc++fs.a</filename> as well + as the usual libstdc++ and libsupc++ libraries. This is enabled by + default on select POSIX targets where it is known to work and disabled + otherwise. + </para> + </listitem></varlistentry> + </variablelist> </section> diff --git a/libstdc++-v3/doc/xml/manual/status_cxx2014.xml b/libstdc++-v3/doc/xml/manual/status_cxx2014.xml index d022ea41227..6f1fbe5664a 100644 --- a/libstdc++-v3/doc/xml/manual/status_cxx2014.xml +++ b/libstdc++-v3/doc/xml/manual/status_cxx2014.xml @@ -402,7 +402,11 @@ not in any particular release. </entry> <entry>File System</entry> <entry>Y</entry> - <entry></entry> + <entry> + Link with + <link linkend="manual.intro.using.linkage.experimental"> + <option>-lstdc++fs</option></link> + </entry> </row> diff --git a/libstdc++-v3/doc/xml/manual/using.xml b/libstdc++-v3/doc/xml/manual/using.xml index 2c8d179b489..96ae6861400 100644 --- a/libstdc++-v3/doc/xml/manual/using.xml +++ b/libstdc++-v3/doc/xml/manual/using.xml @@ -96,6 +96,14 @@ </row> <row> + <entry><literal>-lstdc++fs</literal></entry> + <entry>Linking to <filename class="libraryfile">libstdc++fs</filename> + is required for use of the Filesystem library extensions in + <filename class="headerfile"><experimental/filesystem></filename>. + </entry> + </row> + + <row> <entry><literal>-fopenmp</literal></entry> <entry>For <link linkend="manual.ext.parallel_mode">parallel</link> mode.</entry> </row> @@ -1361,8 +1369,31 @@ A quick read of the relevant part of the GCC you. </para> </section> - </section> + <section xml:id="manual.intro.using.linkage.experimental" xreflabel="Library Extensions"><info><title>Experimental Library Extensions</title></info> + + <para> + GCC 5.3 includes an implementation of the Filesystem library defined + by the technical specification ISO/IEC TS 18822:2015. Because this is + an experimental library extension, not part of the C++ standard, it + is implemented in a separate library, + <filename class="libraryfile">libstdc++fs.a</filename>, and there is + no shared library for it. To use the library you should include + <filename class="headerfile"><experimental/filesystem></filename> + and link with <option>-lstdc++fs</option>. The library implementation + is incomplete on non-POSIX platforms, specifically Windows support is + rudimentary. + </para> + + <para> + Due to the experimental nature of the Filesystem library the usual + guarantees about ABI stability and backwards compatibility do not apply + to it. There is no guarantee that the components in any + <filename class="headerfile"><experimental/xxx></filename> + header will remain compatible between different GCC releases. + </para> + </section> + </section> <section xml:id="manual.intro.using.concurrency" xreflabel="Concurrency"><info><title>Concurrency</title></info> <?dbhtml filename="using_concurrency.html"?> |