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

add more desi.json documentation #3

Closed
sbailey opened this issue Jul 26, 2017 · 1 comment · Fixed by weaverba137/hpsspy#2
Closed

add more desi.json documentation #3

sbailey opened this issue Jul 26, 2017 · 1 comment · Fixed by weaverba137/hpsspy#2
Assignees
Labels
enhancement New feature or request

Comments

@sbailey
Copy link
Contributor

sbailey commented Jul 26, 2017

Motivated by #2, add more documentation about how to add a new entry to etc/desi.json, e.g.

  1. naming constraints on the tar files, and whether those are best-practices guidelines or actually required for desiBackup and restore to work properly.
  2. worked examples for using regex groups to map N>>1 directories into N>>1 tar files, and how much one should worry about the resulting size of the tar file (and how to tell).
  3. worked examples for how to map the files in a directory into a tarball without accidentally mapping files in subdirectories.

Since json files don't allow comments, the existing etc/desi.json is only partially useful for deriving these patterns.

@weaverba137 weaverba137 self-assigned this Jul 27, 2017
@weaverba137 weaverba137 added the enhancement New feature or request label Jul 27, 2017
@weaverba137
Copy link
Member

For my own notes, this documentation is sufficiently important that it should be added to the hpsspy package, and it will be visible at http://hpsspy.readthedocs.io

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants