diff options
| author | Chris West (Faux) <git@goeswhere.com> | 2017-12-16 15:35:04 +0000 |
|---|---|---|
| committer | Guido Günther <agx@sigxcpu.org> | 2017-12-24 19:47:59 +0100 |
| commit | 3003d0778aed0afcfe766d1595348b83e59df616 (patch) | |
| tree | ed481d9252f9d10e1be4c94d630689a9787ad554 | |
| parent | 17a471d1fc07935dd85c31d3a7c4ae3ea5c39208 (diff) | |
docs: pq: warn that DEP3 support is incomplete
| -rw-r--r-- | docs/chapters/patches.xml | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/chapters/patches.xml b/docs/chapters/patches.xml index f074931c..e93be5c3 100644 --- a/docs/chapters/patches.xml +++ b/docs/chapters/patches.xml @@ -52,6 +52,24 @@ the your &debian-branch;, of course. </para> + <para> + Also, beware that &gbp-pq; currently has incomplete support for + <ulink url="http://dep.debian.net/deps/dep3/">DEP3</ulink> headers. + Initially, parsing with <command>git-mailinfo(1)</command> is attempted, + which supports only the <computeroutput>From</computeroutput> and + <computeroutput>Subject</computeroutput> fields. If neither of these are + present, &gbp-pq; will attempt to convert the patch from DEP3 format into + a <command>git-mailinfo(1)</command> compatible format. This involves first + loading <computeroutput>From</computeroutput> using the + <computeroutput>Author</computeroutput> field and + <computeroutput>Subject</computeroutput> using the first line of the + <computeroutput>Description</computeroutput> field. Then, any additional + fields (such as <computeroutput>Origin</computeroutput> and + <computeroutput>Forwarded</computeroutput>), and the remainder of the + <computeroutput>Description</computeroutput> (if any), will be appended to + the body. + </para> + <sect1 id="gbp.patches.workflow"> <title>Basic Workflow</title> |