Polish newly added docs.
Some general improvements and specific changes to make these documents appear better when hosted [on GitHub Pages](https://google.github.io/iree/GetStarted).
* Use powershell syntax and > to start lines consistently in Windows docs
* Merge Vulkan "troubleshooting" section into earlier steps
* Tweak some phrasing and hyperlink styling
Relates to https://github.com/google/iree/issues/1363
Closes https://github.com/google/iree/pull/1427
COPYBARA_INTEGRATE_REVIEW=https://github.com/google/iree/pull/1427 from ScottTodd:docs-polish 112d139f1f4b072ec780838499e5dd7011629191
PiperOrigin-RevId: 305327559
diff --git a/docs/getting_started_linux_vulkan.md b/docs/getting_started_linux_vulkan.md
index 183904c..506e652 100644
--- a/docs/getting_started_linux_vulkan.md
+++ b/docs/getting_started_linux_vulkan.md
@@ -48,11 +48,12 @@
```shell
# -- CMake --
+$ set VK_LOADER_DEBUG=all
$ cmake --build build/ --target iree_hal_vulkan_dynamic_symbols_test
$ ./build/iree/hal/vulkan/iree_hal_vulkan_dynamic_symbols_test
# -- Bazel --
-$ bazel test iree/hal/vulkan:dynamic_symbols_test
+$ bazel test iree/hal/vulkan:dynamic_symbols_test --test_env=VK_LOADER_DEBUG=all
```
Tests in IREE's HAL "Conformance Test Suite" (CTS) actually exercise the Vulkan
@@ -63,11 +64,12 @@
```shell
# -- CMake --
+$ set VK_LOADER_DEBUG=all
$ cmake --build build/ --target iree_hal_cts_allocator_test
$ ./build/iree/hal/cts/iree_hal_cts_allocator_test
# -- Bazel --
-$ bazel test iree/hal/cts:allocator_test
+$ bazel test iree/hal/cts:allocator_test --test_env=VK_LOADER_DEBUG=all
```
If these tests pass, you can skip down to the next section.
@@ -122,7 +124,6 @@
Build:
```shell
-# -- Bazel --
$ bazel build @vulkan_extensionlayer//:libVkLayer_khronos_timeline_semaphore.so @vulkan_extensionlayer//:VkLayer_khronos_timeline_semaphore_json
```
@@ -130,7 +131,6 @@
path to the built layer:
```shell
-# -- Bazel --
$ VK_LAYER_PATH=$VK_LAYER_PATH:$PWD/bazel-bin/external/vulkan_extensionlayer/
```
@@ -138,7 +138,7 @@
Bazel tests run in a sandbox, which environment variables may be forwarded to
using the `--test_env` flag. A user.bazelrc file supporting each of the steps
-above looks like this (remember to substitute for the {} paths):
+above looks like this (substitute for the `{}` paths):
```
test --test_env="LD_LIBRARY_PATH={PATH_TO_VULKAN_SDK}/x86_64/lib/"
@@ -192,20 +192,6 @@
$ bazel run iree/samples/vulkan:vulkan_inference_gui
```
-## Troubleshooting
-
-If loading Vulkan fails, try running one the test or programs again with
-`VK_LOADER_DEBUG=all` set:
-
-```shell
-# -- CMake --
-$ set VK_LOADER_DEBUG=all
-$ ./build/iree/hal/vulkan/iree_hal_vulkan_dynamic_symbols_test
-
-# -- Bazel --
-$ bazel test iree/hal/vulkan:dynamic_symbols_test --test_env=VK_LOADER_DEBUG=all
-```
-
## What's next?
More documentation coming soon...
