Skip to content

Commit f4d1de5

Browse files
committed
sign: add signature verification docs
1 parent 3df2603 commit f4d1de5

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

docs/config.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1027,6 +1027,30 @@ as follows:
10271027
backends.ssh.allowed-signers = "/path/to/allowed-signers"
10281028
```
10291029

1030+
## Commit Signature Verification
1031+
1032+
`jj` attempts to verify any signatures found on commits when
1033+
displaying them with `jj log` or `jj show`.
1034+
1035+
By default signature verification and display is **disabled** as it incurs a
1036+
performance cost when rendering medium to large change logs.
1037+
1038+
If you want to verify and display commit signatures, you can use the
1039+
provided template:
1040+
```sh
1041+
jj log -Tbuiltin_log_detailed_with_sig
1042+
```
1043+
1044+
If you always want to display commit signatures, you can set the
1045+
[default template](#default-template):
1046+
```toml
1047+
[templates]
1048+
log = "builtin_log_detailed_with_sig"
1049+
```
1050+
1051+
See [CommitSignature Type](./templates.md#commitsignature-type) for available template methods.
1052+
1053+
10301054
## Git settings
10311055

10321056
### Default remotes for `jj git fetch` and `jj git push`

0 commit comments

Comments
 (0)