From 8e879911ecc3e3934da552d9b936604a00abc144 Mon Sep 17 00:00:00 2001
From: Dan Hawson <18214721+GertyP@users.noreply.github.com>
Date: Thu, 15 Jun 2023 10:50:37 +0100
Subject: [PATCH] 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.

---
 docs/yaml/functions/_build_target_base.yaml | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/docs/yaml/functions/_build_target_base.yaml b/docs/yaml/functions/_build_target_base.yaml
index 79924d840..724b6a4ec 100644
--- a/docs/yaml/functions/_build_target_base.yaml
+++ b/docs/yaml/functions/_build_target_base.yaml
@@ -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.