psi-jack
/
yadm
mirror of
1
0
Fork 0
Code Issues Releases Wiki Activity

Update documentation for changes to upgrade

This commit is contained in:
Tim Byrne 2021-01-04 13:14:07 -06:00
parent 0b4aa767fb
commit 1c9dff7a42
No known key found for this signature in database
GPG Key ID: 14DB4FC2465A4B12
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
yadm.1
View File

@ -61,6 +61,7 @@ list
.BR yadm " transcrypt [ options ]
.BR yadm " upgrade
.RB [ -f ]
.BR yadm " introspect
.I category
@ -297,8 +298,15 @@ This command will start by moving your yadm repo to the new path.
Next it will move any archive data.
If the archive is tracked within your yadm repo, this command will
"stage" the renaming of that file in the repo's index.
Upgrading will also re-initialize all submodules you have added (otherwise they
will be broken when the repo moves).
Upgrading will attempt to de-initialize and re-initialize your submodules. If
your submodules cannot be de-initialized, the upgrade will fail. The most
common reason submodules will fail to de-initialize is because they have local
modifications. If you are willing to lose the local modifications to those
submodules, you can use the
.B -f
option with the "upgrade" command to force the de-initialization.
After running "yadm upgrade", you should run "yadm status" to review changes
which have been staged, and commit them to your repository.