mirrors/jj
1
0
Fork 1
mirror of https://github.com/martinvonz/jj.git synced 2024-12-24 12:48:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

docs: prefer ~/.jjconfig.toml on all platforms

Browse source 
It's much easier to tell users on all platforms to put their config in
`~/.jjconfig.toml` than in a path that varies across the platforms, so
let's do that. It also seems like a less controversial location for
the file.

Closes ##233.
This commit is contained in:
Martin von Zweigbergk 2022-05-08 09:26:58 -07:00 committed by Martin von Zweigbergk
parent 0f5e360d96
commit 96849da332
2 changed files with 4 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -204,12 +204,10 @@ cargo install --git https://github.com/martinvonz/jj.git
## Initial configuration
You may want to configure your name and email so commits are made in your name.
Create a file at `<config dir>/jj/config.toml` (where `<config dir>` is
`${XDG_CONFIG_HOME}` or `~/.config/` on Linux, `~/Library/Application Support/`
on macOS, and `~\AppData\Roaming\` on Windows) and make it look something like
Create a file at `~/jjconfig.toml` and make it look something like
this:
```shell script
$ cat ~/.config/jj/config.toml
$ cat ~/.jjconfig.toml
[user]
name = "Martin von Zweigbergk"
email = "martinvonz@google.com"

4
docs/tutorial.md
View file

@ -175,7 +175,7 @@ ancestors (`:foo`), descendants (`foo:`), DAG range (`foo:bar`, like
`git log --ancestry-path`), range (`foo..bar`, same as Git's). There are also a
few more functions, such as `heads(<set>)`, which filters out revisions in the
input set if they're ancestors of other revisions in the set. Let's define an
alias based on that by adding the following to `~/.config/jj/config.toml`:
alias based on that by adding the following to `~/.jjconfig.toml`:
```
[alias]
l = ["log", "-r", "(heads(remote_branches())..@):"]
@ -348,7 +348,7 @@ try `jj l --at-op=401652a2f61e` but use the hash from your own `jj op log`.
You have already seen how `jj squash` can combine the changes from two commits
into one. There are several other commands for changing the contents of existing
commits. These commands assume that you have `meld` installed. If you prefer
`vimdiff`, add this to your `~/.config/jj/config.toml` file:
`vimdiff`, add this to your `~/.jjconfig.toml` file:
```
[ui]
diff-editor = "vimdiff"