From a4e1851ff2b0d3d9e61ec93aada71ea6b1fd1ccf Mon Sep 17 00:00:00 2001 From: Gusted Date: Mon, 19 Feb 2024 13:30:51 +0100 Subject: [PATCH] user: Clarify value of `force-push` in AGit - Clarify that if you want to use this parameter the value should be set to `true` (other values may work, but that can be restricted later). - Ref: https://codeberg.org/forgejo/forgejo/pulls/2386#issuecomment-1572905 --- docs/user/agit-support.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/agit-support.md b/docs/user/agit-support.md index 09853194..dbb68ffd 100644 --- a/docs/user/agit-support.md +++ b/docs/user/agit-support.md @@ -82,7 +82,7 @@ The following parameters are available: - `topic`: Essentially an identifier. **If left empty,** the value of ``, if present, will also be used for the topic. Otherwise, Forgejo will return an error. If you want to push additional commits to a Pull Request that was created using AGit, you **must** use the same topic. - `title`: Title of the Pull Request. **If left empty,** the first line of the first new Git commit will be used instead. - `description`: Description of the Pull Request. - - `force-push`: Necessary when rebasing, amending or [retroactively modifying](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History) your previous commits. Otherwise, a new Pull Request will be opened, **even if you use the same topic**. + - `force-push`: Necessary when rebasing, amending or [retroactively modifying](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History) your previous commits. Otherwise, a new Pull Request will be opened, **even if you use the same topic**. If used, the value of this parameter should be set to `true`. Forgejo relies on the `topic` parameter and a linear commit history in order to associate new commits with an existing Pull Request.