Skip to content

Add doc for sending patches to GCC #318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 17, 2023
Merged

Add doc for sending patches to GCC #318

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions doc/sending-gcc-patch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
This guide explains what to do to send a GCC patch for review.

All the commands are supposed to be run in the folder where you cloned GCC.

```bash
./contrib/gcc-changelog/git_check_commit.py
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you have multiple commits, this script can also take a rev-list as argument. I often use it like this:
contrib/gcc-changelog/git_check_commit.py upstream/master..HEAD

(assuming you have an upstream origin with a master branch that you branched from).

For a specific commit you can also use the commit's hash as argument:

contrib/gcc-changelog/git_check_commit.py abdef78989

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Updating the PR then.

```

You can provide a specific commit hash:

```bash
./contrib/gcc-changelog/git_check_commit.py abdef78989
```

a range:

```bash
./contrib/gcc-changelog/git_check_commit.py HEAD~2
```

or even a comparison with a remote branch:

```bash
./contrib/gcc-changelog/git_check_commit.py upstream/master..HEAD
```

When there is no more errors, generate the git patch:

```bash
git format-patch -1 `git rev-parse --short HEAD`
```

Then you can run the remaining checks using:

```bash
contrib/check_GNU_style.sh 0001-your-patch.patch
```

When you have no more errors, you can send the `.patch` file to GCC by sending an
email to `[email protected]` and to the relevant GCC mailing lists
depending on what your patch changes. You can find the list of the mailing lists
[here](https://gcc.gnu.org/lists.html).

You can find more information about "contributing to GCC" [here](https://gcc.gnu.org/contribute.html).