Skip to content

Add a paragraph about file naming#1383

Open
vargenau wants to merge 3 commits intospdx:developfrom
nokia:file-naming
Open

Add a paragraph about file naming#1383
vargenau wants to merge 3 commits intospdx:developfrom
nokia:file-naming

Conversation

@vargenau
Copy link
Copy Markdown
Contributor

@vargenau vargenau commented Apr 9, 2026

This solves #987

Signed-off-by: Marc-Etienne Vargenau <marc-etienne.vargenau@nokia.com>
Copy link
Copy Markdown
Collaborator

@bact bact left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very minor Markdown formatting suggestions.

The content is good. Thank you for putting this together.

Comment thread docs/serializations.md
Comment thread docs/serializations.md Outdated
vargenau and others added 2 commits April 9, 2026 19:24
Co-authored-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Marc-Etienne Vargenau <marc-etienne.vargenau@nokia.com>
Co-authored-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Marc-Etienne Vargenau <marc-etienne.vargenau@nokia.com>
Copy link
Copy Markdown
Collaborator

@bact bact left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Aligned with general agreement from 31 March 2026 Tech Call, see notes #1359 (comment)

If OMG sees it other way, we can of course update this later.

@zvr
Copy link
Copy Markdown
Member

zvr commented Apr 9, 2026

A specification, which becomes an ISO standard is not a place to have content about wishes ("should be easy") or suggestions. This is part of a Normative chapter; what does this text mean?

Is it required to use these file extensions in order to conform with the specification? If not, these do not belong here.

@goneall
Copy link
Copy Markdown
Member

goneall commented Apr 9, 2026

A specification, which becomes an ISO standard is not a place to have content about wishes ("should be easy") or suggestions. This is part of a Normative chapter; what does this text mean?

Is it required to use these file extensions in order to conform with the specification? If not, these do not belong here.

What if we change the context of the statement to reference the IANA media type once it is approved?

Something like "SPDX JSON-LD is registered as an IANA media type XXX which is associated with the file extension .spdx3.json."

@vargenau
Copy link
Copy Markdown
Contributor Author

A specification, which becomes an ISO standard is not a place to have content about wishes ("should be easy") or suggestions. This is part of a Normative chapter; what does this text mean?

Is it required to use these file extensions in order to conform with the specification? If not, these do not belong here.

Hi Alexios,

I am sorry, but I have to disagree.

In the current SPDX ISO standard, the wording is as follows:

Should be easy to recognize in a file system without opening the file. A suggested naming
convention is:
Table 1 — Suggested naming convention
Format Extension
tag:value *.spdx
RDF *.spdx.rdf
JSON *.spdx.json
XML *.spdx.xml
YAML *.spdx.yaml or *.spdx.yml

So yes the ISO standard is "suggesting".

In my proposal, I tried to be as close as possible to the SPDX 2 ISO standard.

@bact
Copy link
Copy Markdown
Collaborator

bact commented Apr 14, 2026

Checked with ISO/IEC 5962:2021 (SPDX v2.2.1) https://www.iso.org/standard/81870.html (free to download) page 5, line 2, same wording there ("Should be easy to ...").

The text is inside "4.4 Standard data format requirements" clause.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants