Skip to content

Commit f9aeb57

Browse files
committed
[Docs] Added a description of the platform and arch path components.
Describe what `<platform>` and `<arch>` mean in the search paths for the `swift-backtrace` binary. rdar://117679284
1 parent 27641cb commit f9aeb57

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/Backtracing.rst

+3-1
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,9 @@ the following locations::
295295
<swift-root>
296296

297297
where ``<swift-root>`` by default is determined from the path to the runtime
298-
library, ``libswiftCore``.
298+
library, ``libswiftCore``, ``<platform>`` is the name Swift gives to the platform
299+
(in this case most likely ``linux``) and ``<arch>`` is the name Swift uses for
300+
the CPU architecture (e.g. ``x86_64``, ``arm64`` and so on).
299301

300302
When the runtime is statically linked with _your_ binary, the runtime will
301303
instead determine ``<swift-root>`` in the above patterns relative to *your

0 commit comments

Comments
 (0)