SPDX field Proposal: Optional SPDX author comment field.


Mark Gisi
 

Issue: Not clear how to include SPDX author comments to the consumers of the SPDX file. For example, a SPDX author may like to include a disclaimer, assumptions made, context of the analysis performed and so forth.

 

Proposal: Include an optional field for the SPDX file that enables authors (i.e., producers) of the SPDX file to provide general comments to the consumers of the SPDX file.

 

Suggested Draft:

2.5 SPDX Author Comments

 

2.5.1 Purpose: An optional field for authors of the SPDX file content to provide general comments to the consumers of the SPDX content.

 

2.5.2 Intent: Here, the intent is to provide readers/reviewers with comments by the author of the SDPX …

 

2.5.3 Cardinality: Optional one or more.

 

2.5.4 Tag: “AuthorComment:”

 

2.5.5 RDF: /RDF/SPDXDoc/Describes/Package/AuthorComment

 

2.5.6 Data Format: free form text that can span multiple lines.

 

2.5.7 Example: AuthorComment: This information is provided "as is" without any warranty. It does not represent legal advice...

 

 

Mark Gisi | Wind River | Senior Intellectual Property Manager

Tel (510) 749-2016 | Fax (510) 749-4552

 

Join {spdx@lists.spdx.org to automatically receive all group messages.