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

Version directory naming #31

Merged
merged 3 commits into from
Jul 19, 2018
Merged

Version directory naming #31

merged 3 commits into from
Jul 19, 2018

Conversation

zimeon
Copy link
Contributor

@zimeon zimeon commented Jul 11, 2018

First stab at text for version directory naming

Resolves #2

awoods
awoods previously approved these changes Jul 12, 2018
For compatibility with existing filesystem conventions, implementations MAY use zero-padded version numbers,
with the following restriction: If zero-padded version numbers are used then they MUST start with a zero. For example,
in an implementation that uses five digits the version directory names <code>v00001</code> to <code>v09999</code> are
allowed, <code>v10000</code> is not allowed.
Copy link
Contributor

Choose a reason for hiding this comment

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

Why not? A regex such as v([\d]+) would capture the integer value. Is this for sorting purposes? If so, we should mention that.

Copy link
Member

Choose a reason for hiding this comment

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

To make follow-suit numbering of an inherited filesystem easier. Looking at the last version tells you what the next version number should be - rather than tracking back to the last-version-that-changed-the-number-of-significant-digits.

Copy link
Member

Choose a reason for hiding this comment

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

However, we do need to mention follow suit. Version numbers should either be all unpadded or all padded to the same length. Or else we need additional rules so that v1, v001 and v00000000001 don't coexist.

Copy link
Member

Choose a reason for hiding this comment

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

...people will do that. We have shelfmarks where punctuation and spacing are significant.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ahankinson - I included the v0... requirement for padded following the discussion in #2 (comment)

@neilsjefferies - The following part of the PR does sat the the length must be consistent

All versions MUST use the same naming convention: either a non-padded version number, or a zero-padded version number of consistent length.

neilsjefferies
neilsjefferies previously approved these changes Jul 16, 2018
Copy link
Member

@neilsjefferies neilsjefferies left a comment

Choose a reason for hiding this comment

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

Would specify "decimal" numbers! And versioning consistency at the object level.

ahankinson
ahankinson previously approved these changes Jul 18, 2018
Copy link
Contributor

@rosy1280 rosy1280 left a comment

Choose a reason for hiding this comment

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

on line 206 change "All versions MUST use...." to "All versions of an object MUST use....." to ensure clarity.

@zimeon
Copy link
Contributor Author

zimeon commented Jul 18, 2018

@rosy1280 - I agree, will do.

@zimeon zimeon dismissed stale reviews from ahankinson, neilsjefferies, and awoods via c6e3291 July 18, 2018 13:38
and the version directory name is constructed by adding the prefix <code>v</code>.
</p>
<p>
It is RECOMMENDED that implementations use version directory names constructed without zero-padding the version
Copy link
Member

@awoods awoods Jul 18, 2018

Choose a reason for hiding this comment

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

Change to MUST/MAY/SHOULD language?

Implementations SHOULD use version directory...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

RECOMMENDED is part of RFC2119... we should discuss this on our call (and add to the spec) --> #35

Copy link
Member

@awoods awoods left a comment

Choose a reason for hiding this comment

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

awoods
awoods previously approved these changes Jul 18, 2018
rosy1280
rosy1280 previously approved these changes Jul 18, 2018
ahankinson
ahankinson previously approved these changes Jul 18, 2018
julianmorley
julianmorley previously approved these changes Jul 18, 2018
Copy link
Contributor

@julianmorley julianmorley left a comment

Choose a reason for hiding this comment

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

This is acceptable to me - I'm a bit concerned that it limits existing Moab versions to < 999, but unless we significantly change our workflows that's not likely to be a practical problem until long after we can create native OCFL objects.

# Conflicts:
#	index.html
@ahankinson ahankinson dismissed stale reviews from julianmorley, rosy1280, awoods, and themself via 547c26c July 19, 2018 09:43
@ahankinson
Copy link
Contributor

There was a merge conflict when trying to bring this branch to a mergeable state. I am noting that this automatically invalidates the reviews, but there were no changes to the text for this process.

Merging under the 'rapid merge' policy.

@ahankinson ahankinson merged commit 185a426 into master Jul 19, 2018
@awoods awoods deleted the issue-2 branch July 19, 2018 14:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants