Reviewed CMSIS-Pack Indes Files section and updated Publish a Pack section as requested by SDCMSIS-562.

CMSIS/DoxyGen/Pack/src/devices_schema.txt

@@ -585,13 +585,13 @@ Multiple \<device> elements can be defined.
   </tr>
   <tr>
     <td>\ref element_feature "feature"</td>
-    <td>Specify features specific to this device.</td>
+    <td>Specify the features of this device.</td>
     <td>FeatureType</td>
     <td>0..*</td>
   </tr>
   <tr>
     <td>\ref element_feature "environment"</td>
-    <td>???</td>
+    <td>Specify tool options.</td>
     <td>EnvironmentType</td>
     <td>0..*</td>
   </tr>
@@ -633,9 +633,6 @@ Multiple \<device> elements can be defined.
   </tr>
 </table>
 
-\todo environment element
-
-
 \delim
 
 \section element_algorithm /package/devices/family/.../algorithm
@@ -1500,7 +1497,7 @@ all processors, no processor must be specified in \elem{Pname}.
   </tr>
   <tr>
     <td>Punits</td>
-    <td>Specifies the number of processor units in a symmetric multi-processor core (MPCore). Defaults to singel-core CPU (\token{1}) when left empty.</td>
+    <td>Specifies the number of processor units in a symmetric multi-processor core (MPCore). Defaults to single-core CPU (\token{1}) when left empty.</td>
     <td>InstancesType</td>
     <td>optional</td>
   </tr>
@@ -4408,28 +4405,91 @@ Defines a device variant. The element is optional. Can exist multiple times.
     <th>Type</th>
     <th>Occurrence</th>
   </tr>
+  <tr>
+    <td>\ref element_processor "processor"</td>
+    <td>Specify processors that are specific to this device.</td>
+    <td>ProcessorType</td>
+    <td>0..*</td>
+  </tr>
+  <tr>
+    <td>\ref element_debugconfig "debugconfig"</td>
+    <td>Specify default settings for the debug connection specific to this device.</td>
+    <td>DebugConfigType</td>
+    <td>0..1</td>
+  </tr>
+  <tr>
+    <td>\ref element_compile "compile"</td>
+    <td>Specify compile or translate options specific to this device.</td>
+    <td>CompileType</td>
+    <td>0..*</td>
+  </tr>
+  <tr>
+    <td>\ref element_memory "memory"</td>
+    <td>Specify memory areas that specific to this device.</td>
+    <td>MemoryType</td>
+    <td>0..*</td>
+  </tr>
+  <tr>
+    <td>\ref element_algorithm "algorithm"</td>
+    <td>Specify Flash programming algorithms that can be used by this device.</td>
+    <td>AlgorithmType</td>
+    <td>0..*</td>
+  </tr>
   <tr>
     <td>\ref element_book "book"</td>
-    <td>List books that are specific to this variant.</td>
+    <td>Specify documents specific to this device.</td>
     <td>BookType</td>
     <td>0..*</td>
   </tr>
   <tr>
     <td>\ref element_description "description"</td>
-    <td>Device description.</td>
+    <td>Description specific to this device.</td>
     <td>DescriptionType</td>
     <td>0..*</td>
   </tr>
   <tr>
     <td>\ref element_feature "feature"</td>
-    <td>Define features for this device variant.</td>
+    <td>Specify the features of this device.</td>
     <td>FeatureType</td>
     <td>0..*</td>
   </tr>
+  <tr>
+    <td>\ref element_feature "environment"</td>
+    <td>Specify tool options.</td>
+    <td>EnvironmentType</td>
+    <td>0..*</td>
+  </tr>
+  <tr>
+    <td>\ref element_debugport "debugport"</td>
+    <td>Describe a debug port specific to this device.</td>
+    <td>DebugPortType</td>
+    <td>0..*</td>
+  </tr>
+  <tr>
+    <td>\ref element_debug "debug"</td>
+    <td>Specify debug options specific to this device.</td>
+    <td>DebugType</td>
+    <td>0..*</td>
+  </tr>
+  <tr>
+    <td>\ref element_trace "trace"</td>
+    <td>Specify trace options specific to this device.</td>
+    <td>TraceType</td>
+    <td>0..*</td>
+  </tr>
+  <tr>
+    <td>\ref element_debugvars "debugvars"</td>
+    <td>Define debug access variables for user-defined settings specific to this device.</td>
+    <td>DebugVarsType</td>
+    <td>0..1</td>
+  </tr>
+  <tr>
+    <td>\ref element_sequences "sequences"</td>
+    <td>Describe debug access sequences specific to this device.</td>
+    <td>SequencesType</td>
+    <td>0..1</td>
+  </tr>
 </table>
 
-\todo add all elements that belong to DevicePropertiesGroup.
-
 \delim
-
 */

CMSIS/DoxyGen/Pack/src/pack_index.txt

@@ -2,26 +2,25 @@
 /**
 \page packIndexFile CMSIS-Pack Index Files
 
-CMSIS-Pack is designed as a web-based distribution  network. Each provider of a CMSIS-Pack
-(also referred to as vendor) is responsible for hosting, maintaining and publishing unique versions of a CMSIS-Pack.
+CMSIS-Pack is designed as a web-based distribution network. Each provider of a CMSIS-Pack (also referred to as \a vendor) is
+responsible for hosting, maintaining and publishing unique versions of a CMSIS-Pack.
 
-A CMSIS-Pack is uniquely identified by
-\<vendor\>.\<pack name\>.\<version\>.pack
-All published versions of a pack and the unversioned pdsc file need to be colocated in the same web folder specified by
-\<url\>. Multiple different packs may be located in the same web folder.
+A CMSIS-Pack is uniquely identified by \<vendor\>.\<pack name\>.\<version\>.pack. All published versions of a pack and the
+PDSC file need to be available in the same web folder specified by \<url\>. Multiple different packs may be located in the
+same web folder.
 
 
-\section pidxFile The Package Index File (pidx)
+\section pidxFile Package Index File (pidx)
 
-The package index file lists all CMSIS-Packs hosted and maintained by a vendor. The file is hosted by the vendor
-and has the name \<vendor\>.pidx. The \<vendor\> tag needs to match the file name. The file also contains the 
-\<url\> to it's origin as well as a \<timestamp\> of it's last update. 
+The package index file lists all CMSIS-Packs hosted and maintained by a vendor. The file is hosted by the vendor and has the
+name \<vendor\>.pidx. The \<vendor\> tag needs to match the file name. The file also contains the \<url\> to it's origin, as
+well as a \<timestamp\> of it's last update.
 
 It is the vendor's obligation to update this file whenever:
-- a new pack is added 
-- a new version of a pack is added
-- a pack is deprecated
-- a replacement for a pack becomes available
+- a new pack is added.
+- a new version of a pack is added.
+- a pack is deprecated.
+- a replacement for a pack becomes available.
 
 \b Example MyVendor.pidx:
 \code
@@ -39,29 +38,26 @@ It is the vendor's obligation to update this file whenever:
 </index>
 \endcode
 
-The individual pack's are referenced by the attributes:
-- url= web folder where the pack's pdsc and packs reside
-- vendor= vendor of the pack
-- name= the name of the pack
-- version = the version number of the latest available release for the pack
+Each individual pack is referenced by the attributes:
+- \c url = web folder where the PDSC and packs reside.
+- \c vendor = vendor of the pack.
+- \c name = the name of the pack.
+- \c version = the version number of the latest available release for the pack.
 
 The package index file for the CMSIS-Pack compliant packs, hosted on www.keil.com can be found here:
-http://www.keil.com/pack/Keil.pidx
+<a href="http://www.keil.com/pack/Keil.pidx">www.keil.com/pack/Keil.pidx</a>
 
-The benefit of a single vendor index file is, that this file only needs to be exchanged once and can be
-polled for any updates and additions of packs by a vendor.
-A vendor needs to send an email to CMSIS@arm.com attaching a version of the \<vendor\>.pidx file to
-register the file.
+The benefit of a single package index file is, that this file only needs to be exchanged once and can be polled for updates
+and additions of packs by a vendor. To add a vendor's packs to the public list maintained on www.keil.com, send an email to
+<a href="mailto:CMSIS@arm.com">CMSIS@arm.com</a> attaching a version of the \<vendor\>.pidx file.
 
 
-
-\section vidxFile The Vendor Index File (vidx)
-The vendor index file lists package index files from different vendors. This information can be used
-to compile a list of known packs.
+\section vidxFile Vendor Index File (vidx)
+A vendor index file lists package index files from different vendors. This information can be used to compile a list of known
+packs.
 
 \b Example MyVendor.vidx:
 \code
-
 <?xml version="1.0" encoding="UTF-8" ?>
 
 <index schemaVersion="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="PackIndex.xsd">
@@ -78,22 +74,21 @@ to compile a list of known packs.
     ...
     </pindex>
 </index>
-
 \endcode
 
 The latest index file of CMSIS-Packs belonging to vendor="ARM" and vendor="Keil" that are hosted on www.keil.com/pack 
-is maintained here: http://www.keil.com/pack/Keil.pidx
+is maintained here: <a href="http://www.keil.com/pack/Keil.pidx">www.keil.com/pack/Keil.pidx</a>
 
 ARM also maintains a flat list of all CMSIS-Pack compliant packs reported to ARM here:
-http://www.keil.com/pack/index.pidx. 
-The vendor index file containing references to the vendor package index file (or optionally pdsc files) used 
-for compiling this summary index file are listed in the Keil.vidx file and can be downloaded from here:
-http://www.keil.com/pack/Keil.vidx
+<a href="http://www.keil.com/pack/index.pidx">www.keil.com/pack/index.pidx</a>
 
-Based on these publically available index files everyone is equally positioned to create an index of available
-packs and their latest versions.
+The vendor index file containing references to the package index files (or optionally PDSC files) used for compiling this
+summary index file are listed in the Keil.vidx file and can be downloaded from here:
+<a href="http://www.keil.com/pack/Keil.vidx">www.keil.com/pack/Keil.vidx</a>
+
+Based on these publicly available index files, everyone is equally positioned to create an index of available packs and their
+latest versions.
 
 \section packIndexSchema CMSIS-Pack Index Schema File
 \verbinclude "PackIndex.xsd"
-
 */

CMSIS/DoxyGen/Pack/src/pack_publish.txt

@@ -1,14 +1,14 @@
 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
 /**
 \page createPackPublish Publish a Pack
-There are multiple ways to distribute a Software Pack:
+There are multiple ways to distribute a software pack:
 
 \section cp_LocalInstallation Local Installation
-The easiest way to distribute a Software Pack is attaching it to an email or using other means of electronic distribution
-(for example using a company internal file server). The installation of a Software Pack is usually triggered by
-double-clicking the PACK file. The Pack management tool is invoked and the Pack is installed on the local machine. After
-installation, the Pack will be shown in the list of installed Packs (tool dependent). If the PDSC file does not contain a
-valid \c \<url\> element, a manual installation is required to update a Software Pack. Otherwise, Pack management tools can
+The easiest way to distribute a software pack is attaching it to an email or using other means of electronic distribution
+(for example using a company internal file server). The installation of a software pack is usually triggered by
+double-clicking the PACK file. The pack management tool is invoked and the Pack is installed on the local machine. After
+installation, the pack will be shown in the list of installed packs (tool dependent). If the PDSC file does not contain a
+valid \c \<url\> element, a manual installation is required to update a software pack. Otherwise, pack management tools can
 check for updates on the server or the local machine that is specified by \c \<url\>.
 
 \image html LocalInstallation.png "Local installation and update from URL"
@@ -19,45 +19,45 @@ check for updates on the server or the local machine that is specified by \c \<u
 
 \section cp_WebDownload Web Download
 
-Any web server can be used to host a Software Pack (specified by the \c \<url\> element in the PDSC file). At this location,
-at least two files need to be present (refer to \ref PackFilenames):
--# \elem{vendor}.\elem{name}.pdsc
--# \elem{vendor}.\elem{name}.\elem{version}.pack, where \elem{version} refers to the latest version specified in the PDSC file.
+Any web server can be used to host a software pack (specified by the \c \<url\> element in the PDSC file). At this location,
+the following files can be present:
+-# \elem{vendor}.\elem{name}.pdsc [required]: pack description file.
+-# \elem{vendor}.\elem{name}.\elem{version}.pack [required]: pack file where \elem{version} refers to the latest version
+   specified in the PDSC file.
+-# \elem{vendor}.pidx [optional]: list with all packs hosted and maintained by the vendor (refer to \ref pidxFile)
+-# \elem{vendor}.vidx [optional]: list of package index files known to the vendor (refer to \ref vidxFile)
 
 All previous versions listed in the \elem{releases} section of the PDSC file should be present in that folder as well. This
-will enable customers to revert updates or to be able to download a specific version of a Software Pack (for code
+will enable customers to revert updates or to be able to download a specific version of a software pack (for code
 maintenance purposes for example).
 
-Depending on the Pack management tool, a Pack Index Server might be in place that gathers information about published Packs
-in an index file. This information is then used in the management tool to retrieve version information and to trigger
-updates of Packs within the development environment.
- 
+\image html WebInstallation.png "Web installation and update"
+
 \note
 - It is important to understand how the \<url\> element works. If you specify a URL, for example
-  <a href="http://www.keil.com/pack/" target="_blank">http://www.keil.com/pack</a>,
+  <a href="http://www.keil.com/pack/" target="_blank">www.keil.com/pack</a>,
   then you have to make the PDSC file and the corresponding PACK file(s) available for download at that exact location.
   The naming of the files follow the standard naming rules. For example, the ARM::CMSIS PDSC and Pack files are available
   here:\n
-  <a href="http://www.keil.com/pack/ARM.CMSIS.pdsc" target="_blank">http://www.keil.com/pack/ARM.CMSIS.pdsc</a> and \n
-  <a href="http://www.keil.com/pack/ARM.CMSIS.4.3.0.pack" target="_blank">http://www.keil.com/pack/ARM.CMSIS.4.3.0.pack</a> and \n
-  <a href="http://www.keil.com/pack/ARM.CMSIS.4.2.0.pack" target="_blank">http://www.keil.com/pack/ARM.CMSIS.4.2.0.pack</a> and ... \n
+  <a href="http://www.keil.com/pack/ARM.CMSIS.pdsc" target="_blank">www.keil.com/pack/ARM.CMSIS.pdsc</a> and \n
+  <a href="http://www.keil.com/pack/ARM.CMSIS.5.0.1.pack" target="_blank">www.keil.com/pack/ARM.CMSIS.5.0.1.pack</a> and \n
+  <a href="http://www.keil.com/pack/ARM.CMSIS.5.0.0.pack" target="_blank">www.keil.com/pack/ARM.CMSIS.5.0.0.pack</a> and ... \n
   At the specified location, you need to have one (unversioned) PDSC file and can have multiple versioned PACK files,
   but at least the latest one.
 - If the URL or the PDSC/PACK files become unavailable (temporarily or permanently), users will not be able to retrieve
   updates.
 - Do not replace PDSC/PACK files without updating the version number because the Pack management tools will not recognize
   the update unless the version has been changed.
-- Older PACKs should remain available.
-
-\image html WebInstallation.png "Web installation and update"
+- Older packs should remain available.
 
 
 \section cp_KeilComPack Publishing on www.keil.com/pack
 
-ARM tries to maintain a list of all available Software Packs. If a Software Pack is intended to be on that list, its PDSC
-file needs to be sent to to the following email address: cmsis@arm.com. The PDSC file will be manually XML validated. The
-following content will be processed in order to generate the web site and index file
-(<a class=el href="www.keil.com/pack/index.idx" target="_blank">www.keil.com/pack/index.idx</a>):
+ARM maintains a list of available software packs. If you wish to add your packs to that list, send either your vendor.pidx
+file or your PDSC file to the following email address: <a href="mailto:CMSIS@arm.com">CMSIS@arm.com</a>. The PIDX file will
+be processed and all referenced PDSC files will be validated. The following content will be processed in order to generate
+the web site (<a href="http://www.keil.com/dd2/pack">www.keil.com/dd2/pack</a>) and index file
+(<a href="http://www.keil.com/pack/index.pidx">www.keil.com/pack/index.pidx</a>):
 - Version
 - Release Notes
 - Devices
@@ -65,6 +65,6 @@ following content will be processed in order to generate the web site and index
 - Examples
 - Software Components
 
-Please allow up to seven working days for the process. If the file contains any errors, you will be notified. Otherwise, it
-will be uploaded to <a class=el href="www.keil.com/pack" target="_blank">www.keil.com/pack</a>.
-*/
+Please allow up to seven working days for the process. If the files contain any errors, you will be notified. Otherwise, the
+information is added to the index server.
+*/