Merge tag '4.4-additional' of git://git.lwn.net/linux
authorLinus Torvalds <torvalds@linux-foundation.org>
Fri, 13 Nov 2015 17:19:05 +0000 (09:19 -0800)
committerLinus Torvalds <torvalds@linux-foundation.org>
Fri, 13 Nov 2015 17:19:05 +0000 (09:19 -0800)
Pull more documentation updates from Jon Corbet:
 "A few more documentation patches that wandered in and have no reason
  to wait; these include some improvements to the suggestions for email
  clients and patch submission"

* tag '4.4-additional' of git://git.lwn.net/linux:
  Documentation: Add minimal Mutt config for using Gmail
  Documentation: Add note on sending files directly with Mutt
  Documentation: dontdiff: remove media from dontdiff
  Documentation/SubmittingPatches: discuss In-Reply-To
  Remove email address from Documentation/filesystems/overlayfs.txt
  can-doc: Add missing semicolon to example

1  2 
Documentation/SubmittingPatches
Documentation/email-clients.txt
Documentation/networking/can.txt

index 4710e4afef19c40b146e50c9fedff8b9fc308ead,0db4e106fbf027e0b063fc4497eeb418d2936256..d603fa07823598b87dc48d0e8362a6fcb5a57a32
@@@ -659,8 -659,8 +659,8 @@@ succinct and descriptive, but that is w
  should do.
  
  The "summary phrase" may be prefixed by tags enclosed in square
 -brackets: "Subject: [PATCH tag] <summary phrase>".  The tags are not
 -considered part of the summary phrase, but describe how the patch
 +brackets: "Subject: [PATCH <tag>...] <summary phrase>".  The tags are
 +not considered part of the summary phrase, but describe how the patch
  should be treated.  Common tags might include a version descriptor if
  the multiple versions of the patch have been sent out in response to
  comments (i.e., "v1, v2, v3"), or "RFC" to indicate a request for
@@@ -672,8 -672,8 +672,8 @@@ the patch series
  
  A couple of example Subjects:
  
 -    Subject: [patch 2/5] ext2: improve scalability of bitmap searching
 -    Subject: [PATCHv2 001/207] x86: fix eflags tracking
 +    Subject: [PATCH 2/5] ext2: improve scalability of bitmap searching
 +    Subject: [PATCH v2 01/27] x86: fix eflags tracking
  
  The "from" line must be the very first line in the message body,
  and has the form:
@@@ -718,8 -718,21 +718,21 @@@ generates appropriate diffstats by defa
  See more details on the proper patch format in the following
  references.
  
+ 15) Explicit In-Reply-To headers
+ --------------------------------
+ It can be helpful to manually add In-Reply-To: headers to a patch
+ (e.g., when using "git send email") to associate the patch with
+ previous relevant discussion, e.g. to link a bug fix to the email with
+ the bug report.  However, for a multi-patch series, it is generally
+ best to avoid using In-Reply-To: to link to older versions of the
+ series.  This way multiple versions of the patch don't become an
+ unmanageable forest of references in email clients.  If a link is
+ helpful, you can use the https://lkml.kernel.org/ redirector (e.g., in
+ the cover email text) to link to an earlier version of the patch series.
  
- 15) Sending "git pull" requests
+ 16) Sending "git pull" requests
  -------------------------------
  
  If you have a series of patches, it may be most convenient to have the
index aba85b39a40096872bc67b4e0303a381ec74693d,a6e91506fd886e1186349f35ff06534dbe2e1f30..2d485dea8cece79d7a2db645a3011a27c76c47b4
@@@ -176,11 -176,47 +176,47 @@@ To use 'vim' with mutt
  if you want to include the patch inline.
  (a)ttach works fine without "set paste".
  
+ You can also generate patches with 'git format-patch' and then use Mutt
+ to send them:
+     $ mutt -H 0001-some-bug-fix.patch
  Config options:
  It should work with default settings.
  However, it's a good idea to set the "send_charset" to:
    set send_charset="us-ascii:utf-8"
  
+ Mutt is highly customizable. Here is a minimum configuration to start
+ using Mutt to send patches through Gmail:
+ # .muttrc
+ # ================  IMAP ====================
+ set imap_user = 'yourusername@gmail.com'
+ set imap_pass = 'yourpassword'
+ set spoolfile = imaps://imap.gmail.com/INBOX
+ set folder = imaps://imap.gmail.com/
+ set record="imaps://imap.gmail.com/[Gmail]/Sent Mail"
+ set postponed="imaps://imap.gmail.com/[Gmail]/Drafts"
+ set mbox="imaps://imap.gmail.com/[Gmail]/All Mail"
+ # ================  SMTP  ====================
+ set smtp_url = "smtp://username@smtp.gmail.com:587/"
+ set smtp_pass = $imap_pass
+ set ssl_force_tls = yes # Require encrypted connection
+ # ================  Composition  ====================
+ set editor = `echo \$EDITOR`
+ set edit_headers = yes  # See the headers when editing
+ set charset = UTF-8     # value of $LANG; also fallback for send_charset
+ # Sender, email address, and sign-off line must match
+ unset use_domain        # because joe@localhost is just embarrassing
+ set realname = "YOUR NAME"
+ set from = "username@gmail.com"
+ set use_from = yes
+ The Mutt docs have lots more information:
+     http://dev.mutt.org/trac/wiki/UseCases/Gmail
+     http://dev.mutt.org/doc/manual.html
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  Pine (TUI)
  
@@@ -220,7 -256,7 +256,7 @@@ to coerce it into behaving
    Compose dialog.
  
    Please note that "external editor" requires that your editor must not
 -  fork, or in other words, the editor must not return before closing. 
 +  fork, or in other words, the editor must not return before closing.
    You may have to pass additional flags or change the settings of your
    editor. Most notably if you are using gvim then you must pass the -f
    option to gvim by putting "/usr/bin/gvim -f" (if the binary is in
index 4636b94518da706012dc0677ef9fc6bd5265b1f4,957e3a4388a8bbe7352fb456b7d02ff24e11b83d..05fd83bb35967a2d92c9fac588a15fb2b3532beb
@@@ -681,7 -681,7 +681,7 @@@ solution for a couple of reasons
      addr.can_family = AF_CAN;
      addr.can_ifindex = ifr.ifr_ifindex;
  
-     connect(s, (struct sockaddr *)&addr, sizeof(addr))
+     connect(s, (struct sockaddr *)&addr, sizeof(addr));
  
      (..)
  
  
      $ ip link set can0 type can help
      Usage: ip link set DEVICE type can
 -      [ bitrate BITRATE [ sample-point SAMPLE-POINT] ] |
 -      [ tq TQ prop-seg PROP_SEG phase-seg1 PHASE-SEG1
 -        phase-seg2 PHASE-SEG2 [ sjw SJW ] ]
 -
 -      [ loopback { on | off } ]
 -      [ listen-only { on | off } ]
 -      [ triple-sampling { on | off } ]
 -
 -      [ restart-ms TIME-MS ]
 -      [ restart ]
 -
 -      Where: BITRATE       := { 1..1000000 }
 -             SAMPLE-POINT  := { 0.000..0.999 }
 -             TQ            := { NUMBER }
 -             PROP-SEG      := { 1..8 }
 -             PHASE-SEG1    := { 1..8 }
 -             PHASE-SEG2    := { 1..8 }
 -             SJW           := { 1..4 }
 -             RESTART-MS    := { 0 | NUMBER }
 +        [ bitrate BITRATE [ sample-point SAMPLE-POINT] ] |
 +        [ tq TQ prop-seg PROP_SEG phase-seg1 PHASE-SEG1
 +          phase-seg2 PHASE-SEG2 [ sjw SJW ] ]
 +
 +        [ dbitrate BITRATE [ dsample-point SAMPLE-POINT] ] |
 +        [ dtq TQ dprop-seg PROP_SEG dphase-seg1 PHASE-SEG1
 +          dphase-seg2 PHASE-SEG2 [ dsjw SJW ] ]
 +
 +        [ loopback { on | off } ]
 +        [ listen-only { on | off } ]
 +        [ triple-sampling { on | off } ]
 +        [ one-shot { on | off } ]
 +        [ berr-reporting { on | off } ]
 +        [ fd { on | off } ]
 +        [ fd-non-iso { on | off } ]
 +        [ presume-ack { on | off } ]
 +
 +        [ restart-ms TIME-MS ]
 +        [ restart ]
 +
 +        Where: BITRATE       := { 1..1000000 }
 +               SAMPLE-POINT  := { 0.000..0.999 }
 +               TQ            := { NUMBER }
 +               PROP-SEG      := { 1..8 }
 +               PHASE-SEG1    := { 1..8 }
 +               PHASE-SEG2    := { 1..8 }
 +               SJW           := { 1..4 }
 +               RESTART-MS    := { 0 | NUMBER }
  
    - Display CAN device details and statistics:
  
    The CAN device MTU can be retrieved e.g. with a SIOCGIFMTU ioctl() syscall.
    N.B. CAN FD capable devices can also handle and send legacy CAN frames.
  
 -  FIXME: Add details about the CAN FD controller configuration when available.
 +  When configuring CAN FD capable CAN controllers an additional 'data' bitrate
 +  has to be set. This bitrate for the data phase of the CAN FD frame has to be
 +  at least the bitrate which was configured for the arbitration phase. This
 +  second bitrate is specified analogue to the first bitrate but the bitrate
 +  setting keywords for the 'data' bitrate start with 'd' e.g. dbitrate,
 +  dsample-point, dsjw or dtq and similar settings. When a data bitrate is set
 +  within the configuration process the controller option "fd on" can be
 +  specified to enable the CAN FD mode in the CAN controller. This controller
 +  option also switches the device MTU to 72 (CANFD_MTU).
 +
 +  The first CAN FD specification presented as whitepaper at the International
 +  CAN Conference 2012 needed to be improved for data integrity reasons.
 +  Therefore two CAN FD implementations have to be distinguished today:
 +
 +  - ISO compliant:     The ISO 11898-1:2015 CAN FD implementation (default)
 +  - non-ISO compliant: The CAN FD implementation following the 2012 whitepaper
 +
 +  Finally there are three types of CAN FD controllers:
 +
 +  1. ISO compliant (fixed)
 +  2. non-ISO compliant (fixed, like the M_CAN IP core v3.0.1 in m_can.c)
 +  3. ISO/non-ISO CAN FD controllers (switchable, like the PEAK PCAN-USB FD)
 +
 +  The current ISO/non-ISO mode is announced by the CAN controller driver via
 +  netlink and displayed by the 'ip' tool (controller option FD-NON-ISO).
 +  The ISO/non-ISO-mode can be altered by setting 'fd-non-iso {on|off}' for
 +  switchable CAN FD controllers only.
 +
 +  Example configuring 500 kbit/s arbitration bitrate and 4 Mbit/s data bitrate:
 +
 +    $ ip link set can0 up type can bitrate 500000 sample-point 0.75 \
 +                                   dbitrate 4000000 dsample-point 0.8 fd on
 +    $ ip -details link show can0
 +    5: can0: <NOARP,UP,LOWER_UP,ECHO> mtu 72 qdisc pfifo_fast state UNKNOWN \
 +             mode DEFAULT group default qlen 10
 +    link/can  promiscuity 0
 +    can <FD> state ERROR-ACTIVE (berr-counter tx 0 rx 0) restart-ms 0
 +          bitrate 500000 sample-point 0.750
 +          tq 50 prop-seg 14 phase-seg1 15 phase-seg2 10 sjw 1
 +          pcan_usb_pro_fd: tseg1 1..64 tseg2 1..16 sjw 1..16 brp 1..1024 \
 +          brp-inc 1
 +          dbitrate 4000000 dsample-point 0.800
 +          dtq 12 dprop-seg 7 dphase-seg1 8 dphase-seg2 4 dsjw 1
 +          pcan_usb_pro_fd: dtseg1 1..16 dtseg2 1..8 dsjw 1..4 dbrp 1..1024 \
 +          dbrp-inc 1
 +          clock 80000000
 +
 +  Example when 'fd-non-iso on' is added on this switchable CAN FD adapter:
 +   can <FD,FD-NON-ISO> state ERROR-ACTIVE (berr-counter tx 0 rx 0) restart-ms 0
  
    6.7 Supported CAN hardware