Skip to content

Commit

Permalink
docs: document the ui.movement.edit config option
Browse files Browse the repository at this point in the history
This option was introduced in #4283, but was not documented apart from
`prev` and `next`'s help text on the --edit/--no-edit flags.
  • Loading branch information
alarsyo authored and PhilipMetzger committed Jan 31, 2025
1 parent 4ac970f commit c2acc49
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
10 changes: 10 additions & 0 deletions cli/src/config-schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,16 @@
"type": "boolean",
"default": false,
"description": "Whether the built-in templates should show cryptographic signature information"
},
"movement": {
"type": "object",
"properties": {
"edit": {
"type": "boolean",
"description": "Whether the next and prev commands should behave as if the --edit flag was passed",
"default": false
}
}
}
}
},
Expand Down
16 changes: 16 additions & 0 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,22 @@ To prevent rewriting commits authored by other users:
Ancestors of the configured set are also immutable. The root commit is always
immutable even if the set is empty.

### Behavior of prev and next commands

If you prefer using an "edit-based" workflow, rather than squashing
modifications into parent changes, you may find yourself using the `prev` and
`next` commands with their `--edit` flag often to move between your changes. You
can avoid having to type the `--edit` flag every time you need it by actually
making it the default:

```toml
[ui.movement]
edit = true
```

You can pass the `--no-edit` flag to `prev` and `next` if you find yourself
needing the original behavior.

## Log

### Default revisions
Expand Down

0 comments on commit c2acc49

Please sign in to comment.