Skip to content

Commit

Permalink
docs: add an entry for snapshot.max-new-file-size
Browse files Browse the repository at this point in the history
This was not documented, for some reason.

Signed-off-by: Austin Seipp <[email protected]>
Change-Id: I01a86a2d62b225c0175ed690fe9966ed22c92745
  • Loading branch information
thoughtpolice committed Apr 3, 2024
1 parent 13a8c43 commit 5d8678a
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -704,6 +704,27 @@ executable on your system](https://facebook.github.io/watchman/docs/install).

Debugging commands are available under `jj debug watchman`.

## Snapshot settings

### Maximum size for new files

By default, as an anti-footgun measure, `jj` will refuse to add new files to the
snapshot that are larger than a certain size; the default is 1MiB. This can be
changed by setting `snapshot.max-new-file-size` to a different value. For
example:

```toml
snapshot.max-new-file-size = "10MiB"
# the following is equivalent
snapshot.max-new-file-size = 10485760
```

The value can be specified using a human readable string with typical suffixes;
`B`, `MiB`, `GB`, etc. By default, if no suffix is provided, or the value is a
raw integer literal, the value is in bytes.

Files that already exist in the working copy are not subject to this limit.

## Ways to specify `jj` config: details

### User config file
Expand Down

0 comments on commit 5d8678a

Please sign in to comment.