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

Logical file paths - directory separators #219

Closed
bcail opened this issue Oct 10, 2018 · 3 comments
Closed

Logical file paths - directory separators #219

bcail opened this issue Oct 10, 2018 · 3 comments
Assignees
Milestone

Comments

@bcail
Copy link
Contributor

bcail commented Oct 10, 2018

In the Version objects, should the logical file path values in the state block allow windows or unix directory separators (eg. "dir/file.txt" vs "dir\file.txt")? Should a file name in a logical path be allowed to contain any directory separator characters (eg. "dir/file_with_/_char.txt)? Or should OCFL even care what's in that logical file path?

@awoods
Copy link
Member

awoods commented Oct 11, 2018

As a point of reference, BagIt takes the following approach:

As specified above, only the Unix-based path separator ('/') may be
used inside filenames listed in BagIt manifests and "fetch.txt"
files. When bags are exchanged between Windows and Unix platforms,
care should be taken to translate the path separator as needed.

@zimeon zimeon added this to the Beta milestone Oct 12, 2018
@ahankinson
Copy link
Contributor

Related to #243

@zimeon
Copy link
Contributor

zimeon commented Nov 7, 2018

I think we should follow Bagit here and make a normative statement in the introduction to Inventory that

The forward slash (/) path separator MUST be used in existing and logical file paths in the manifest, fixity and state blocks within the inventory. Implementations that target systems using other separators will need to translate paths appropriately.

@ahankinson ahankinson self-assigned this Nov 21, 2018
awoods pushed a commit to awoods/spec that referenced this issue Dec 6, 2018
ahankinson pushed a commit that referenced this issue Dec 6, 2018
zimeon pushed a commit that referenced this issue Dec 9, 2018
* Fixed: Clarify path separators used in the inventory

Fixes #219

* Add links to new path-separator clarify text (#289)

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

No branches or pull requests

4 participants