linux/Documentation/email-clients.txt
<<
>>
Prefs
   1Email clients info for Linux
   2======================================================================
   3
   4General Preferences
   5----------------------------------------------------------------------
   6Patches for the Linux kernel are submitted via email, preferably as
   7inline text in the body of the email.  Some maintainers accept
   8attachments, but then the attachments should have content-type
   9"text/plain".  However, attachments are generally frowned upon because
  10it makes quoting portions of the patch more difficult in the patch
  11review process.
  12
  13Email clients that are used for Linux kernel patches should send the
  14patch text untouched.  For example, they should not modify or delete tabs
  15or spaces, even at the beginning or end of lines.
  16
  17Don't send patches with "format=flowed".  This can cause unexpected
  18and unwanted line breaks.
  19
  20Don't let your email client do automatic word wrapping for you.
  21This can also corrupt your patch.
  22
  23Email clients should not modify the character set encoding of the text.
  24Emailed patches should be in ASCII or UTF-8 encoding only.
  25If you configure your email client to send emails with UTF-8 encoding,
  26you avoid some possible charset problems.
  27
  28Email clients should generate and maintain References: or In-Reply-To:
  29headers so that mail threading is not broken.
  30
  31Copy-and-paste (or cut-and-paste) usually does not work for patches
  32because tabs are converted to spaces.  Using xclipboard, xclip, and/or
  33xcutsel may work, but it's best to test this for yourself or just avoid
  34copy-and-paste.
  35
  36Don't use PGP/GPG signatures in mail that contains patches.
  37This breaks many scripts that read and apply the patches.
  38(This should be fixable.)
  39
  40It's a good idea to send a patch to yourself, save the received message,
  41and successfully apply it with 'patch' before sending patches to Linux
  42mailing lists.
  43
  44
  45Some email client (MUA) hints
  46----------------------------------------------------------------------
  47Here are some specific MUA configuration hints for editing and sending
  48patches for the Linux kernel.  These are not meant to be complete
  49software package configuration summaries.
  50
  51Legend:
  52TUI = text-based user interface
  53GUI = graphical user interface
  54
  55~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  56Alpine (TUI)
  57
  58Config options:
  59In the "Sending Preferences" section:
  60
  61- "Do Not Send Flowed Text" must be enabled
  62- "Strip Whitespace Before Sending" must be disabled
  63
  64When composing the message, the cursor should be placed where the patch
  65should appear, and then pressing CTRL-R let you specify the patch file
  66to insert into the message.
  67
  68~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  69Evolution (GUI)
  70
  71Some people use this successfully for patches.
  72
  73When composing mail select: Preformat
  74  from Format->Heading->Preformatted (Ctrl-7)
  75  or the toolbar
  76
  77Then use:
  78  Insert->Text File... (Alt-n x)
  79to insert the patch.
  80
  81You can also "diff -Nru old.c new.c | xclip", select Preformat, then
  82paste with the middle button.
  83
  84~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  85Kmail (GUI)
  86
  87Some people use Kmail successfully for patches.
  88
  89The default setting of not composing in HTML is appropriate; do not
  90enable it.
  91
  92When composing an email, under options, uncheck "word wrap". The only
  93disadvantage is any text you type in the email will not be word-wrapped
  94so you will have to manually word wrap text before the patch. The easiest
  95way around this is to compose your email with word wrap enabled, then save
  96it as a draft. Once you pull it up again from your drafts it is now hard
  97word-wrapped and you can uncheck "word wrap" without losing the existing
  98wrapping.
  99
 100At the bottom of your email, put the commonly-used patch delimiter before
 101inserting your patch:  three hyphens (---).
 102
 103Then from the "Message" menu item, select insert file and choose your patch.
 104As an added bonus you can customise the message creation toolbar menu
 105and put the "insert file" icon there.
 106
 107Make the the composer window wide enough so that no lines wrap. As of
 108KMail 1.13.5 (KDE 4.5.4), KMail will apply word wrapping when sending
 109the email if the lines wrap in the composer window. Having word wrapping
 110disabled in the Options menu isn't enough. Thus, if your patch has very
 111long lines, you must make the composer window very wide before sending
 112the email. See: https://bugs.kde.org/show_bug.cgi?id=174034
 113
 114You can safely GPG sign attachments, but inlined text is preferred for
 115patches so do not GPG sign them.  Signing patches that have been inserted
 116as inlined text will make them tricky to extract from their 7-bit encoding.
 117
 118If you absolutely must send patches as attachments instead of inlining
 119them as text, right click on the attachment and select properties, and
 120highlight "Suggest automatic display" to make the attachment inlined to
 121make it more viewable.
 122
 123When saving patches that are sent as inlined text, select the email that
 124contains the patch from the message list pane, right click and select
 125"save as".  You can use the whole email unmodified as a patch if it was
 126properly composed.  There is no option currently to save the email when you
 127are actually viewing it in its own window -- there has been a request filed
 128at kmail's bugzilla and hopefully this will be addressed.  Emails are saved
 129as read-write for user only so you will have to chmod them to make them
 130group and world readable if you copy them elsewhere.
 131
 132~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133Lotus Notes (GUI)
 134
 135Run away from it.
 136
 137~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 138Mutt (TUI)
 139
 140Plenty of Linux developers use mutt, so it must work pretty well.
 141
 142Mutt doesn't come with an editor, so whatever editor you use should be
 143used in a way that there are no automatic linebreaks.  Most editors have
 144an "insert file" option that inserts the contents of a file unaltered.
 145
 146To use 'vim' with mutt:
 147  set editor="vi"
 148
 149  If using xclip, type the command
 150  :set paste
 151  before middle button or shift-insert or use
 152  :r filename
 153
 154if you want to include the patch inline.
 155(a)ttach works fine without "set paste".
 156
 157Config options:
 158It should work with default settings.
 159However, it's a good idea to set the "send_charset" to:
 160  set send_charset="us-ascii:utf-8"

  v2.6.16.19
  
    63
  64When com1posin16entation/email-clients.txt#L135" id="L135" class=line" nam1e="L65">  65should a1ppear1 and tPocumiledhaset prowding"trunca hrefissuains p href=sthments shation/email-clients.txt#L152" id="L152" class=6ine" name=="L16">  16
  67
  68~~~~~~~~1~~~~~1~~~~~~Ube c"DocumeDocuo set tches.
  69Evolutio1n (GU16entation/email-clients.txt#L140" id="L140" class=line" nam1e="L70">  70
  71Some peo1ple u17Send Flqunta-can ca-r
  72
  73When com1posin17entation/email-clients.txt#L154" id="L154" class=line" nam1e="L74">  74  from F1ormat17entation/email-clients.txt#L135" id="L135" class=line" nam1e="L75">  75  or the1 tool17~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  76
  17Don't "Doc17entation/email-clients.txt#L68" id="L68" class="1line" nam1e="L78">  78  Insert1->1ext Fi- Wuot;sentatchescumentat trick(mentaoptiof inliningation/email-clients.txt#L102" id="L102" class=line" nam1e="L79">  79to inser1t the1patch.- Alan st wor
  80
  81You can 1also 181t Fi- Wu editor,do TLS SMTPs.  h ohoulaactn-SSLunalnumentation/email-clients.txt#L102" id="L102" class=lpane, rige="L82">  82paste wi1th th18hitespaH
  83
  84~~~~~~~~1~~~~~18gt;HeadThere isnion/email-clients.txt#L102" id="L102" class=line" nam1e="L85">  85Kmail (G1UI)
<18entation/email-clients.txt#L146" id="L146" class=line" nam1e="L86">  86
  87Some peo1ple u18ef="Docck &qbirDocntation/email-clients.txt#L134" id="L134" class=line" nam1e="L88">  88
  89The defa1ult s1tting ofck &qbirDo in t Out    L89oof tentslikdail wmangleail thaents shlinebrewayaion/email-clients.txt#L158" id="L158" class=line" nam1e="L90">  90enable i1t.
  91
  92When com1posin192tch.- Alan st wor
  93disadvan1tage 1s any  ="Documentatsed.at tem.  s.
  94so you w1ill h19gt;Headnserts-bierocut;
  95way arou1nd th19r
  96it as a 1draft1 Once  TRL-R  97word-wra1pped 19uot;vi&Viewlt-n x"Documslt-n C creatzef="DRL-Rfints owDocument and smenth"Docuntation/email-clients.txt#L14" id="L14" class="lline" nam1e="L98">  98wrapping1.
  19
 100At the 2ottom2of youTf="Dntsnfigurensor
nts="Documocumeocut;
 101inserti2g you20entation/email-clients.txt#L92" id="L92" class="2"line" na2e="L102"> 102
 103Then fr2m the20 any  =Goil wnserts-
 104As an a2ded b20gt;Headtfck &qbirDo set tregistryt;
 105and put2the &205t;Headnsertse="hiumentation/email-clients.txt#L156" id="L156" class2"line" na2e="L106"> 106
 107Make th2 the 2ompose- Dns men; do ngt;Pre: Seot;.
 108KMail 1213.5 20entation/email-clients.txt#L89" id="L89" class="2"line" na2e="L109"> 109the ema2l if 20atch.- Eocumenumentaf="Dt;Prelect insode: Seot;.
 110disable2 in t21entation/email-clients.txt#L81" id="L81" class="2"line" na2e="L111"> 111long li2es, y211tch.- EocumenUTF8: Seot;.
 112the ema2l. Se2mentation/email-clients.txt#L13" id="L13" class="2"line" na2e="L113"> 113
 114You can2safel21gt;Head g/show_bure ons.mothis =1740tfck &qbirDure on/2351/ion/email-clients.txt#L29" id="L29" class="l"line" na2e="L115"> 115patches2so do215any  ="Don goil wnserts="Dohlt-n t dlse;rmat, then
 116as inli2ed te21Once  TRL-Rbrn sake tref="Dh filntat mail.xuloref=expectedt din t g the Eocumeion/email-clients.txt#L26" id="L26" class="l"line" na2e="L117"> 117
 118If you 2bsolu21entation/email-clients.txt#L89" id="L89" class="2"line" na2e="L119"> 119them as2text,2right ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  20Don'tt &qu2t;SuggTkRa ecntation/email-clients.txt#L134" id="L134" class2line" namee="L21">  21This can more 22entation/email-clients.txt#L92" id="L92" class="2line" name=="L22">  22
  23Email cliing p22entation/email-clients.txt#L154" id="L154" class2line" namee="L24">  24Emailed p the 22~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  25If you cove as2quot;.Gf="Do(Web ntation/email-clients.txt#L134" id="L134" class2lline" na2e="L26">  26you avoid comp22entation/email-clients.txt#L107" id="L107" class2line" namee="L27">  27
  28Email cli'22entation/email-clients.txt#L89" id="L89" class="2line" namee="L29">  29headers swrite2for usGf="Doweb "L89" .  Usingsto spalipboard,s.  Most ets otion/email-clients.txt#L102" id="L102" class2"line" na2e="L130"> 130group a2d wor2mentation/email-clients.txt#L31" id="L31" class="2"line" na2e="L131"> 131
 132~~~~~~~2~~~~~2~~~~~~ale&qughto s2"ocumentmail bconfltat s.
 133Lotus N2tes (23entation/email-clients.txt#L154" id="L154" class2"line" na2e="L134"> 134
 135Run awa2 from2it.
 136
 137~~~~~~~2~~~~~237t;Head ggggggggggggggggggggggggggggg###ion/email-clients.txt#L137" id="L137" class2"ine" namee="L138"> 138Mutt (T2I)