Skip to content

Commit

Permalink
Fix documentation for linkgroups
Browse files Browse the repository at this point in the history
  • Loading branch information
nickclark2016 committed Dec 9, 2024
1 parent 8f174c4 commit 597e5a8
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions website/docs/linkgroups.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Turns on/off linkgroups for gcc/clang in the gmake backend.
Turns on/off linkgroups for the GCC and Clang toolsets in the gmake, gmake2, and codelite generators.

```lua
linkgroups ("value")
Expand All @@ -8,6 +8,6 @@ linkgroups ("value")

`value` is a boolean value, i.e. "On" or "Off".

When linking against another projects or libraries gcc/clang by default have order dependent linking, at least with the general default linker. While it is generally believed to be slower, you can enable order independent linking within a group of libraries by putting them inside of a link-group using the -Wl,--start-group and -Wl,--end-group command line arguments.
Projects using GCC or Clang will use order dependent linking by default with the default linker. While it is generally believed to be slower, you can enable order independent linking within a group of libraries by putting them inside of a link-group using the -Wl,--start-group and -Wl,--end-group command line arguments.

This API turns this grouping on or off (it is off by default), and applies to all libraries specified in the [links](links.md) API.

0 comments on commit 597e5a8

Please sign in to comment.