psi-jack/yadm
1
0
Fork 0
mirror of synced 2024-12-22 06:31:07 -05:00
Code Issues Releases Wiki Activity

Update pages to match new clone behavior (from #289)

Browse source
This commit is contained in:
Erik Flodin 2021-02-08 22:49:32 +01:00
parent cdf4ffbbec
commit a6a2945169
No known key found for this signature in database
GPG key ID: 420A7C865EE3F85F
2 changed files with 4 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
_docs/030_getting_started.md
View file

@ -22,10 +22,10 @@ Clone your existing repo using yadm.
yadm clone <url>
yadm status
The `clone` command will attempt to `merge` your existing repository, but if it
fails, it will `stash` any conflicting data. See
[this question](faq#i-just-cloned-my-repository-and-conflicting-data-was-overwritten-why)
in the FAQ if you need help.
The `clone` command will attempt to check out all files that exist in the
repository. If a file already exists locally and has content that differs from
the one in the repository, the local file will be left unmodified and you'll
have to review and resolve the differences.
---

20
_docs/110_faq.md
View file

@ -8,17 +8,6 @@ permalink: /docs/faq
## Usage
### I just cloned my repository and conflicting data was overwritten. Why?
Prior to cloning your repository, files managed by yadm already existed. For
example, imagine you are logged into a system and `$HOME/.bash_profile` already
exists. If you then clone your yadm repository—which also contains
`.bash_profile`—then you will likely get a conflict. Since version 1.07,
yadm responds by "stashing" these conflicts. To view the stashed data, you can
run `yadm stash show -p` from within your `$HOME` directory. If you want to
restore the stashed data, you can run `yadm stash apply` from within your
`$HOME` directory.
### While committing I got the message, _"Please tell me who you are"_. Why?
Whenever a Git commit is generated, Git requires information about the author of
@ -45,15 +34,6 @@ yadm gitconfig "user.name" "Alternate Name"
Note: Configuring these settings directly in the yadm repo will require you
to configure it each time you clone the repo.
### Why was I prompted to login twice while cloning my repo?
yadm needs to query your repo to determine the default branch used. When you are
using a private repository, this additional query also requires authentication.
You can avoid the double login by specifying which branch to clone using the
`-b` option.
yadm clone -b <branch> <url>
### How can I display untracked files with a `yadm status` command?
By default, yadm is configured to ignore untracked files when displaying a