Added a little more useful info to 'link_whole' documentation, describing the use of /LINKWHOLE with MSVC and the behaviour of re-exporting symbols of individual objects in a static library.

This commit is contained in:
Dan Hawson 2023-06-15 10:50:37 +01:00 committed by Jussi Pakkanen
parent c900e6b0b3
commit 8e879911ec
1 changed files with 4 additions and 2 deletions

View File

@ -123,8 +123,10 @@ kwargs:
type: list[lib | custom_tgt | custom_idx]
since: 0.40.0
description: |
Links all contents of the given static libraries
whether they are used by not, equivalent to the `-Wl,--whole-archive` argument flag of GCC.
Links all contents of the given static libraries whether they are used or
not, equivalent to the `-Wl,--whole-archive` argument flag of GCC, or the
'/WHOLEARCHIVE' MSVC linker option. This allows the linked target to
re-export symbols from all objects in the static libraries.
*(since 0.41.0)* If passed a list that list will be flattened.