Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Why does the Storage Root extensions section talk about what files are allowed in the root itself? #470

Closed
zimeon opened this issue May 19, 2020 · 2 comments · Fixed by #476
Assignees
Milestone

Comments

@zimeon
Copy link
Contributor

zimeon commented May 19, 2020

We have in https://ocfl.io/draft/spec/#storage-root-extensions

An OCFL validator MUST ignore any files in the storage root it does not understand. Additional files MUST not appear in other directories under the storage root.

This isn't anything to do with extensions and:

  1. if we want the first MUST is should be in https://ocfl.io/draft/spec/#root-structure
  2. the second sentence is duplicative of https://ocfl.io/draft/spec/#E072 and should be removed
@neilsjefferies
Copy link
Member

  1. What about additional folders in the Storage Root? Is extensions a special case?

@zimeon
Copy link
Contributor Author

zimeon commented May 20, 2020

Actually, there seems a conflict around directories in the spec at present. In https://ocfl.io/draft/spec/#root-structure is says:

Sub-directories within an OCFL Storage Root MUST NOT contain files that are not part of an OCFL Object. Empty directories MUST NOT appear within a storage root.

and then in https://ocfl.io/draft/spec/#storage-root-extensions:

The base directory of an OCFL Storage Root MAY contain a directory named extensions for the purposes of extending the functionality of an OCFL Storage Root.

I think the first needs to be rewritten along the lines of:

An OCFL Storage Root MUST NOT contain directories or sub-directories other than as a directory hierarchy used to store OCFL Objects or for storage root extensions. The directory hierarchy used to store OCFL Objects MUST NOT contain files that are not part of an OCFL Object. Empty directories MUST NOT appear under a storage root.

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

Successfully merging a pull request may close this issue.

2 participants