You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: csdb/docs/collection-format.html
+10-5Lines changed: 10 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -358,12 +358,12 @@ <h2 id="category-ini">
358
358
The kind (or type) of this code snippet. Valid values are:
359
359
</p>
360
360
<ulclass="unspaced">
361
-
<li><codeclass="value">freeform</code> – a freeform snippet that doesn't conform to any other other supported type.</li>
361
+
<li><codeclass="value">freeform</code><sup><ahref="#footnote-3">3</a></sup> – a freeform snippet that doesn't conform to any other other supported type.</li>
362
362
<li><codeclass="value">routine</code> – a Pascal routine (function or procedure).</li>
363
363
<li><codeclass="value">type</code> – a simple Pascal type definition.</li>
364
364
<li><codeclass="value">const</code> – a Pascal constant definition.</li>
365
365
<li><codeclass="value">class</code> – a Pascal class or advanced record definition and implementation.</li>
366
-
<li><codeclass="value">unit</code> – a complete Pascal unit.</li>
366
+
<li><codeclass="value">unit</code><sup><ahref="#footnote-2">3</a></sup> – a complete Pascal unit.</li>
367
367
</ul>
368
368
<p>
369
369
If <codeclass="key">Kind</code> is not present then its value defaults to <codeclass="value">freeform</code>.
@@ -518,7 +518,7 @@ <h2>
518
518
</dt>
519
519
<dd>
520
520
<p>
521
-
The name of the copyright holder as plain text. Where there are contributors either list them all or append <codeclass="value">and contributors</code><sup><ahref="#footnote-3">3</a></sup> to the primary copyright holder's name. E.g.:
521
+
The name of the copyright holder as plain text. Where there are contributors either list them all or append <codeclass="value">and contributors</code><sup><ahref="#footnote-4">4</a></sup> to the primary copyright holder's name. E.g.:
522
522
</p>
523
523
<ulclass="unspaced">
524
524
<li>
@@ -563,7 +563,7 @@ <h1>
563
563
</p>
564
564
565
565
</p>
566
-
The current major version is v2. Databases before v2.0.0 did not have a <code>VERSION</code> file<sup><ahref="#footnote-4">4</a></sup>.
566
+
The current major version is v2. Databases before v2.0.0 did not have a <code>VERSION</code> file<sup><ahref="#footnote-5">5</a></sup>.
567
567
</p>
568
568
569
569
<p>
@@ -593,10 +593,15 @@ <h1>
593
593
</li>
594
594
<liid="footnote-3">
595
595
<p>
596
-
If "contributors" is specified as part of the <codeclass="key">CopyrightHolder</code>key value in <code>LICENSE-INFO</code>then the <code>CONTRIBUTORS</code> file <spanclass="very-strong">must</span> contain a list of all the contributors.
596
+
Although permitted in the file format, the <codeclass="value">unit</code>and <codeclass="value">freeform</code>values of the <codeclass="key">Kind</code> key are not currently used in the collection.
597
597
</p>
598
598
</li>
599
599
<liid="footnote-4">
600
+
<p>
601
+
If "contributors" is specified as part of the <codeclass="key">CopyrightHolder</code> key value in <code>LICENSE-INFO</code> then the <code>CONTRIBUTORS</code> file <spanclass="very-strong">must</span> contain a list of all the contributors.
602
+
</p>
603
+
</li>
604
+
<liid="footnote-5">
600
605
<p>
601
606
Version tracking was not done before v2.0.0. However it is safe to assume, using <ahref="https://semver.org/">semantic versioning</a>, that the current format is the second major release. This is because all previous database versions were backwards compatible and therefore all belonged to the same major version, which, logically, must have been v1. The fact that this version of the database breaks that backward compatibility means the major version must be bumped.
0 commit comments