Browse Source

Merge pull request #109577 from AdriaandeJongh/clarify-build-version

[Docs] Mention 'build version' in iOS, macOS, and visionOS export docs
Thaddeus Crews 2 months ago
parent
commit
a02ff4402e

+ 4 - 2
platform/ios/doc_classes/EditorExportPlatformIOS.xml

@@ -64,7 +64,8 @@
 			Can be overridden with the environment variable [code]GODOT_APPLE_PLATFORM_PROVISIONING_PROFILE_UUID_RELEASE[/code].
 			Can be overridden with the environment variable [code]GODOT_APPLE_PLATFORM_PROVISIONING_PROFILE_UUID_RELEASE[/code].
 		</member>
 		</member>
 		<member name="application/short_version" type="String" setter="" getter="">
 		<member name="application/short_version" type="String" setter="" getter="">
-			Application version visible to the user, can only contain numeric characters ([code]0-9[/code]) and periods ([code].[/code]). Falls back to [member ProjectSettings.application/config/version] if left empty.
+			Application version visible to the user. Can only contain numeric characters ([code]0-9[/code]) and periods ([code].[/code]). Falls back to [member ProjectSettings.application/config/version] if left empty.
+			[b]Note:[/b] This value is used for the [i]Identity &gt; Version[/i] value in the generated Xcode project.
 		</member>
 		</member>
 		<member name="application/signature" type="String" setter="" getter="">
 		<member name="application/signature" type="String" setter="" getter="">
 			A four-character creator code that is specific to the bundle. Optional.
 			A four-character creator code that is specific to the bundle. Optional.
@@ -73,7 +74,8 @@
 			Supported device family.
 			Supported device family.
 		</member>
 		</member>
 		<member name="application/version" type="String" setter="" getter="">
 		<member name="application/version" type="String" setter="" getter="">
-			Machine-readable application version, in the [code]major.minor.patch[/code] format, can only contain numeric characters ([code]0-9[/code]) and periods ([code].[/code]). This must be incremented on every new release pushed to the App Store.
+			Machine-readable application version in the [code]major.minor.patch[/code] format. Can only contain numeric characters ([code]0-9[/code]) and periods ([code].[/code]). This must be incremented with every new release pushed to the App Store. Falls back to [member ProjectSettings.application/config/version] if left empty.
+			[b]Note:[/b] This value is used for the [i]Identity &gt; Build[/i] value in the generated Xcode project.
 		</member>
 		</member>
 		<member name="architectures/arm64" type="bool" setter="" getter="">
 		<member name="architectures/arm64" type="bool" setter="" getter="">
 			If [code]true[/code], [code]arm64[/code] binaries are included into exported project.
 			If [code]true[/code], [code]arm64[/code] binaries are included into exported project.

+ 4 - 2
platform/macos/doc_classes/EditorExportPlatformMacOS.xml

@@ -45,13 +45,15 @@
 			Minimum version of macOS required for this application to run on Intel Macs, in the [code]major.minor.patch[/code] or [code]major.minor[/code] format, can only contain numeric characters ([code]0-9[/code]) and periods ([code].[/code]).
 			Minimum version of macOS required for this application to run on Intel Macs, in the [code]major.minor.patch[/code] or [code]major.minor[/code] format, can only contain numeric characters ([code]0-9[/code]) and periods ([code].[/code]).
 		</member>
 		</member>
 		<member name="application/short_version" type="String" setter="" getter="">
 		<member name="application/short_version" type="String" setter="" getter="">
-			Application version visible to the user, can only contain numeric characters ([code]0-9[/code]) and periods ([code].[/code]). Falls back to [member ProjectSettings.application/config/version] if left empty.
+			Application version visible to the user. Can only contain numeric characters ([code]0-9[/code]) and periods ([code].[/code]). Falls back to [member ProjectSettings.application/config/version] if left empty.
+			[b]Note:[/b] This value is used for the [i]Identity &gt; Version[/i] value in the generated Xcode project.
 		</member>
 		</member>
 		<member name="application/signature" type="String" setter="" getter="">
 		<member name="application/signature" type="String" setter="" getter="">
 			A four-character creator code that is specific to the bundle. Optional.
 			A four-character creator code that is specific to the bundle. Optional.
 		</member>
 		</member>
 		<member name="application/version" type="String" setter="" getter="">
 		<member name="application/version" type="String" setter="" getter="">
-			Machine-readable application version, in the [code]major.minor.patch[/code] format, can only contain numeric characters ([code]0-9[/code]) and periods ([code].[/code]). This must be incremented on every new release pushed to the App Store.
+			Machine-readable application version in the [code]major.minor.patch[/code] format. Can only contain numeric characters ([code]0-9[/code]) and periods ([code].[/code]). This must be incremented with every new release pushed to the App Store. Falls back to [member ProjectSettings.application/config/version] if left empty.
+			[b]Note:[/b] This value is used for the [i]Identity &gt; Build[/i] value in the generated Xcode project.
 		</member>
 		</member>
 		<member name="binary_format/architecture" type="String" setter="" getter="">
 		<member name="binary_format/architecture" type="String" setter="" getter="">
 			Application executable architecture.
 			Application executable architecture.

+ 4 - 2
platform/visionos/doc_classes/EditorExportPlatformVisionOS.xml

@@ -63,13 +63,15 @@
 			Can be overridden with the environment variable [code]GODOT_APPLE_PLATFORM_PROVISIONING_PROFILE_UUID_RELEASE[/code].
 			Can be overridden with the environment variable [code]GODOT_APPLE_PLATFORM_PROVISIONING_PROFILE_UUID_RELEASE[/code].
 		</member>
 		</member>
 		<member name="application/short_version" type="String" setter="" getter="">
 		<member name="application/short_version" type="String" setter="" getter="">
-			Application version visible to the user, can only contain numeric characters ([code]0-9[/code]) and periods ([code].[/code]). Falls back to [member ProjectSettings.application/config/version] if left empty.
+			Application version visible to the user. Can only contain numeric characters ([code]0-9[/code]) and periods ([code].[/code]). Falls back to [member ProjectSettings.application/config/version] if left empty.
+			[b]Note:[/b] This value is used for the [i]Identity &gt; Version[/i] value in the generated Xcode project.
 		</member>
 		</member>
 		<member name="application/signature" type="String" setter="" getter="">
 		<member name="application/signature" type="String" setter="" getter="">
 			A four-character creator code that is specific to the bundle. Optional.
 			A four-character creator code that is specific to the bundle. Optional.
 		</member>
 		</member>
 		<member name="application/version" type="String" setter="" getter="">
 		<member name="application/version" type="String" setter="" getter="">
-			Machine-readable application version, in the [code]major.minor.patch[/code] format, can only contain numeric characters ([code]0-9[/code]) and periods ([code].[/code]). This must be incremented on every new release pushed to the App Store.
+			Machine-readable application version in the [code]major.minor.patch[/code] format. Can only contain numeric characters ([code]0-9[/code]) and periods ([code].[/code]). This must be incremented with every new release pushed to the App Store. Falls back to [member ProjectSettings.application/config/version] if left empty.
+			[b]Note:[/b] This value is used for the [i]Identity &gt; Build[/i] value in the generated Xcode project.
 		</member>
 		</member>
 		<member name="architectures/arm64" type="bool" setter="" getter="">
 		<member name="architectures/arm64" type="bool" setter="" getter="">
 			If [code]true[/code], [code]arm64[/code] binaries are included into exported project.
 			If [code]true[/code], [code]arm64[/code] binaries are included into exported project.