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

xrdadler32: document use of stored checksum in file attributes #966

Closed
jmuf opened this issue Apr 17, 2019 · 1 comment
Closed

xrdadler32: document use of stored checksum in file attributes #966

jmuf opened this issue Apr 17, 2019 · 1 comment
Assignees
Labels
Documentation Issue Missing or incorrect documentation

Comments

@jmuf
Copy link
Contributor

jmuf commented Apr 17, 2019

We've come across "user.XrdCks.adler32" extended attributes on some files. Turns out that these get created when running xrdadler32 against a file, and that subsequent xrdadler32 runs will just return the stored checksum (instead of recomputing the checksum).

This behaviour (and in particular the fact that this command persistently changes file state, at least for local files) isn't really obvious from the documentation:

$ man xrdadler32
NAME
       xrdadler32 - compute and display an adler32 checksum

SYNOPSIS
       xrdadler32 [file]


DESCRIPTION
       The xrdadler32 utiliity computes and displays an adler32 checksum value for a file.  Usage synopsis can be displayed by typing "xrdadler32 -h".  Currently, only the usage synopsis is available as documentation.
[..]

$ xrdadler32 -h
Usage: xrdadler32 file. Calculating adler32 checksum of a given file.
A file can be local file, stdin (if omitted), or root URL (including via XROOTD_VMP)

Would it perhaps be possible to document the caching behaviour?

@abh3 abh3 added the Documentation Issue Missing or incorrect documentation label Jul 3, 2019
@abh3
Copy link
Member

abh3 commented Apr 14, 2020

Done!

@abh3 abh3 closed this as completed Apr 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issue Missing or incorrect documentation
Projects
None yet
Development

No branches or pull requests

3 participants