Skip to content

Commit e1ab247

Browse files
committed
docs: mention "jj file untrack" in Git compatibility list
Closes #5059
1 parent 0f845b6 commit e1ab247

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

docs/git-compatibility.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,13 @@ a comparison with Git, including how workflows are different, see the
3131
and [how they interoperate with Git](#branches).
3232
* **Tags: Partial.** You can check out tagged commits by name (pointed to be
3333
either annotated or lightweight tags), but you cannot create new tags.
34-
* **.gitignore: Yes.** Ignores in `.gitignore` files are supported. So are
34+
* **.gitignore: Yes.** Patterns in `.gitignore` files are supported. So are
3535
ignores in `.git/info/exclude` or configured via Git's `core.excludesfile`
36-
config. The `.gitignore` support uses a native implementation, so please
37-
report a bug if you notice any difference compared to `git`.
36+
config. Since working-copy files are snapshotted by every `jj` command, you
37+
might need to run `jj file untrack` to exclude newly ignored files from the
38+
working-copy commit. It's recommended to set up the ignore patterns earlier.
39+
The `.gitignore` support uses a native implementation, so please report a bug
40+
if you notice any difference compared to `git`.
3841
* **.gitattributes: No.** There's [#53](https://github.com/martinvonz/jj/issues/53)
3942
about adding support for at least the `eol` attribute.
4043
* **Hooks: No.** There's [#405](https://github.com/martinvonz/jj/issues/405)

0 commit comments

Comments
 (0)