Add doc for new-to-WiX v5 default major upgrade.

wixtoolset · Dec 31, 2023 · e93d1df · e93d1df
1 parent 1eb6867
commit e93d1df
Showing 1 changed file with 42 additions and 1 deletion.
diff --git a/src/xsd4/wix.xsd b/src/xsd4/wix.xsd
@@ -2377,7 +2377,17 @@
       </xs:attribute>
       <xs:attribute name="UpgradeCode" type="Guid">
         <xs:annotation>
-          <xs:documentation>The upgrade code GUID for the product. Sets the UpgradeCode property.</xs:documentation>
+          <xs:documentation>The upgrade code GUID for the package. Sets the UpgradeCode property.</xs:documentation>
+        </xs:annotation>
+      </xs:attribute>
+      <xs:attribute name="UpgradeStrategy" type="UpgradeStrategyTypeUnion">
+        <xs:annotation>
+          <xs:documentation>
+          The upgrade strategy for the package. If "none," no major upgrade is expected. 
+          If "majorUpgrade," the UpgradeCode attribute is required and a major upgrade is expected.
+          A default major upgrade is automatically provided if none is authored.
+          _New in WiX v5: WiX v5 adds this attribute to the `Package` element._
+          </xs:documentation>
         </xs:annotation>
       </xs:attribute>
       <xs:attribute name="Version" type="xs:string" use="required">
@@ -13846,6 +13856,37 @@
       </xs:enumeration>
     </xs:restriction>
   </xs:simpleType>
+  <xs:simpleType name="UpgradeStrategyTypeUnion">
+    <xs:annotation>
+      <xs:documentation>Use this attribute to specify the upgrade strategy of this package: major upgrade or none.</xs:documentation>
+    </xs:annotation>
+    <xs:union memberTypes="UpgradeStrategyType PreprocessorVariables"/>
+  </xs:simpleType>
+  <xs:simpleType name="UpgradeStrategyType">
+    <xs:annotation>
+      <xs:documentation>Use this attribute to specify the installation scope of this package: major upgrade or none.</xs:documentation>
+    </xs:annotation>
+    <xs:restriction base="xs:NMTOKEN">
+      <xs:enumeration value="majorUpgrade">
+        <xs:annotation>
+          <xs:documentation>
+            Set this value to declare that the package will be upgraded via major upgrades.
+            You can author a major upgrade with your preferred options or a default major
+            upgrade will be provided if you don't. The UpgradeCode attribute is required.
+          </xs:documentation>
+        </xs:annotation>
+      </xs:enumeration>
+      <xs:enumeration value="none">
+        <xs:annotation>
+          <xs:documentation>
+            Set this value to declare that the package will not support major upgrades.
+            This value is _not_ recommended because it means a product cannot be serviced
+            in the event of major bug or security vulnerability.
+          </xs:documentation>
+        </xs:annotation>
+      </xs:enumeration>
+    </xs:restriction>
+  </xs:simpleType>
   <xs:simpleType name="YesNoTypeUnion">
     <xs:annotation>
       <xs:documentation>Values of this type will either be "yes"/"true" or "no"/"false".</xs:documentation>