Skip to content

Commit b9875da

Browse files
RexJaeschkegoneall
authored andcommitted
Wrap example code in narrower right margin
Signed-off-by: Rex Jaeschke <[email protected]>
1 parent 938d9f1 commit b9875da

8 files changed

+85
-49
lines changed

chapters/SPDX-license-expressions.md

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -163,11 +163,14 @@ A conjunctive license can be expressed in RDF via a `<spdx:ConjunctiveLicenseSet
163163
```text
164164
<spdx:ConjunctiveLicenseSet>
165165
<spdx:member rdf:resource="http://spdx.org/licenses/GPL-2.0-only"/>
166-
<spdx:ExtractedLicensingInfo rdf:about="http://example.org#LicenseRef-EternalSurrender">
166+
<spdx:ExtractedLicensingInfo rdf:about
167+
="http://example.org#LicenseRef-EternalSurrender">
167168
<spdx:extractedText>
168-
In exchange for using this software, you agree to give its author all your worldly possessions.
169-
You will not hold the author liable for all the damage this software will inevitably cause not only
170-
to your person and property, but to the entire fabric of the cosmos.
169+
In exchange for using this software, you agree to give
170+
its author all your worldly possessions. You will not
171+
hold the author liable for all the damage this software
172+
will inevitably cause not only to your person and
173+
property, but to the entire fabric of the cosmos.
171174
</spdx:extractedText>
172175
<spdx:licenseId>LicenseRef-EternalSurrender</spdx:licenseId>
173176
</spdx:ExtractedLicensingInfo>
@@ -180,11 +183,15 @@ A disjunctive license can be expressed in RDF via a `<spdx:DisjunctiveLicenseSet
180183
<spdx:DisjunctiveLicenseSet>
181184
<spdx:member rdf:resource="http://spdx.org/licenses/GPL-2.0-only"/>
182185
<spdx:member>
183-
<spdx:ExtractedLicensingInfo rdf:about="http://example.org#LicenseRef-EternalSurrender">
186+
<spdx:ExtractedLicensingInfo rdf:about
187+
="http://example.org#LicenseRef-EternalSurrender">
184188
<spdx:extractedText>
185-
In exchange for using this software, you agree to give its author all your worldly possessions.
186-
You will not hold the author liable for all the damage this software will inevitably cause
187-
not only to your person and property, but to the entire fabric of the cosmos.
189+
In exchange for using this software, you agree to
190+
give its author all your worldly possessions. You
191+
will not hold the author liable for all the damage
192+
this software will inevitably cause not only to
193+
your person and property, but to the entire fabric
194+
of the cosmos.
188195
</spdx:extractedText>
189196
<spdx:licenseId>LicenseRef-EternalSurrender</spdx:licenseId>
190197
</spdx:ExtractedLicensingInfo>
@@ -202,16 +209,21 @@ A License Exception can be expressed in RDF via a `<spdx:LicenseException>` elem
202209
* `licenseExceptionText` - Full text of the license exception.
203210

204211
```text
205-
<rdf:Description rdf:about="http://example.org#SPDXRef-ButIdDontWantToException">
206-
<rdfs:comment>This exception may be invalid in some jurisdictions.</rdfs:comment>
212+
<rdf:Description rdf:about
213+
="http://example.org#SPDXRef-ButIdDontWantToException">
214+
<rdfs:comment>This exception may be invalid in some
215+
jurisdictions.</rdfs:comment>
207216
<rdfs:seeAlso>http://dilbert.com/strip/1997-01-15</rdfs:seeAlso>
208-
<spdx:example>So this one time, I had a license exception…</spdx:example>
217+
<spdx:example>So this one time, I had a license exception
218+
…</spdx:example>
209219
<spdx:licenseExceptionText>
210-
A user of this software may decline to follow any subset of the terms of this license upon
211-
finding any or all such terms unfavorable.
220+
A user of this software may decline to follow any subset of
221+
the terms of this license upon finding any or all such terms
222+
unfavorable.
212223
</spdx:licenseExceptionText>
213224
<spdx:name>&quot;But I Don&apos;t Want To&quot; Exception</spdx:name>
214225
<spdx:licenseExceptionId>SPDXRef-ButIdDontWantToException</spdx:licenseExceptionId>
215-
<rdf:type rdf:resource="http://spdx.org/rdf/terms#LicenseException"/>
226+
<rdf:type rdf:resource
227+
="http://spdx.org/rdf/terms#LicenseException"/>
216228
</rdf:Description>
217229
```

chapters/annotations.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -172,9 +172,11 @@ EXAMPLE 1 Tag: `AnnotationComment:`
172172
In `tag:value` format multiple lines are delimited by `<text> .. </text>`.
173173

174174
```text
175-
AnnotationComment: <text>All of the licenses seen in the file, are matching what was seen during manual inspection.
176-
There are some terms that can influence the concluded license, and some alternatives may be possible,
177-
but the concluded license is one of the options.</text>
175+
AnnotationComment: <text>All of the licenses seen in the file, are
176+
matching what was seen during manual inspection. There are some
177+
terms that can influence the concluded license, and some
178+
alternatives may be possible, but the concluded license is one of
179+
the options.</text>
178180
```
179181

180182
EXAMPLE 2 RDF: Property `rdfs:comment` in class `spdx:Annotation`

chapters/document-creation-information.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -396,8 +396,9 @@ Here, the intent is to provide recipients of the SPDX document with comments by
396396
EXAMPLE 1 Tag: `CreatorComment:`
397397

398398
```text
399-
CreatorComment: <text>This SPDX document was created by a combination of using a free tool,
400-
as indicated above, and manual analysis by several authors of the code.</text>
399+
CreatorComment: <text>This SPDX document was created by a combination of
400+
using a free tool, as indicated above, and manual analysis by several
401+
authors of the code.</text>
401402
```
402403

403404
EXAMPLE 2 RDF: Property `rdfs:comment` in class `spdx:CreationInfo`
@@ -434,7 +435,8 @@ EXAMPLE 1 Tag: `DocumentComment:`
434435

435436
```text
436437
DocumentComment: <text>This document was created using SPDX 2.0,
437-
version 2.3 of the SPDX License List and refering to licenses in file MyCompany.Approved.Licenses.spdx.</text>
438+
version 2.3 of the SPDX License List and refering to licenses
439+
in file MyCompany.Approved.Licenses.spdx.</text>
438440
```
439441

440442
EXAMPLE 2 RDF: Property `rdfs:comment` in class `SpdxDocument`

chapters/file-information.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -351,8 +351,9 @@ EXAMPLE 1 Tag: `LicenseComments:`
351351
In `tag:value` format multiple lines are delimited by `<text> .. </text>`.
352352

353353
```text
354-
LicenseComments: <text>The concluded license was taken from the package level that the file was included in.
355-
This information was found in the COPYING.txt file in the xyz directory.</text>
354+
LicenseComments: <text>The concluded license was taken from the package
355+
level that the file was included in. This information was found in the
356+
COPYING.txt file in the xyz directory.</text>
356357
```
357358

358359
EXAMPLE 2 RDF: Property `spdx:licenseComments` in class `spdx:File`
@@ -689,8 +690,9 @@ In `tag:value` format multiple lines are delimited by `<text> .. </text>`.
689690

690691
```text
691692
FileAttributionText: <text>
692-
All advertising materials mentioning features or use of this software must display the
693-
following acknowledgement: This product includes software developed by the AT&T.
693+
All advertising materials mentioning features or use of this software
694+
must display the following acknowledgement: This product includes
695+
software developed by the AT&T.
694696
</text>
695697
```
696698

chapters/other-licensing-information-detected.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,10 @@ ExtractedText: <text>This software is licensed under the Beer License.</text>
7777
If indeed full text of license present in File:
7878

7979
```text
80-
ExtractedText: <text>"THE WHISKEY-WARE LICENSE": [email protected] wrote this file. As long as you retain this notice you can do whatever you want with this stuff. If we meet some day, and you think this stuff is worth it, you can buy me a bottle of whiskey in return </text>
80+
ExtractedText: <text>"THE WHISKEY-WARE LICENSE": [email protected]
81+
wrote this file. As long as you retain this notice you can do whatever
82+
you want with this stuff. If we meet some day, and you think this stuff
83+
is worth it, you can buy me a bottle of whiskey in return </text>
8184
```
8285

8386
EXAMPLE 2 RDF: Property `spdx:extractedText` in class `spdx:ExtractedLicensingInfo`
@@ -96,7 +99,11 @@ If indeed full text of license present in File:
9699
```text
97100
<ExtractedLicensingInfo rdf:about="licenseRef-Whiskeyware">
98101
<licenseId>LicenseRef-Whiskeyware</licenseId>
99-
<extractedText>"THE WHISKEY-WARE LICENSE": [email protected] wrote this file. As long as you retain this notice you can do whatever you want with this stuff. If we meet some day, and you think this stuff is worth it, you can buy me a bottle of whiskey in return.</extractedText>
102+
<extractedText>"THE WHISKEY-WARE LICENSE": [email protected]
103+
wrote this file. As long as you retain this notice you can do
104+
whatever you want with this stuff. If we meet some day, and you
105+
think this stuff is worth it, you can buy me a bottle of whiskey
106+
in return.</extractedText>
100107
</ExtractedLicensingInfo>
101108
```
102109

@@ -195,7 +202,8 @@ EXAMPLE 1 Tag: `LicenseComment:`
195202
In `tag:value` format multiple lines are delimited by `<text> .. </text>`.
196203

197204
```text
198-
LicenseComment: <text>The Whiskey-Ware License has a couple of other standard variants.</text>
205+
LicenseComment: <text>The Whiskey-Ware License has a couple
206+
of other standard variants.</text>
199207
```
200208

201209
EXAMPLE 2 RDF: Property `rdfs:comment` in class `spdx:ExtractedLicensingInfo`

chapters/package-information.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1056,8 +1056,9 @@ Here, the intent is to provide the recipient of the SPDX document with a detaile
10561056
EXAMPLE 1 Tag: `PackageLicenseComments:`
10571057

10581058
```text
1059-
PackageLicenseComments: <text>The license for this project changed with the release of version 1.4.
1060-
The version of the project included here post-dates the license change.</text>
1059+
PackageLicenseComments: <text>The license for this project changed with
1060+
the release of version 1.4. The version of the project included here
1061+
post-dates the license change.</text>
10611062
```
10621063

10631064
EXAMPLE 2 RDF: Property `spdx:licenseComments` in class `spdx:Package`
@@ -1185,8 +1186,9 @@ EXAMPLE 1 Tag: `PackageDescription:`
11851186
In `tag:value` format multiple lines are delimited by `<text>...</text>`.
11861187

11871188
```text
1188-
PackageDescription: <text>The GNU C Library defines functions that are specified by the ISO C standard,
1189-
as well as additional features specific to POSIX and other derivatives of the Unix operating system,
1189+
PackageDescription: <text>The GNU C Library defines functions that are
1190+
specified by the ISO C standard, as well as additional features
1191+
specific to POSIX and other derivatives of the Unix operating system,
11901192
and extensions specific to GNU systems.</text>
11911193
```
11921194

@@ -1197,8 +1199,9 @@ EXAMPLE 2 RDF: Property `spdx:description` in class `spdx:Package`
11971199
...
11981200
<description>
11991201
The GNU C Library defines functions that are specified by the
1200-
ISO C standard, as well as additional features specific to POSIX and other
1201-
derivatives of the Unix operating system, and extensions specific to GNU systems.
1202+
ISO C standard, as well as additional features specific to POSIX and
1203+
other derivatives of the Unix operating system, and extensions
1204+
specific to GNU systems.
12021205
</description>
12031206
...
12041207
</Package>
@@ -1229,7 +1232,8 @@ EXAMPLE 1 Tag: `PackageComment:`
12291232
In `tag:value` format multiple lines are delimited by `<text>...</text>`.
12301233

12311234
```text
1232-
PackageComment: <text>The package includes several sub-packages; see Relationship information.</text>
1235+
PackageComment: <text>The package includes several sub-packages; see Relationship
1236+
information.</text>
12331237
```
12341238

12351239
EXAMPLE 2 RDF: Property `rdfs:comment` in class `spdx:Package`
@@ -1340,9 +1344,9 @@ To inform a human consumer why the reference exists, what kind of information, c
13401344
EXAMPLE 1 Tag: `ExternalRefComment:`
13411345

13421346
```text
1343-
ExternalRefComment: <text>NIST National Vulnerability Database (NVD) describes
1344-
security vulnerabilities (CVEs) which affect Vendor Product Version
1345-
acmecorp:acmenator:6.6.6.</text>
1347+
ExternalRefComment: <text>NIST National Vulnerability Database (NVD)
1348+
describes security vulnerabilities (CVEs) which affect Vendor Product
1349+
Version acmecorp:acmenator:6.6.6.</text>
13461350
```
13471351

13481352
EXAMPLE 2 RDF: Property `rdfs:comment` in class `spdx:ExternalRef`
@@ -1395,8 +1399,9 @@ In `tag:value` format multiple lines are delimited by `<text> .. </text>`.
13951399

13961400
```text
13971401
PackageAttributionText: <text>
1398-
All advertising materials mentioning features or use of this software must display the
1399-
following acknowledgement: This product includes software developed by the AT&T.
1402+
All advertising materials mentioning features or use of this software
1403+
must display the following acknowledgement: This product includes
1404+
software developed by the AT&T.
14001405
</text>
14011406
```
14021407

chapters/review-information-deprecated.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,9 @@ EXAMPLE 1 Tag: `ReviewComment:`
9999
In `tag:value` format multiple lines are delimited by `<text> .. </text>`.
100100

101101
```text
102-
ReviewComment: <text>All of the licenses seen in the file, are matching what was seen during manual inspection.
103-
There are some terms that can influence the concluded license, and some alternatives may be possible,
102+
ReviewComment: <text>All of the licenses seen in the file, are matching
103+
what was seen during manual inspection. There are some terms that can
104+
influence the concluded license, and some alternatives may be possible,
104105
but the concluded license is one of the options.</text>
105106
```
106107

chapters/snippet-information.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,8 @@ EXAMPLE 2 RDF: Property `spdx:licenseConcluded` in class `spdx:Snippet`
283283
<Snippet rdf:about="...">
284284
<licenseConcluded>
285285
<DisjunctiveLicenseSet>
286-
<member rdf:resource="http://spdx.org/licenses/LGPL-2.0-only"/>
286+
<member rdf:resource
287+
="http://spdx.org/licenses/LGPL-2.0-only"/>
287288
<member rdf:resource="#LicenseRef-2"/>
288289
</DisjunctiveLicenseSet>
289290
</licenseConcluded>
@@ -380,9 +381,9 @@ EXAMPLE 2 RDF: Property `spdx:licenseComments` in class `spdx:Snippet`
380381
<Snippet rdf:about="...">
381382
...
382383
<licenseComments>
383-
The concluded license was taken from package xyz, from which the snippet
384-
was copied into the current file. The concluded license information was found
385-
in the COPYING.txt file in package xyz.
384+
The concluded license was taken from package xyz, from which the
385+
snippet was copied into the current file. The concluded license
386+
information was found in the COPYING.txt file in package xyz.
386387
</licenseComments>
387388
...
388389
</Snippet>
@@ -461,8 +462,10 @@ EXAMPLE 1 Tag: `SnippetComment:`
461462
In `tag:value` format multiple lines are delimited by `<text> .. </text>`.
462463

463464
```text
464-
SnippetComment: <text>This snippet was identified as significant and highlighted in this Apache-2.0 file,
465-
when a commercial scanner identified it as being derived from file foo.c in package xyz which is licensed under GPL-2.0.</text>
465+
SnippetComment: <text>This snippet was identified as significant and
466+
highlighted in this Apache-2.0 file, when a commercial scanner
467+
identified it as being derived from file foo.c in package xyz which
468+
is licensed under GPL-2.0.</text>
466469
```
467470

468471
EXAMPLE 2 RDF: Property `rdfs:comment` in class `spdx:Snippet`
@@ -540,8 +543,9 @@ In `tag:value` format multiple lines are delimited by `<text> .. </text>`.
540543

541544
```text
542545
SnippetAttributionText: <text>
543-
All advertising materials mentioning features or use of this software must display the
544-
following acknowledgement: This product includes software developed by the AT&T.
546+
All advertising materials mentioning features or use of this software
547+
must display the following acknowledgement: This product includes
548+
software developed by the AT&T.
545549
</text>
546550
```
547551

0 commit comments

Comments
 (0)