Change default archive name to "archive"

This commit is contained in:
Tim Byrne 2020-09-25 10:03:27 -05:00
parent 05ae6f0257
commit 59c60a4675
No known key found for this signature in database
GPG Key ID: 14DB4FC2465A4B12
4 changed files with 14 additions and 14 deletions

View File

@ -285,7 +285,7 @@ def paths(tmpdir, yadm):
dir_repo = dir_yadm.mkdir('repo.git') dir_repo = dir_yadm.mkdir('repo.git')
dir_hooks = dir_yadm.mkdir('hooks') dir_hooks = dir_yadm.mkdir('hooks')
dir_remote = dir_root.mkdir('remote') dir_remote = dir_root.mkdir('remote')
file_archive = dir_yadm.join('files.gpg') file_archive = dir_yadm.join('archive')
file_bootstrap = dir_yadm.join('bootstrap') file_bootstrap = dir_yadm.join('bootstrap')
file_config = dir_yadm.join('config') file_config = dir_yadm.join('config')
file_encrypt = dir_yadm.join('encrypt') file_encrypt = dir_yadm.join('encrypt')

View File

@ -2,7 +2,7 @@
import pytest import pytest
ARCHIVE = 'files.gpg' ARCHIVE = 'archive'
BOOTSTRAP = 'bootstrap' BOOTSTRAP = 'bootstrap'
CONFIG = 'config' CONFIG = 'config'
ENCRYPT = 'encrypt' ENCRYPT = 'encrypt'

12
yadm
View File

@ -30,7 +30,7 @@ YADM_LEGACY_DIR="${HOME}/.yadm"
YADM_REPO="repo.git" YADM_REPO="repo.git"
YADM_CONFIG="config" YADM_CONFIG="config"
YADM_ENCRYPT="encrypt" YADM_ENCRYPT="encrypt"
YADM_ARCHIVE="files.gpg" YADM_ARCHIVE="archive"
YADM_BOOTSTRAP="bootstrap" YADM_BOOTSTRAP="bootstrap"
YADM_HOOKS="hooks" YADM_HOOKS="hooks"
YADM_ALT="alt" YADM_ALT="alt"
@ -1168,10 +1168,10 @@ Commands:
yadm transcrypt [OPTIONS] - Run transcrypt commands for the yadm repo yadm transcrypt [OPTIONS] - Run transcrypt commands for the yadm repo
Files: Files:
\$HOME/.config/yadm/config - yadm's configuration file \$HOME/.config/yadm/config - yadm's configuration file
\$HOME/.config/yadm/repo.git - yadm's Git repository \$HOME/.config/yadm/repo.git - yadm's Git repository
\$HOME/.config/yadm/encrypt - List of globs used for encrypt/decrypt \$HOME/.config/yadm/encrypt - List of globs used for encrypt/decrypt
\$HOME/.config/yadm/files.gpg - Encrypted data stored here \$HOME/.config/yadm/archive - Encrypted data stored here
Use "man yadm" for complete documentation. Use "man yadm" for complete documentation.
EOF EOF
@ -1577,7 +1577,7 @@ function issue_legacy_path_warning() {
"$YADM_LEGACY_DIR/$YADM_REPO" \ "$YADM_LEGACY_DIR/$YADM_REPO" \
"$YADM_LEGACY_DIR/$YADM_CONFIG" \ "$YADM_LEGACY_DIR/$YADM_CONFIG" \
"$YADM_LEGACY_DIR/$YADM_ENCRYPT" \ "$YADM_LEGACY_DIR/$YADM_ENCRYPT" \
"$YADM_LEGACY_DIR/$YADM_ARCHIVE" \ "$YADM_LEGACY_DIR/files.gpg" \
"$YADM_LEGACY_DIR/$YADM_BOOTSTRAP" \ "$YADM_LEGACY_DIR/$YADM_BOOTSTRAP" \
"$YADM_LEGACY_DIR/$YADM_HOOKS"/{pre,post}_* \ "$YADM_LEGACY_DIR/$YADM_HOOKS"/{pre,post}_* \
; \ ; \

12
yadm.1
View File

@ -174,7 +174,7 @@ See the CONFIGURATION section for more details.
.TP .TP
.B decrypt .B decrypt
Decrypt all files stored in Decrypt all files stored in
.IR $HOME/.config/yadm/files.gpg . .IR $HOME/.config/yadm/archive .
Files decrypted will be relative to the configured Files decrypted will be relative to the configured
.IR work-tree " (usually .IR work-tree " (usually
.IR $HOME ). .IR $HOME ).
@ -755,8 +755,8 @@ The
.B yadm encrypt .B yadm encrypt
command will find all files matching the patterns, and prompt for a password. Once a command will find all files matching the patterns, and prompt for a password. Once a
password has confirmed, the matching files will be encrypted and saved as password has confirmed, the matching files will be encrypted and saved as
.IR $HOME/.config/yadm/files.gpg . .IR $HOME/.config/yadm/archive .
The patterns and files.gpg should be added to the yadm repository so they are The "encrypt" and "archive" files should be added to the yadm repository so they are
available across multiple systems. available across multiple systems.
To decrypt these files later, or on another system run To decrypt these files later, or on another system run
@ -804,7 +804,7 @@ dependent upon the user's umask. Because of this, yadm will automatically
update the permissions of some file paths. The "group" and "others" permissions update the permissions of some file paths. The "group" and "others" permissions
will be removed from the following files: will be removed from the following files:
.RI - " $HOME/.config/yadm/files.gpg .RI - " $HOME/.config/yadm/archive
- All files matching patterns in - All files matching patterns in
.I $HOME/.config/yadm/encrypt .I $HOME/.config/yadm/encrypt
@ -922,7 +922,7 @@ Git repository used by yadm.
.I $YADM_DIR/encrypt .I $YADM_DIR/encrypt
List of globs used for encrypt/decrypt List of globs used for encrypt/decrypt
.TP .TP
.I $YADM_DIR/files.gpg .I $YADM_DIR/archive
All files encrypted with All files encrypted with
.B yadm encrypt .B yadm encrypt
are stored in this file. are stored in this file.
@ -947,7 +947,7 @@ Initial push of master to origin
.B echo ".ssh/*.key" >> $HOME/.config/yadm/encrypt .B echo ".ssh/*.key" >> $HOME/.config/yadm/encrypt
Add a new pattern to the list of encrypted files Add a new pattern to the list of encrypted files
.TP .TP
.B yadm encrypt ; yadm add ~/.config/yadm/files.gpg ; yadm commit .B yadm encrypt ; yadm add ~/.config/yadm/archive ; yadm commit
Commit a new set of encrypted files Commit a new set of encrypted files
.SH REPORTING BUGS .SH REPORTING BUGS