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.

Sign up for GitHub

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

Update index.html etc. for #540 - Empty version directories must have inventories #567

Closed
wants to merge 9 commits into from
Closed

Update index.html etc. for #540 - Empty version directories must have inventories #567

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
efe65d0
Update index.html
neilsjefferies Oct 19, 2021
cbe2c88
Update index.html
neilsjefferies Oct 19, 2021
b46fa68
Update validation-codes.md
neilsjefferies Oct 19, 2021
f29e36a
Update index.html
neilsjefferies Oct 19, 2021
38ae001
Update index.html
neilsjefferies Oct 19, 2021
350615f
Update index.html
neilsjefferies Oct 19, 2021
0196524
Merge branch 'main' into neilsjefferies-patch-for-540
neilsjefferies Nov 10, 2021
912767b
Update index.html
neilsjefferies Nov 10, 2021
f940b00
Update validation-codes.md
neilsjefferies Nov 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions draft/spec/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -911,10 +911,13 @@ <h2>Version Inventory and Inventory Digest</h2>
Every OCFL Object <span id="E063">MUST</span> have an inventory file within the OCFL Object Root,
corresponding to the state of the OCFL Object at the current version. Additionally, every version directory
<span id="W010">SHOULD</span> include an inventory file that is an <a href="#inventory">Inventory</a> of
all content for versions up to and including that particular version. Where an OCFL Object contains
<code>inventory.json</code> in version directories, the inventory file in the OCFL Object Root
<span id="E064">MUST</span> be the same as the file in the most recent version. See also requirements for
the corresponding <a href="#inventory-digest">Inventory Digest</a>.
all content for versions up to and including that particular version. In the case where no files have been
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we could make this cleaner by starting a new paragraph at

In the case where.....

But I'm not going to hold up approval for that simple change.

added or updated in a given version, resulting in an empty or absent
<a href="#content-directory">content directory</a>, the version directory <span id="E109">MUST</span>
still include an inventory file. Where an OCFL Object contains <code>inventory.json</code> in version
directories, the inventory file in the OCFL Object Root <span id="E064">MUST</span> be the same as the
file in the most recent version. See also requirements for the corresponding
<a href="#inventory-digest">Inventory Digest</a>.
</p>
<p>
In the case that prior version directories include an inventory file there will be multiple inventory
Expand Down
1 change: 1 addition & 0 deletions draft/spec/validation-codes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@
| E106 | 'The value of the manifest key MUST be a JSON object.' | https://ocfl.io/draft/spec/#E106
| E107 | 'The value of the manifest key must be a JSON object, and each key MUST correspond to a digest value key found in one or more state blocks of the current and/or previous version blocks of the OCFL Object.' | https://ocfl.io/draft/spec/#E107
| E108 | 'The contentDirectory value MUST represent a direct child directory of the version directory in which it is found.' | https://ocfl.io/draft/spec/#E108
| E109 | 'Where no files have been added or updated in a given version, resulting in an empty or absent content directory, the version directory MUST still include an inventory file.' | https://ocfl.io/draft/spec/#E109
| E110 | 'A unique identifier for the OCFL Object MUST NOT change between versions of the same object.' | https://ocfl.io/draft/spec/#E110

## Warnings (corresponding with SHOULD in specification)
Expand Down