[libcxx-commits] [libcxx] [libcxx][docs] Note how to use just built libc++ with per-target runtimes layout (PR #172316)

[David Spickett via libcxx-commits]

https://github.com/DavidSpickett created https://github.com/llvm/llvm-project/pull/172316

Fixes #172024

This is something a lot of people can probably figure out themselves but having this obvious wrong turn in the getting started document isn't a good first impression.

So I've added a note to highlight how to deal with it.

I don't want to go into detail there about the layout itself, but it should be enough that people know to check by listing the contents of the lib/ folder.

>From 8c9a9645de54cbf2a213fbaeb5f7d36f4119af5b Mon Sep 17 00:00:00 2001
From: David Spickett <david.spickett at linaro.org>
Date: Mon, 15 Dec 2025 15:19:15 +0000
Subject: [PATCH] [libcxx][docs] Note how to use just built libc++ with
 per-target runtimes layout

Fixes #172024

This is something a lot of people can probably figure out themselves
but having this obvious wrong turn in the getting started document
isn't a good first impression.

So I've adding a note to highlight how to deal with it.

I don't want to go into detail there about the layout itself, it
should be enough that people know to check by listing the contents
of the lib/ folder.
---
 libcxx/docs/VendorDocumentation.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/libcxx/docs/VendorDocumentation.rst b/libcxx/docs/VendorDocumentation.rst
index 3e4b305707258..fc788178c96e4 100644
--- a/libcxx/docs/VendorDocumentation.rst
+++ b/libcxx/docs/VendorDocumentation.rst
@@ -68,6 +68,11 @@ to override it with custom paths. With Clang, this can be done with:
 The option ``-Wl,-rpath,<install>/lib`` adds a runtime library search path, which causes the system's
 dynamic linker to look for libc++ in ``<install>/lib`` whenever the program is loaded.
 
+.. note::
+  If the runtimes were built using the "per-target runtime directory" layout,
+  they will be in ``<install>/lib/<target-triple>`` instead of ``<install>/lib``.
+  In this case, use the former path for all library paths in the command above
+  (the path to include files does not change).
 
 The Bootstrapping build
 =======================