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

Docs example of c2patool --remote usage is confusing #833

Open
eeeps opened this issue Jan 9, 2025 · 2 comments
Open

Docs example of c2patool --remote usage is confusing #833

eeeps opened this issue Jan 9, 2025 · 2 comments
Assignees
Labels
accepted bug Something isn't working c2patool Issues related to c2patool cli documentation Improvements or additions to documentation

Comments

@eeeps
Copy link

eeeps commented Jan 9, 2025

After correctly describing what the --remote option does in the first paragrah, the docs give the following example

c2patool sample/image.jpg -r http://my_server/myasset.c2pa -m sample/test.json -o signed_image.jpg

In the example above, the tool will embed the URL http://my_server/myasset.c2pa in signed_image.jpg then fetch the manifest from that URL and save it to signed_image.c2pa.

(emphasis mine)

This directly contradicts the first paragraph, which says that the tool will generate the .c2pa file itself. The tool will not fetch the manifest from the remote URL. It will create it and expects you to then make it accessible at the URL that you specified.

@crandmck crandmck added documentation Improvements or additions to documentation c2patool Issues related to c2patool cli labels Jan 10, 2025
@gpeacock
Copy link
Collaborator

That is correct, it will not fetch the c2pa file, it expects the caller to make that .c2pa file available at the given url.
The docs should be updated.

@gpeacock gpeacock added bug Something isn't working accepted labels Jan 17, 2025
@github-jira-sync-bot
Copy link

✅ Jira issue https://jira.corp.adobe.com/browse/CAI-7489 is successfully created for this GitHub issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted bug Something isn't working c2patool Issues related to c2patool cli documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants