Feature #7818

[SDKs] Document that arv-copy accepts collection PDHs (ie content addresses) as arguments

Added by Bryan Cosca over 3 years ago. Updated over 2 years ago.

Status:
New
Priority:
Normal
Assigned To:
-
Category:
SDKs
Target version:
Start date:
11/17/2015
Due date:
% Done:

0%

Estimated time:
Story points:
0.5

History

#1 Updated by Brett Smith over 3 years ago

arv-copy does accept collection PDHs. --help could be clearer about this.

#2 Updated by Tom Clegg over 3 years ago

So, something like this in source:sdk/python/arvados/commands/arv_copy.py?
  •      copy_opts.add_argument(
             'object_uuid',
    -        help='The UUID of the object to be copied.')
    +        help='The UUID (or portable data hash) of the object to be copied.')
    

#3 Updated by Bryan Cosca over 3 years ago

My 2 cents: In a collection page, we refer to the pdh as a "Content address", I think we should be consistent here and say "Content address". PDH works for me too, I'm just being nitpicky.

#4 Updated by Brett Smith over 3 years ago

Bryan's comment pokes at a terminology tension here we haven't fully resolved. Most of Arvados refers to this consistently as a "portable data hash." But when we made the relevant Workbench changes, we were very specifically requested to call it "content address."

"Portable data hash" is a term specific to Keep manifests that has a very precise meaning. "Content address" is a general concept that most of our users can grok after just a sentence or two of explanation. A collection's portable data hash serves as a content address for it, but if you try to generate it the same way you generate content addresses for individual Keep data blocks, you'll be disappointed.

I think the number of people who need to know how to generate portable data hashes is comparatively small enough that we should prefer "content address" in all UIs, so I'd vote with Bryan. But maybe we should have that general conversation and at least figure out some basic rules of what term gets used when.

#5 Updated by Brett Smith over 3 years ago

  • Subject changed from arv-copy --by-pdh collection_hash to [SDKs] Document that arv-copy accepts collection PDHs as arguments
  • Category set to SDKs

#6 Updated by Brett Smith over 3 years ago

  • Target version set to Arvados Future Sprints

#7 Updated by Tom Morris over 2 years ago

  • Subject changed from [SDKs] Document that arv-copy accepts collection PDHs as arguments to [SDKs] Document that arv-copy accepts collection PDHs (ie content addresses) as arguments
  • Story points set to 0.5

Does anyone disagree with using "Content Address" here? That term sounds good to me for this type of usage.

Also available in: Atom PDF