summaryrefslogtreecommitdiffstats
path: root/Help/variable/LINK_GROUP_PREDEFINED_FEATURES.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Help/variable/LINK_GROUP_PREDEFINED_FEATURES.txt')
-rw-r--r--Help/variable/LINK_GROUP_PREDEFINED_FEATURES.txt32
1 files changed, 16 insertions, 16 deletions
diff --git a/Help/variable/LINK_GROUP_PREDEFINED_FEATURES.txt b/Help/variable/LINK_GROUP_PREDEFINED_FEATURES.txt
index 5f1a11b..557886e 100644
--- a/Help/variable/LINK_GROUP_PREDEFINED_FEATURES.txt
+++ b/Help/variable/LINK_GROUP_PREDEFINED_FEATURES.txt
@@ -1,22 +1,22 @@
-**Circular references with static libraries**
-
-Some linkers are one-pass only so to handle circular references between
-static libraries, the following feature can be used:
-
``RESCAN``
- The specified static libraries are searched repeatedly until no
- new undefined references are created. Normally, an static library is searched
- only once in the order that it is specified on the command line. If a symbol
- in that library is needed to resolve an undefined symbol referred to by an
- object in an library that appears later on the command line, the linker would
- not be able to resolve that reference. By grouping the static libraries, they
- all be searched repeatedly until all possible references are resolved (use
- linker options ``--start-group`` and ``--end-group`` or, on ``SunOS``,
- ``-z rescan-start`` and ``-z rescan-end``).
+ Some linkers are single-pass only. For such linkers, circular references
+ between libraries typically result in unresolved symbols. This feature
+ instructs the linker to search the specified static libraries repeatedly
+ until no new undefined references are created.
+
+ Normally, a static library is searched only once in the order that it is
+ specified on the command line. If a symbol in that library is needed to
+ resolve an undefined symbol referred to by an object in a library that
+ appears later on the command line, the linker would not be able to resolve
+ that reference. By grouping the static libraries with the ``RESCAN``
+ feature, they will all be searched repeatedly until all possible references
+ are resolved. This will use linker options like ``--start-group`` and
+ ``--end-group``, or on SunOS, ``-z rescan-start`` and ``-z rescan-end``.
Using this feature has a significant performance cost. It is best to use it
only when there are unavoidable circular references between two or more
static libraries.
- This feature is available on ``Linux``, ``BSD``, and ``SunOS`` target
- platforms as well as ``Windows`` when ``GNU`` toolchain is used.
+ This feature is available when using toolchains that target Linux, BSD, and
+ SunOS. It can also be used when targeting Windows platforms if the GNU
+ toolchain is used.