Skip to content

Commit abc03a5

Browse files
docs: Tweak "compliment" to "complement" (#369)
Correct the spelling of `compliment` & `complimentary` to `complement` & `complementary` respectively. * Compliment = a polite expression of praise or admiration. * Complement = a thing that contributes extra features to something else in such a way as to improve or emphasize its' quality Correct spelling makes for easier translation to other languages. Signed-off-by: Mark Symons <mark.symons@fujitsu.com>
2 parents c6acc8d + 52a4ee2 commit abc03a5

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ The officially supported media type for Protocol Buffer format is `application/x
6868
## Related Work
6969
[SPDX (Software Package Data Exchange)][spdx-url] is a specification that provides low-level details of components, including all files, hashes, authors, and copyrights. SPDX also defines over 300 open source license IDs. CycloneDX builds on top of the work SPDX has accomplished with license IDs, but varies greatly in its approach towards building a software bill of material specification.
7070

71-
[SWID (ISO/IEC 19770-2:2015)][swid-url] is used primarily to identify installed software and is the preferred format of the NVD. SWID tags are used in the National Vulnerability Database to describe vulnerable components. The CycloneDX specification compliments this work as CycloneDX documents can incorporate SWID tags and other high-level SWID metadata and optionally include entire SWID documents. Use of SWID tag ID's are useful in determining if a specific component has known vulnerabilities.
71+
[SWID (ISO/IEC 19770-2:2015)][swid-url] is used primarily to identify installed software and is the preferred format of the NVD. SWID tags are used in the National Vulnerability Database to describe vulnerable components. The CycloneDX specification complements this work as CycloneDX documents can incorporate SWID tags and other high-level SWID metadata and optionally include entire SWID documents. Use of SWID tag ID's are useful in determining if a specific component has known vulnerabilities.
7272

73-
[CPE (Common Platform Enumeration)][cpe-url] is a specification that describes the vendor, name, and version for an application, operating system, or hardware device. CPE identifiers are used in the National Vulnerability Database to describe vulnerable components. The CycloneDX specification compliments this work as CycloneDX documents can easily be used to construct exact CPE identifiers that are useful in determining if a specific component has known vulnerabilities.
73+
[CPE (Common Platform Enumeration)][cpe-url] is a specification that describes the vendor, name, and version for an application, operating system, or hardware device. CPE identifiers are used in the National Vulnerability Database to describe vulnerable components. The CycloneDX specification complements this work as CycloneDX documents can easily be used to construct exact CPE identifiers that are useful in determining if a specific component has known vulnerabilities.
7474

7575
## Copyright & License
7676

schema/bom-1.6.proto

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ enum ExternalReferenceType {
264264
EXTERNAL_REFERENCE_TYPE_CODIFIED_INFRASTRUCTURE = 31;
265265
// A model card describes the intended uses of a machine learning model, potential limitations, biases, ethical considerations, training parameters, datasets used to train the model, performance metrics, and other relevant data useful for ML transparency.
266266
EXTERNAL_REFERENCE_TYPE_MODEL_CARD = 32;
267-
// Plans of Action and Milestones (POAM) compliment an "attestation" external reference. POAM is defined by NIST as a "document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones".
267+
// Plans of Action and Milestones (POAM) complement an "attestation" external reference. POAM is defined by NIST as a "document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones".
268268
EXTERNAL_REFERENCE_TYPE_POAM = 33;
269269
// A record of events that occurred in a computer system or application, such as problems, errors, or information on current operations.
270270
EXTERNAL_REFERENCE_TYPE_LOG = 34;
@@ -536,7 +536,7 @@ message Pedigree {
536536
repeated Component variants = 3;
537537
// A list of zero or more commits which provide a trail describing how the component deviates from an ancestor, descendant, or variant.
538538
repeated Commit commits = 4;
539-
// A list of zero or more patches describing how the component deviates from an ancestor, descendant, or variant. Patches may be complimentary to commits or may be used in place of commits.
539+
// A list of zero or more patches describing how the component deviates from an ancestor, descendant, or variant. Patches may be complementary to commits or may be used in place of commits.
540540
repeated Patch patches = 5;
541541
// Notes, observations, and other non-structured commentary describing the components pedigree.
542542
optional string notes = 6;

schema/bom-1.6.schema.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -985,7 +985,7 @@
985985
"patches": {
986986
"type": "array",
987987
"title": "Patches",
988-
"description": ">A list of zero or more patches describing how the component deviates from an ancestor, descendant, or variant. Patches may be complimentary to commits or may be used in place of commits.",
988+
"description": ">A list of zero or more patches describing how the component deviates from an ancestor, descendant, or variant. Patches may be complementary to commits or may be used in place of commits.",
989989
"items": {"$ref": "#/definitions/patch"}
990990
},
991991
"notes": {
@@ -1728,7 +1728,7 @@
17281728
"certification-report": "Industry, regulatory, or other certification from an accredited (if applicable) certification body.",
17291729
"codified-infrastructure": "Code or configuration that defines and provisions virtualized infrastructure, commonly referred to as Infrastructure as Code (IaC).",
17301730
"quality-metrics": "Report or system in which quality metrics can be obtained.",
1731-
"poam": "Plans of Action and Milestones (POAM) compliment an \"attestation\" external reference. POAM is defined by NIST as a \"document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones\".",
1731+
"poam": "Plans of Action and Milestones (POAM) complement an \"attestation\" external reference. POAM is defined by NIST as a \"document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones\".",
17321732
"electronic-signature": "An e-signature is commonly a scanned representation of a written signature or a stylized script of the persons name.",
17331733
"digital-signature": "A signature that leverages cryptography, typically public/private key pairs, which provides strong authenticity verification.",
17341734
"other": "Use this if no other types accurately describe the purpose of the external reference."

schema/bom-1.6.xsd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1421,7 +1421,7 @@ limitations under the License.
14211421
</xs:enumeration>
14221422
<xs:enumeration value="poam">
14231423
<xs:annotation>
1424-
<xs:documentation>Plans of Action and Milestones (POAM) compliment an "attestation" external reference. POAM is defined by NIST as a "document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones".</xs:documentation>
1424+
<xs:documentation>Plans of Action and Milestones (POAM) complement an "attestation" external reference. POAM is defined by NIST as a "document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones".</xs:documentation>
14251425
</xs:annotation>
14261426
</xs:enumeration>
14271427
<xs:enumeration value="electronic-signature">
@@ -1828,7 +1828,7 @@ limitations under the License.
18281828
<xs:element name="patches" type="bom:patchesType" minOccurs="0" maxOccurs="1">
18291829
<xs:annotation>
18301830
<xs:documentation xml:lang="en">A list of zero or more patches describing how the component
1831-
deviates from an ancestor, descendant, or variant. Patches may be complimentary to commits
1831+
deviates from an ancestor, descendant, or variant. Patches may be complementary to commits
18321832
or may be used in place of commits.</xs:documentation>
18331833
</xs:annotation>
18341834
</xs:element>

0 commit comments

Comments
 (0)