From: Jonathan Wakely Date: Fri, 16 Oct 2015 13:55:12 +0000 (+0100) Subject: Document options for Filesystem TS library X-Git-Tag: basepoints/gcc-7~3901 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=fe29811c31bcbe41b4808e2d021f6ab1282a269e;p=thirdparty%2Fgcc.git 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. From-SVN: r228914 --- diff --git a/libstdc++-v3/ChangeLog b/libstdc++-v3/ChangeLog index f89d477cafa4..f6c35e69359d 100644 --- a/libstdc++-v3/ChangeLog +++ b/libstdc++-v3/ChangeLog @@ -1,3 +1,11 @@ +2015-10-16 Jonathan Wakely + + * 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. + 2015-10-16 Aurelio Remonda * testsuite/25_algorithms/random_shuffle/moveable.cc: Change variable diff --git a/libstdc++-v3/doc/html/manual/configure.html b/libstdc++-v3/doc/html/manual/configure.html index 565d75e3e25f..a54582d7a79c 100644 --- a/libstdc++-v3/doc/html/manual/configure.html +++ b/libstdc++-v3/doc/html/manual/configure.html @@ -245,4 +245,8 @@ iostream, and others. Disabling means that the C++ runtime is compiled without support for vtable verification. By default, this option is off. -

PrevÂ	Up	Â Next
ChapterÂ 2.Â SetupÂ	Home	Â Make

\ No newline at end of file +

--enable-libstdcxx-filesystem-ts[default]

Build libstdc++fs.a 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. +

PrevÂ	Up	Â Next
ChapterÂ 2.Â SetupÂ	Home	Â Make

\ No newline at end of file diff --git a/libstdc++-v3/doc/html/manual/index.html b/libstdc++-v3/doc/html/manual/index.html index fbe657ef9dcb..091e40d0cf82 100644 --- a/libstdc++-v3/doc/html/manual/index.html +++ b/libstdc++-v3/doc/html/manual/index.html @@ -4,7 +4,7 @@

Table of Contents

I. Introduction -

Implementation Status

C++ 1998/2003

Implementation Status
Implementation Specific Behavior

Implementation Specific Behavior

Implementation Specific Behavior

C++ TR 24733

The Code: GPL
The Documentation: GPL, FDL

Implementation Bugs
Standard Bugs

Prerequisites
Configure
Make

Command Options

Header Files
Mixing Headers
The C Headers and namespace std
Precompiled Headers

Troubleshooting

Available Namespaces
namespace std
Using Namespace Composition

Almost Nothing
Finding Dynamic or Shared Libraries

Concurrency

Prerequisites

Thread Safety

Structure
Defaults
Future
Alternatives

Exception Safety

Exception Neutrality

Doing without

Compatibility

With C
With POSIX thread cancellation

Debugging Support

Using g++
Debug Versions of Library Binary Files
Memory Leak Hunting
Data Race Hunting
Using gdb
Tracking uncaught exceptions
Debug Mode
Compile Time Checking
Profile-based Performance Analysis

Implementation Status

C++ 1998/2003

Implementation Status
Implementation Specific Behavior

Implementation Specific Behavior

Implementation Specific Behavior

C++ TR 24733

The Code: GPL
The Documentation: GPL, FDL

Implementation Bugs
Standard Bugs

Prerequisites
Configure
Make

Command Options

Header Files
Mixing Headers
The C Headers and namespace std
Precompiled Headers

Troubleshooting

Available Namespaces
namespace std
Using Namespace Composition

Almost Nothing
Finding Dynamic or Shared Libraries
Experimental Library Extensions

Concurrency

Prerequisites

Thread Safety

Structure
Defaults
Future
Alternatives

Exception Safety

Exception Neutrality

Doing without

Compatibility

With C
With POSIX thread cancellation

Debugging Support

Using g++
Debug Versions of Library Binary Files
Memory Leak Hunting
Data Race Hunting
Using gdb
Tracking uncaught exceptions
Debug Mode
Compile Time Checking
Profile-based Performance Analysis

II. Standard Contents

4. Support diff --git a/libstdc++-v3/doc/html/manual/intro.html b/libstdc++-v3/doc/html/manual/intro.html index a98c0d26d67d..55ace72f0f39 100644 --- a/libstdc++-v3/doc/html/manual/intro.html +++ b/libstdc++-v3/doc/html/manual/intro.html @@ -5,4 +5,4 @@ PrevÂ The GNU C++ Library ManualÂ Next

PartÂ I.Â Introduction -

Table of Contents

Implementation Status

C++ 1998/2003

Implementation Status
Implementation Specific Behavior

Implementation Specific Behavior

Implementation Specific Behavior

C++ TR 24733

The Code: GPL
The Documentation: GPL, FDL

Implementation Bugs
Standard Bugs

Prerequisites
Configure
Make

Command Options

Header Files
Mixing Headers
The C Headers and namespace std
Precompiled Headers

Troubleshooting

Available Namespaces
namespace std
Using Namespace Composition

Almost Nothing
Finding Dynamic or Shared Libraries

Concurrency

Prerequisites

Thread Safety

Structure
Defaults
Future
Alternatives

Exception Safety

Exception Neutrality

Doing without

Compatibility

With C
With POSIX thread cancellation

Debugging Support

Using g++
Debug Versions of Library Binary Files
Memory Leak Hunting
Data Race Hunting
Using gdb
Tracking uncaught exceptions
Debug Mode
Compile Time Checking
Profile-based Performance Analysis

PrevÂ	Up	Â Next
The GNU C++ Library ManualÂ	Home	Â ChapterÂ 1.Â Status

\ No newline at end of file +

Table of Contents

Implementation Status

C++ 1998/2003

Implementation Status
Implementation Specific Behavior

Implementation Specific Behavior

Implementation Specific Behavior

C++ TR 24733

The Code: GPL
The Documentation: GPL, FDL

Implementation Bugs
Standard Bugs

Prerequisites
Configure
Make

Command Options

Header Files
Mixing Headers
The C Headers and namespace std
Precompiled Headers

Troubleshooting

Available Namespaces
namespace std
Using Namespace Composition

Almost Nothing
Finding Dynamic or Shared Libraries
Experimental Library Extensions

Concurrency

Prerequisites

Thread Safety

Structure
Defaults
Future
Alternatives

Exception Safety

Exception Neutrality

Doing without

Compatibility

With C
With POSIX thread cancellation

Debugging Support

Using g++
Debug Versions of Library Binary Files
Memory Leak Hunting
Data Race Hunting
Using gdb
Tracking uncaught exceptions
Debug Mode
Compile Time Checking
Profile-based Performance Analysis

PrevÂ	Up	Â Next
The GNU C++ Library ManualÂ	Home	Â ChapterÂ 1.Â Status

\ No newline at end of file diff --git a/libstdc++-v3/doc/html/manual/status.html b/libstdc++-v3/doc/html/manual/status.html index 9052ce64a0cc..cdbc8b94f2ff 100644 --- a/libstdc++-v3/doc/html/manual/status.html +++ b/libstdc++-v3/doc/html/manual/status.html @@ -457,7 +457,11 @@ not in any particular release. N4100 - File SystemYÂ

C++ 201z

+ File SystemY + Link with + + -lstdc++fs +

C++ 201z

In this implementation the -std=gnu++1z or -std=c++1z flag must be used to enable language and library diff --git a/libstdc++-v3/doc/html/manual/using.html b/libstdc++-v3/doc/html/manual/using.html index 5888002028a0..e9ed21fe8720 100644 --- a/libstdc++-v3/doc/html/manual/using.html +++ b/libstdc++-v3/doc/html/manual/using.html @@ -2,7 +2,7 @@ ChapterÂ 3.Â Using

ChapterÂ 3.Â Using
PrevÂ	PartÂ I.Â Introduction -	Â Next

ChapterÂ 3.Â Using

Command Options

+Â Next

ChapterÂ 3.Â Using

Command Options

The set of features available in the GNU C++ library is shaped by several GCC Command Options. Options that impact libstdc++ are @@ -23,4 +23,7 @@ -latomicLinking to libatomic is required for some uses of ISO C++11 <atomic>. + -lstdc++fsLinking to libstdc++fs + is required for use of the Filesystem library extensions in + <experimental/filesystem>. -fopenmpFor parallel mode.

PrevÂ	Up	Â Next
MakeÂ	Home	Â Headers

\ No newline at end of file diff --git a/libstdc++-v3/doc/html/manual/using_dynamic_or_shared.html b/libstdc++-v3/doc/html/manual/using_dynamic_or_shared.html index ac46c7e19f60..8defacd1e3b0 100644 --- a/libstdc++-v3/doc/html/manual/using_dynamic_or_shared.html +++ b/libstdc++-v3/doc/html/manual/using_dynamic_or_shared.html @@ -102,4 +102,21 @@ A quick read of the relevant part of the GCC also installed, for use with Libtool. If you use Libtool to create your executables, these details are taken care of for you. +

Experimental Library Extensions

+ 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, + libstdc++fs.a, and there is + no shared library for it. To use the library you should include + <experimental/filesystem> + and link with -lstdc++fs. The library implementation + is incomplete on non-POSIX platforms, specifically Windows support is + rudimentary. +

+ 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 + <experimental/xxx> + header will remain compatible between different GCC releases.

PrevÂ	Up	Â Next
NamespacesÂ	Home	Â Concurrency

\ No newline at end of file diff --git a/libstdc++-v3/doc/xml/manual/configure.xml b/libstdc++-v3/doc/xml/manual/configure.xml index 2f558d2b7d7d..ac383cf7fa76 100644 --- a/libstdc++-v3/doc/xml/manual/configure.xml +++ b/libstdc++-v3/doc/xml/manual/configure.xml @@ -411,6 +411,15 @@ + --enable-libstdcxx-filesystem-ts[default] + + Build libstdc++fs.a 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. + + + diff --git a/libstdc++-v3/doc/xml/manual/status_cxx2014.xml b/libstdc++-v3/doc/xml/manual/status_cxx2014.xml index d022ea412278..6f1fbe5664a1 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. File System Y - + + Link with + + + diff --git a/libstdc++-v3/doc/xml/manual/using.xml b/libstdc++-v3/doc/xml/manual/using.xml index 2c8d179b4897..96ae68614008 100644 --- a/libstdc++-v3/doc/xml/manual/using.xml +++ b/libstdc++-v3/doc/xml/manual/using.xml @@ -95,6 +95,14 @@ + + -lstdc++fs + Linking to libstdc++fs + is required for use of the Filesystem library extensions in + <experimental/filesystem>. + + + -fopenmp For parallel mode. @@ -1361,8 +1369,31 @@ A quick read of the relevant part of the GCC you. - +

Experimental Library Extensions + + + 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, + libstdc++fs.a, and there is + no shared library for it. To use the library you should include + <experimental/filesystem> + and link with . The library implementation + is incomplete on non-POSIX platforms, specifically Windows support is + rudimentary. + + + + 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 + <experimental/xxx> + header will remain compatible between different GCC releases. + +

+

Concurrency