.gitattributes

   1 # ensure LF endings on all checkouts
   2 configure.ac    crlf=input
   3 config.rpath    crlf=input
   4 configure.host  crlf=input
   5 mkinstalldirs   crlf=input
   6 *.sh    crlf=input
   7 *.sources       crlf=input
   8 .gitattributes  crlf=input
   9 *akefile*       crlf=input
  10
  11 # ensure native line endings on checkout
  12 *.c     crlf
  13 *.h     crlf
  14 *.cs    crlf
  15 *.il    crlf
  16 *.sln           crlf
  17 *.*proj*        crlf
  18
  19 # don't do anything to line-endings.  Let CRLFs/LFs go into the repo, and CRLF/LFs on checkout
  20 *.bat           -crlf
  21 *.xml           -crlf
  22
  23 # CRLF Handling
  24 # -------------
  25 #
  26 # The ideal situation would be to do no EOL normalization.  Each file
  27 # would have a default EOL, and tools on Windows and Linux would handle
  28 # both EOL formats.
  29 #
  30 # We're not in the ideal world.  A popular editor on Windows (possibly
  31 # Visual Studio) silently introduces EOL corruption -- it displays an
  32 # LF-file normally, but any newly added lines have CRLF.  On Linux,
  33 # Emacs and versions of VI handle LF-files and CRLF-files properly.
  34 # However, emacs doesn't like files with both LF and CRLF EOLs.  Editing
  35 # the file without additional action will increase the EOL corruption
  36 # in the file.
  37 #
  38 # Another vector for mixed EOLs is scripts.  We mostly don't have scripts
  39 # that add new lines -- so we rarely see this.  However, one major event
  40 # in the tree was the addition of copyright headers using a script.  That
  41 # script introduced EOL corruption.
  42 #
  43 # Any automated EOL normalization of files already in the repository will
  44 # cause difficulties in traversing histories, assigning blame, etc.  So, we
  45 # don't want to change what's in the repository significantly, even if it
  46 # causes trouble.
  47 #
  48 # What we do now:
  49 #
  50 # a) we ensure that there's no further corruption of LF-files.  So, we use
  51 #    git's 'crlf' attribute on those files to ensure that things are fine
  52 #    when we work on Windows.  We could use 'crlf=input', but it doesn't buy
  53 #    us much -- we might as well be working with consistent EOLs for files in
  54 #    working directories as well as in the repository
  55 #
  56 # b) if the file already of CRLFs, we don't do any normalization.  We use '-crlf'
  57 #    so that git doesn't do any EOL-conversion of the file.  As I said, this
  58 #    is mostly harmless on Linux.  We can't mark these files as 'crlf' or use
  59 #    the new (git 1.7.2) 'eol=crlf' attribute, since it changes the contents
  60 #    _inside_ the repository [1], and hence makes history traversal annoying.
  61 #    So, we live with occasional EOL corruption.
  62 #
  63 # c) We can handle mixed-EOL files on a case-by-case basis, converting them to
  64 #    LF- or CRLF-files based on which causes fewer lines to change
  65 #
  66 # d) We try to ensure no further headaches, by declaring EOL normalization on
  67 #    code files, and Unix-flavoured files, like shell-scripts, makefiles, etc.
  68 #
  69 # [1] GIT use LFs as the normalized internal representation.