0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-11-21 17:36:59 -05:00

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
This commit is contained in:
Gusted 2024-02-19 13:30:51 +01:00
parent bd2e86a799
commit a4e1851ff2
No known key found for this signature in database
GPG key ID: FD821B732837125F

View file

@ -82,7 +82,7 @@ The following parameters are available:
- `topic`: Essentially an identifier. **If left empty,** the value of `<session>`, 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.