psi-jack/yadm
1
0
Fork 0
mirror of synced 2025-01-07 21:52:15 -05:00
Code Issues Releases Wiki Activity

Update the man page to match new clone behavior (from #289)

Browse source
This commit is contained in:
Erik Flodin 2021-02-08 23:00:13 +01:00
parent 31071d9ac9
commit 7b1bfac12b
No known key found for this signature in database
GPG key ID: 420A7C865EE3F85F
1 changed files with 3 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
yadm.1
View file

@ -116,32 +116,12 @@ if it exists.
.TP .TP
.BI clone " url .BI clone " url
Clone a remote repository for tracking dotfiles. Clone a remote repository for tracking dotfiles.
After the contents of the remote repository have been fetched, a "merge" of After the contents of the remote repository have been fetched, a "check out" of
the remote HEAD branch is attempted. the remote HEAD branch is attempted.
If there are conflicting files already present in the If there are conflicting files already present in the
.IR work-tree , .IR work-tree ,
this merge will fail and instead a "reset" of the remote HEAD branch the local version will be left unmodified and you'll have to review and resolv
will be done, followed by a "stash". This "stash" operation will preserve the the difference.
original data.
You can review the stashed conflicts by running the command
.RS
.RS
yadm stash show -p
.RE
from within your
.I $HOME
directory. If you want to restore the stashed data, you can run
.RS
yadm stash apply
.RE
or
.RS
yadm stash pop
.RE
The repository is stored in The repository is stored in
.IR $HOME/.local/share/yadm/repo.git . .IR $HOME/.local/share/yadm/repo.git .