Skip to content

Commit a0ecd7d

Browse files
author
delphidabbler
committed
Add new footnote explaining unused snippet kinds
Renumbered later footnotes to make space
1 parent dddd1d3 commit a0ecd7d

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

csdb/docs/collection-format.html

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -358,12 +358,12 @@ <h2 id="category-ini">
358358
The kind (or type) of this code snippet. Valid values are:
359359
</p>
360360
<ul class="unspaced">
361-
<li><code class="value">freeform</code> – a freeform snippet that doesn't conform to any other other supported type.</li>
361+
<li><code class="value">freeform</code><sup><a href="#footnote-3">3</a></sup> – a freeform snippet that doesn't conform to any other other supported type.</li>
362362
<li><code class="value">routine</code> – a Pascal routine (function or procedure).</li>
363363
<li><code class="value">type</code> – a simple Pascal type definition.</li>
364364
<li><code class="value">const</code> – a Pascal constant definition.</li>
365365
<li><code class="value">class</code> – a Pascal class or advanced record definition and implementation.</li>
366-
<li><code class="value">unit</code> – a complete Pascal unit.</li>
366+
<li><code class="value">unit</code><sup><a href="#footnote-2">3</a></sup> – a complete Pascal unit.</li>
367367
</ul>
368368
<p>
369369
If <code class="key">Kind</code> is not present then its value defaults to <code class="value">freeform</code>.
@@ -518,7 +518,7 @@ <h2>
518518
</dt>
519519
<dd>
520520
<p>
521-
The name of the copyright holder as plain text. Where there are contributors either list them all or append <code class="value">and contributors</code><sup><a href="#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 <code class="value">and contributors</code><sup><a href="#footnote-4">4</a></sup> to the primary copyright holder's name. E.g.:
522522
</p>
523523
<ul class="unspaced">
524524
<li>
@@ -563,7 +563,7 @@ <h1>
563563
</p>
564564

565565
</p>
566-
The current major version is v2. Databases before v2.0.0 did not have a <code>VERSION</code> file<sup><a href="#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><a href="#footnote-5">5</a></sup>.
567567
</p>
568568

569569
<p>
@@ -593,10 +593,15 @@ <h1>
593593
</li>
594594
<li id="footnote-3">
595595
<p>
596-
If &quot;contributors&quot; is specified as part of the <code class="key">CopyrightHolder</code> key value in <code>LICENSE-INFO</code> then the <code>CONTRIBUTORS</code> file <span class="very-strong">must</span> contain a list of all the contributors.
596+
Although permitted in the file format, the <code class="value">unit</code> and <code class="value">freeform</code> values of the <code class="key">Kind</code> key are not currently used in the collection.
597597
</p>
598598
</li>
599599
<li id="footnote-4">
600+
<p>
601+
If &quot;contributors&quot; is specified as part of the <code class="key">CopyrightHolder</code> key value in <code>LICENSE-INFO</code> then the <code>CONTRIBUTORS</code> file <span class="very-strong">must</span> contain a list of all the contributors.
602+
</p>
603+
</li>
604+
<li id="footnote-5">
600605
<p>
601606
Version tracking was not done before v2.0.0. However it is safe to assume, using <a href="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.
602607
</p>

0 commit comments

Comments
 (0)