Skip to content

Commit 0f3ea4e

Browse files
authored
Update agit-support.en-us.md (#27652)
Clarify Agit PR creation documentation See #27579
1 parent 0271114 commit 0f3ea4e

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

docs/content/usage/agit-support.en-us.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ menu:
1818
# Agit Setup
1919

2020
In Gitea `1.13`, support for [agit](https://git-repo.info/en/2020/03/agit-flow-and-git-repo/) was added.
21+
**Note**: git version 2.29 or higher is required on the server side for this to work.
2122

2223
## Creating PRs with Agit
2324

@@ -32,14 +33,16 @@ git push origin HEAD:refs/for/main
3233
The command has the following structure:
3334

3435
- `HEAD`: The target branch
35-
- `refs/<for|draft|for-review>/<branch>`: The target PR type
36+
- `origin`: The target repository (not a fork!)
37+
- `HEAD`: The local branch containing the changes you are proposing
38+
- `refs/<for|draft|for-review>/<branch>`: The target PR type and configuration
3639
- `for`: Create a normal PR with `<branch>` as the target branch
37-
- `draft`/ `for-review`: Currently ignored silently
38-
- `<branch>/<session>`: The target branch to open the PR
40+
- `draft`/`for-review`: Currently ignored silently
41+
- `<branch>/`: The branch you want your changes to be merged into
3942
- `-o <topic|title|description>`: Options for the PR
40-
- `title`: The PR title
41-
- `topic`: The branch name the PR should be opened for
42-
- `description`: The PR description
43+
- `topic`: The topic of this change. It will become the name of the branch holding the changes waiting for review. This is REQUIRED to trigger a pull request.
44+
- `title`: The PR title (optional but recommended), only used for topics not already having an associated PR.
45+
- `description`: The PR description (optional but recommended), only used for topics not already having an associated PR.
4346
- `force-push`: confirm force update the target branch
4447

4548
Here's another advanced example for creating a new PR targeting `main` with `topic`, `title`, and `description`:

0 commit comments

Comments
 (0)