Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions doxygen/src/pdsc_format.txt
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
- \subpage element_ECCN "<ECCN>": section listing Export Control Classification Numbers (ECCN) for EU and US.
- \subpage element_keywords "<keywords>": lists keywords to search for packages. Can be used for search engines.
- \ref element_component_environments "environments": Grouping element for environments information. Each inner \ref element_component_environment "environment" element may be used to provide tool-specific information pertaining to the package as a whole.
- \subpage element_repository "<repository>": specifies the URL and repository type of a public repository where the pack originates from.
- \subpage element_repository "<repository>": specifies the HTTPS URL and repository type of a public repository where the pack originates from.
- \subpage element_dominate "<dominate>": the pack contains one or more device, API, or component that overrules other packs with identical items.
- \subpage element_releases "<releases>": lists release versions with descriptions.
- \subpage pdsc_changelogs_pg "<changeLogs>": lists changelog files associated with components and apis within the pack.
Expand Down Expand Up @@ -98,8 +98,8 @@
/**
\page pdsc_package_pg /package element
The basic package information captures the package vendor, the package name, a brief description of the package, and the schema version.
Additional elements support the logistics of handling packages. The url specifies the origin of the description. It may be left empty if
the pack will not be uploaded onto a web server. A license file might point to license agreements. A list of keywords
Additional elements support the logistics of handling packages. The url (https required) specifies the origin of the description. It may
be left empty if the pack will not be uploaded onto a web server. A license file might point to license agreements. A list of keywords
assists searching for packages. An optional environments element can be used to list environment-specific information.

\b Example:
Expand Down Expand Up @@ -243,7 +243,8 @@
\anchor package_url
<tr>
<td>url</td>
<td><a href="https://en.wikipedia.org/wiki/Uniform_resource_locator" target="_blank">HTTP URL</a>
<td><a href="https://en.wikipedia.org/wiki/Uniform_resource_locator" target="_blank">URL</a>
(only <a href="https://en.wikipedia.org/wiki/HTTPS" target="_blank">HTTPS</a> allowed)
or <a href="https://en.wikipedia.org/wiki/File_URI_scheme" target="_blank">file URI</a> location
of the software pack. The URL can be used by installers for downloading,
updating, or checking versions. If left empty, the Pack cannot be updated automatically from a server location.</td>
Expand All @@ -253,7 +254,7 @@
\anchor package_supportContact
<tr>
<td>supportContact</td>
<td>HTTP URL or e-mail address for users to get support for the content of the Pack</td>
<td>HTTPS URL or e-mail address for users to get support for the content of the Pack</td>
<td>xs:string</td>
<td>0..1 </td>
</tr>
Expand Down Expand Up @@ -293,7 +294,7 @@
</tr>
<tr>
<td>\ref element_repository "repository"</td>
<td>URL of a public repository the pack originates from.</td>
<td>HTTPS URL of a public repository the pack originates from.</td>
<td>xs:anyURI</td>
<td>0..1 </td>
</tr>
Expand Down Expand Up @@ -404,7 +405,7 @@

\anchor VersionType <b>Version Type</b>

CMSIS-Pack version specification is inspired by the <a href="http://semver.org" target="_blank">Semantic Versioning 2.0.0</a>.

Check warning on line 408 in doxygen/src/pdsc_format.txt

View workflow job for this annotation

GitHub Actions / Build main documentation

200 OK
Under this scheme, version numbers and the way they are incremented convey a meaning about the underlying content quality and the significance
of changes from one version to the next. A version consists of 3 mandatory and 2 optional sections:

Expand Down Expand Up @@ -622,8 +623,8 @@
/**************************************************************************************************/
/**
\page element_repository /package/repository element
The element specifies the URL of the public repository the pack originates from. The attribute 'type' specifies the repository technology
and therefore the tools required to be used with this repository.
The element specifies the URL (HTTPS required) of the public repository the pack originates from. The attribute 'type'
specifies the repository technology and therefore the tools required to be used with this repository.


\b Example:
Expand Down Expand Up @@ -853,7 +854,7 @@
</tr>
<tr>
<td>url</td>
<td>URL specifying the location of the pack of the specified version. This can be used to override the default location being \c \<url>/\<vendor>.\<name>.\<version>.pack</td>
<td>HTTPS URL specifying the location of the pack of the specified version. This can be used to override the default location being \c \<url>/\<vendor>.\<name>.\<version>.pack</td>
<td>xs:anyURI</td>
<td>optional</td>
</tr>
Expand Down Expand Up @@ -1287,7 +1288,7 @@
\endcode

\note You \b must \b not use Windows or Linux
<a href="http://en.wikipedia.org/wiki/Filename#Reserved_characters_and_words" target="_blank">reserved characters</a> for

Check warning on line 1291 in doxygen/src/pdsc_format.txt

View workflow job for this annotation

GitHub Actions / Build main documentation

200 OK
\em Cclass, \em Cgroup, and \em Csub names! Some development tools use these names to create a directory structure for the
software components in projects. Reserved characters are:
\verbatim
Expand Down Expand Up @@ -1594,7 +1595,7 @@
\endcode

\note You \b must \b not use Windows or Linux
<a href="http://en.wikipedia.org/wiki/Filename#Reserved_characters_and_words" target="_blank">reserved characters</a> for

Check warning on line 1598 in doxygen/src/pdsc_format.txt

View workflow job for this annotation

GitHub Actions / Build main documentation

200 OK
\em Hclass, \em Hgroup, and \em Hsub names! Reserved characters are:
\verbatim
< (less than)
Expand Down
Loading