From: Jonathan Wakely <jwakely@redhat.com>
To: libstdc++@gcc.gnu.org, gcc-patches@gcc.gnu.org
Subject: [committed] libstdc++: Document libstdc++exp.a library for -fcontracts
Date: Wed, 12 Apr 2023 23:30:11 +0100 [thread overview]
Message-ID: <20230412223011.207158-1-jwakely@redhat.com> (raw)
Pushed to trunk.
-- >8 --
libstdc++-v3/ChangeLog:
* doc/xml/manual/using.xml: Document libstdc++exp.a library.
* doc/html/*: Regenerate.
diff --git a/libstdc++-v3/doc/xml/manual/using.xml b/libstdc++-v3/doc/xml/manual/using.xml
index 7f011a6d931..3a507fc1671 100644
--- a/libstdc++-v3/doc/xml/manual/using.xml
+++ b/libstdc++-v3/doc/xml/manual/using.xml
@@ -108,6 +108,14 @@
</entry>
</row>
+ <row>
+ <entry><literal>-lstdc++exp</literal></entry>
+ <entry>Linking to <filename class="libraryfile">libstdc++exp</filename>
+ is required for use of the C++ Contracts extensions enabled by
+ <literal>-fcontracts</literal>.
+ </entry>
+ </row>
+
<row>
<entry><literal>-lstdc++_libbacktrace</literal></entry>
<entry>Until C++23 support is non-experimental, linking to
@@ -1700,14 +1708,25 @@ A quick read of the relevant part of the GCC
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.
+ is incomplete on non-POSIX platforms, specifically Windows is only
+ partially supported.
</para>
<para>
- Due to the experimental nature of the Filesystem library the usual
+ GCC 13 includes an implementation of the C++ Contracts library defined by
+ <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2019/p1429r3.pdf">P1429R3</link>.
+ Because this is an experimental extension, not part of the C++ standard,
+ it is implemented in a separate library,
+ <filename class="libraryfile">libstdc++exp.a</filename>, and there is
+ no shared library for it. To use the library you should include
+ <filename class="headerfile"><experimental/contract></filename>
+ and link with <option>-lstdc++exp</option>.
+ </para>
+
+ <para>
+ Due to the experimental nature of these libraries the usual
guarantees about ABI stability and backwards compatibility do not apply
- to it. There is no guarantee that the components in any
+ to them. There is no guarantee that the components in any
<filename class="headerfile"><experimental/xxx></filename>
header will remain compatible between different GCC releases.
</para>
--
2.39.2
reply other threads:[~2023-04-12 22:30 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230412223011.207158-1-jwakely@redhat.com \
--to=jwakely@redhat.com \
--cc=gcc-patches@gcc.gnu.org \
--cc=libstdc++@gcc.gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).