Skip to content

Commit a355656

Browse files
authored
Fixes #287 (#346)
1 parent 15895eb commit a355656

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

doxygen/src/pdsc_format.txt

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ The \ref packFormat is structured using grouping elements and contains the follo
6464
- \subpage element_ECCN "<ECCN>": section listing Export Control Classification Numbers (ECCN) for EU and US.
6565
- \subpage element_keywords "<keywords>": lists keywords to search for packages. Can be used for search engines.
6666
- \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.
67-
- \subpage element_repository "<repository>": specifies the URL and repository type of a public repository where the pack originates from.
67+
- \subpage element_repository "<repository>": specifies the HTTPS URL and repository type of a public repository where the pack originates from.
6868
- \subpage element_dominate "<dominate>": the pack contains one or more device, API, or component that overrules other packs with identical items.
6969
- \subpage element_releases "<releases>": lists release versions with descriptions.
7070
- \subpage pdsc_changelogs_pg "<changeLogs>": lists changelog files associated with components and apis within the pack.
@@ -98,8 +98,8 @@ This example of a *.pdsc File explains the sections, particularly how dependenci
9898
/**
9999
\page pdsc_package_pg /package element
100100
The basic package information captures the package vendor, the package name, a brief description of the package, and the schema version.
101-
Additional elements support the logistics of handling packages. The url specifies the origin of the description. It may be left empty if
102-
the pack will not be uploaded onto a web server. A license file might point to license agreements. A list of keywords
101+
Additional elements support the logistics of handling packages. The url (https required) specifies the origin of the description. It may
102+
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
103103
assists searching for packages. An optional environments element can be used to list environment-specific information.
104104

105105
\b Example:
@@ -243,7 +243,8 @@ assists searching for packages. An optional environments element can be used to
243243
\anchor package_url
244244
<tr>
245245
<td>url</td>
246-
<td><a href="https://en.wikipedia.org/wiki/Uniform_resource_locator" target="_blank">HTTP URL</a>
246+
<td><a href="https://en.wikipedia.org/wiki/Uniform_resource_locator" target="_blank">URL</a>
247+
(only <a href="https://en.wikipedia.org/wiki/HTTPS" target="_blank">HTTPS</a> allowed)
247248
or <a href="https://en.wikipedia.org/wiki/File_URI_scheme" target="_blank">file URI</a> location
248249
of the software pack. The URL can be used by installers for downloading,
249250
updating, or checking versions. If left empty, the Pack cannot be updated automatically from a server location.</td>
@@ -253,7 +254,7 @@ assists searching for packages. An optional environments element can be used to
253254
\anchor package_supportContact
254255
<tr>
255256
<td>supportContact</td>
256-
<td>HTTP URL or e-mail address for users to get support for the content of the Pack</td>
257+
<td>HTTPS URL or e-mail address for users to get support for the content of the Pack</td>
257258
<td>xs:string</td>
258259
<td>0..1 </td>
259260
</tr>
@@ -293,7 +294,7 @@ assists searching for packages. An optional environments element can be used to
293294
</tr>
294295
<tr>
295296
<td>\ref element_repository "repository"</td>
296-
<td>URL of a public repository the pack originates from.</td>
297+
<td>HTTPS URL of a public repository the pack originates from.</td>
297298
<td>xs:anyURI</td>
298299
<td>0..1 </td>
299300
</tr>
@@ -622,8 +623,8 @@ Keywords can be exported to web pages to provide information for search engines,
622623
/**************************************************************************************************/
623624
/**
624625
\page element_repository /package/repository element
625-
The element specifies the URL of the public repository the pack originates from. The attribute 'type' specifies the repository technology
626-
and therefore the tools required to be used with this repository.
626+
The element specifies the URL (HTTPS required) of the public repository the pack originates from. The attribute 'type'
627+
specifies the repository technology and therefore the tools required to be used with this repository.
627628

628629

629630
\b Example:
@@ -853,7 +854,7 @@ This list must be strictly ordered by `version`, with the highest release `versi
853854
</tr>
854855
<tr>
855856
<td>url</td>
856-
<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>
857+
<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>
857858
<td>xs:anyURI</td>
858859
<td>optional</td>
859860
</tr>

0 commit comments

Comments
 (0)