Merge pull request #744 from billhollings/master
Small documentation updates
diff --git a/Common/MVKOSExtensions.mm b/Common/MVKOSExtensions.mm
index 39ef03b..43bc3c7 100644
--- a/Common/MVKOSExtensions.mm
+++ b/Common/MVKOSExtensions.mm
@@ -77,7 +77,7 @@
string mvkGetEnvVar(string varName, bool* pWasFound) {
@autoreleasepool {
- NSDictionary*nsEnv = [[NSProcessInfo processInfo] environment];
+ NSDictionary* nsEnv = [[NSProcessInfo processInfo] environment];
NSString* envStr = nsEnv[@(varName.c_str())];
if (pWasFound) { *pWasFound = envStr != nil; }
return envStr ? envStr.UTF8String : "";
diff --git a/Docs/MoltenVK_Runtime_UserGuide.md b/Docs/MoltenVK_Runtime_UserGuide.md
index 9bd6595..fda196e 100644
--- a/Docs/MoltenVK_Runtime_UserGuide.md
+++ b/Docs/MoltenVK_Runtime_UserGuide.md
@@ -106,6 +106,11 @@
*static library*, or *dynamic library*, by following the steps in this section. If you are unsure
about which linking and deployment option you need, follow the steps for installing a
*static framework*, as it is the simplest to install.
+
+>**_Note:_** Distributing an app containing a dynamic library via the *iOS App Store* can require
+specialized bundling. Unless you have specific needs for dynamic libraries, the recommended
+approach on *iOS* is to link **MoltenVK** to your app as a static library.
+
1. Open your application in *Xcode* and select your application's target in the
*Project Navigator* panel.
@@ -168,7 +173,6 @@
- `UIKit.framework` (*iOS*)
- `IOSurface.framework` (*macOS*, or *iOS* if `IPHONEOS_DEPLOYMENT_TARGET` is at least `iOS 11.0`)
-
6. If installing **MoltenVK** as a *dynamic library* in your application, arrange to install
the `libMoltenVK.dylib` file in your application environment:
diff --git a/Docs/Whats_New.md b/Docs/Whats_New.md
index 87a421c..d965cff 100644
--- a/Docs/Whats_New.md
+++ b/Docs/Whats_New.md
@@ -13,6 +13,17 @@
+
+MoltenVK 1.0.38
+---------------
+
+Released TBD
+
+- Clarify static linking as the recommended linking approach for *iOS* app store distribution.
+- Add request for feedback from people who reject **MoltenVK** to `README.md` document.
+
+
+
MoltenVK 1.0.37
---------------
diff --git a/MoltenVK/MoltenVK/API/vk_mvk_moltenvk.h b/MoltenVK/MoltenVK/API/vk_mvk_moltenvk.h
index 3b5af92..06fbc12 100644
--- a/MoltenVK/MoltenVK/API/vk_mvk_moltenvk.h
+++ b/MoltenVK/MoltenVK/API/vk_mvk_moltenvk.h
@@ -50,7 +50,7 @@
*/
#define MVK_VERSION_MAJOR 1
#define MVK_VERSION_MINOR 0
-#define MVK_VERSION_PATCH 37
+#define MVK_VERSION_PATCH 38
#define MVK_MAKE_VERSION(major, minor, patch) (((major) * 10000) + ((minor) * 100) + (patch))
#define MVK_VERSION MVK_MAKE_VERSION(MVK_VERSION_MAJOR, MVK_VERSION_MINOR, MVK_VERSION_PATCH)
@@ -110,6 +110,7 @@
* 2: Log the name of each Vulkan call when the call is entered and exited. This effectively
* brackets any other logging activity within the scope of the Vulkan call.
* 3: Same as option 2, plus logs the time spent inside the Vulkan function.
+ * If none of these is set, no Vulkan call logging will occur.
*
* 3. Setting the MVK_CONFIG_FORCE_LOW_POWER_GPU runtime environment variable or MoltenVK compile-time
* build setting to 1 will force MoltenVK to use a low-power GPU, if one is availble on the device.
diff --git a/README.md b/README.md
index ab05ba1..6440624 100644
--- a/README.md
+++ b/README.md
@@ -287,10 +287,15 @@
- If you encounter an issue with the behaviour of **MoltenVK**, you can report it in the
[*MoltenVK Issues List*](https://github.com/KhronosGroup/MoltenVK/issues).
-
+
- If you encounter an issue with the *Vulkan SDK*, including the *Validation Layers*, you can report it in the
[*Vulkan SDK Issues List*](https://vulkan.lunarg.com/issue/home).
+- If you explore **MoltenVK** and determine that it does not meet your requirements at this time, we would appreciate
+ hearing why that is so, on the [*MoltenVK Issues List*](https://github.com/KhronosGroup/MoltenVK/issues).
+ The goal of **MoltenVK** is to increase the value of *Vulkan* as a true cross-platform ecosystem, by providing
+ *Vulkan* on *Apple* platforms. Hearing why this is currently not working for you will help us in that goal.
+
<a name="contributing"></a>
