felipec / git-send-series

A tool to help maintain patch series

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

git-send-series

This tool allows you to maintain a patch series more easily. You can store the cover letter, the cc list, version of the series, and other metadata.

By default it will use the currently checked out branch, and show you a template like this:

version:
cc:
  -
  -

Subject

Content.

The first part is a YAML document with all optional fields, such as 'version', 'cc', 'to'. You can store any information you want using the YAML syntax.

The second part, delimited by a blank line, is the cover letter. The first line will be used as the subject of the cover letter email, and the rest as the content of the email.

For example:

version: 2
to: list@vger.kernel.org
cc:
  - Felipe Contreras <felipe.contreras@gmail.com>
  - Don Draper <don@draper.me>
  - William G. Connolly <william@connolly.me>

README: bunch of fixes

There was a bunch of typos and grammatical errors.

I've separated the fixes in multiple patches.

Then standard tools will be used to send the emails: git format-patch and git send-email, which you must have configured before using this helper.

In the end, a custom ref will be created to save the current state of the branch. For example, if you want to see what was the status of your series of the branch 'feature-a' in version 2, you can use 'sent/feature-a/v2', for example to create an interdiff to see what changed between one version and the other.

By default git send-series will attach a range-diff to the cover-letter using the previous version of the series.

Installation

Install the parseopt gem:

% gem install parseopt

Then simply copy the script anywhere in your $PATH and make it executable, or run make install which will install it by default to your ~/bin/ directory (make sure it’s in your $PATH).

About

A tool to help maintain patch series


Languages

Language:Shell 79.0%Language:Ruby 17.6%Language:Makefile 2.3%Language:Vim Script 1.1%