README_PATCHES.txt

   1 Patches Information
   2 ===================
   3
   4 The various patches, enhancements and downright replacements used to build
   5 the version of Git and supplementary software included in the Git OS X
   6 Installer are collected here.
   7
   8 For the files/patches included herein, some have explicit licenses embedded
   9 within them (typically GPLv2).  For the ones that do not explicitly mention
  10 a license the standard Git license applies -- this is especially true for
  11 any 'Signed-off-by' patches taken from the Git mailing list.  The standard
  12 Git license is GPLv2 ONLY.
  13
  14 Other files that do not have an explicit license and did not come from the
  15 Git mailing list are my own code and where the source file does not say
  16 otherwise are licensed under GPLv2 or, at your option, any later version.
  17
  18
  19 Git Patches
  20 -----------
  21
  22 * Use Mac OS X native API to show language translations
  23
  24   - `src/build-prefix.h`
  25   - `src/gettext.c`
  26   - `src/gettext-util.c`
  27   - `patches/git-sh-i18n-sh-git_gettext.diff`
  28   - `patches/git-gettext-failures.diff`
  29
  30 * Use libcurl for imap send
  31
  32   - `patches/km/git-imap-send_use_libcurl.txt`
  33
  34   This enables using CRAM-MD5 in an imap tunnel without needing OpenSSL.
  35
  36 * Use libcurl for send email
  37
  38   - `patches/km/git-send-email-libcurl.txt`
  39
  40   My own patches to make `git-send-email.perl` use libcurl instead of
  41   OpenSSL.  Has not been posted elsewhere.
  42
  43 * Support Tcl 8.4 for git-gui
  44
  45   - `patches/km/git-gui-tcl-8_4.txt`
  46
  47   My own patch to make git-gui actually work with Tcl 8.4 which is all
  48   it's supposed to require.  Posted to the list and picked up at:
  49   <http://thread.gmane.org/gmane.comp.version-control.git/262055>.
  50   Included in Git 2.4.0 now.
  51
  52 * Support auto threads detection on older OS X
  53
  54   - `patches/km/thread-utils-osx.txt`
  55
  56   My own patch to make thread-utils.c online_cpus function return the
  57   correct value on older Mac OS X versions.  Included in Git 2.4.0 now.
  58
  59 * Use a different pack.windowmemory default setting instead of 0
  60
  61   - `patches/km/window-memory-default.txt`
  62
  63   My own patch to change the pack.windowmemory default from 0 (meaning
  64   unlimited) to a sane default that should avoid memory thrashing especially
  65   when running gc --aggressive with a 64-bit address space.  Has not been
  66   posted elsewhere.
  67
  68 * Avoid PERL5LIB etc. variable conflicts
  69
  70   - `patches/km/no-perl-vars.txt`
  71
  72   My own patch to unset troublesome Perl environment variables before running
  73   subcommands.  This prevents incompatible PERL5LIB libraries from being picked
  74   up by Git's perl-based utilities.  Has not been posted elsewhere.
  75
  76 * Allow notes refs to be anywhere if given in full
  77
  78   - `patches/sc/any-notes-ref.txt`
  79   - `patches/km/any-notes-ref-tests.txt`
  80
  81   Both patches included in the thread and discussion at:
  82   <http://thread.gmane.org/gmane.comp.version-control.git/257281>.
  83
  84 * Backport contrib/hooks/pre-auto-gc-battery update
  85
  86   - `patches/pa/pre-auto-gc-newer-osx.txt`
  87
  88   A backport of c54c7b37 that first appeared in Git 2.4.6 that updates
  89   the checking for newer osxen.
  90
  91 * Improve usability of git-instaweb:
  92
  93   - `patches/instaweb/q/t_instaweb_subdir.diff`
  94   - `patches/instaweb/q/t_instaweb_highlight.diff`
  95   - `patches/instaweb/q/t_instaweb_mimetypes.diff`
  96   - `patches/instaweb/q/t_instaweb_defaults.diff`
  97   - `patches/instaweb/q/t_instaweb_git-browser.diff`
  98   - `patches/instaweb/q/t_instaweb_ipv6.diff`
  99   - `patches/instaweb/q/t_instaweb_fcgi.diff`
 100   - `patches/instaweb/q/t_instaweb_readme.diff`
 101
 102   My own patches to improve the usability of git instaweb by making it run
 103   from within a git checkout that is not at the top-level of the working tree,
 104   enable source highlighting if highlight is available, use the installed copy
 105   of mime.types (since there isn't such a file in OS X), enable pathinfo mode,
 106   blame and better rename detection, add a 'graphiclog' link to the pages that
 107   uses git-browser to show a graphic representation of commit ancestry, to bind
 108   to both IPv4 and IPv6 addresses and finally to enable readme blob display.
 109   The ipv6 patch is only effective when using lighttpd as the web server (which
 110   is the default).  The fcgi patch enables FCGI mode if the FCGI perl module is
 111   present.  Have not been posted elsewhere.
 112
 113 * Add submodule support to gitweb:
 114
 115   - `patches/gitweb/q/gitweb-find-project-dirs-with-.git-gitdir-links.diff`
 116
 117   My own patch to allow gitweb to find submodules that use gitdir links.  With
 118   this patch using git instaweb in a working tree that contains checked-out
 119   submodules makes it very easy to browse the submodules -- without the patch
 120   they are not listed in the gitweb projects list.  Has not been posted
 121   elsewhere.
 122
 123 * Various gitweb bug fixes / enhancements:
 124
 125 - `patches/gitweb/q/*.diff`
 126
 127   A selection of various patches from Girocco's [1] custom version of
 128   gitweb [2] that vastly improves the usability of git instaweb by making
 129   gitweb work so much better.
 130
 131   [1] <http://repo.or.cz/w/girocco.git>
 132   [2] <http://repo.or.cz/w/git/gitweb.git/blob/girocco:README_FIRST.txt>
 133
 134
 135 Curl Patches
 136 ------------
 137
 138 In order to provide compatibility with Mac OS X 10.4 AND web sites using
 139 SHA-256/SHA-384 hashes in their certificates, the version of libcurl that has
 140 been included as part of the Git OS X Installer uses the darwinssl backend
 141 that relies on Secure Transport instead of OpenSSL.
 142
 143 Unfortunately the released version of the darwinssl backend has many
 144 deficiencies that make it unsuitable for use as a replacement when users are
 145 expecting to be able to provide multiple client certificates possibly combined
 146 with an RSA private key all in PEM format.
 147
 148 Additionally the as-released darwinssl backend doesn't really work on older
 149 Mac OS X versions as-is.  Oh it may compile on Mac OS X 10.5 without complaints
 150 but it immediately crashes and burns when one tries to use it.  And it does not
 151 support Mac OS X 10.4 at all as released.
 152
 153 * Curl darwinssl backend universal Mac OS X compatibility
 154
 155   - `patches/curl/curl_darwinssl_macosx.c`
 156   - `patches/curl/stcompat.c`
 157   - `patches/curl/stcompat.h`
 158   - `patches/curl/q/t_ntlm_no-one-shot.diff`
 159   - `patches/curl/q/t_securetransport_extra-data.diff`
 160   - `patches/curl/q/t_pinning_darwin.diff`
 161   - `patches/curl/q/t_pinning_dummy-key.diff`
 162
 163 * Curl mk-ca-bundle script improvements
 164
 165   - `patches/curl/q/t_mk-ca-bundle_improvements.diff`
 166
 167
 168 Lighttpd Patches
 169 ----------------
 170
 171 * Allow the darwin sendfile function to be used
 172
 173   - `patches/lighttpd/q/t_darwin_sendfile.diff`
 174
 175 * Avoid spurious testing failures on darwin
 176
 177   - `patches/lighttpd/q/t_darwin_no-test-shutdown.diff`
 178
 179
 180 GnuPG Patches
 181 -------------
 182
 183 The standard build of gpg does not allow one to create any keys with bit
 184 lengths larger than 4096 bits.  (Once created, existing versions of gpg can
 185 use such a key without problems.)  However, according to NIST 800-57, a RSA key
 186 3072 bits in length only provides 128 bits of security strength.  In order to
 187 comply with NIST policy on the use of AES to protect national information and
 188 meet the TOP SECRET requirements a security strength of at least 192 bits is
 189 required.  That necessitates an RSA key of 7680 bits (see NIST 800-57).  Hence
 190 the gpg patch to permit creation of such keys.
 191
 192 * Always allow larger RSA keys up to 16384 bits to be created
 193
 194   - `patches/gnupg/q/t_gnupg_longer-keys.diff`
 195
 196 * Make trailing ":pid:protocol" part of GPG_AGENT_INFO optional (launchd)
 197
 198   - `patches/gnupg/q/t_launchd_agent-compat.diff`
 199
 200
 201 Compatibility Patches
 202 ---------------------
 203
 204 Other than the giant Curl darwinssl backend patch, some other compatibility
 205 patches are needed in order to build for Mac OS X 10.4 without losing any
 206 functionality.
 207
 208 These consist of the remaining files in the include and src subdirectories
 209 and provide the following compatibility fixes:
 210
 211 * Curl support for NTLM on Mac OS X 10.4
 212
 213   Special thanks to Libtomcrypt <http://libtom.org/> for providing a public
 214   domain version of DES needed to make this work.
 215
 216 * Git support CRAM-MD5 when `git-imap-send` is using a tunnel
 217
 218   This is really just some glue and an implementation of HMAC MD5 based
 219   on RFC 2104 that uses the OS X Common Crypto MD5 hash implementation.
 220
 221 * GnuPG support using libedit instead of libreadline
 222
 223   This is just some simplistic linker glue (`src/gnupgcompat.c`) and a clever
 224   compiler prefix file (`src/gnupg-prefix.h`).
 225
 226
 227 Other Stuff
 228 -----------
 229
 230 For the neophyte using gpg the first time can be rather intimidating.  To this
 231 end a copy of the GNU Privacy Handbook has been included here in doc/gnupg.  It
 232 has not been modified and was simply copied from the original location at
 233 <https://www.gnupg.org/gph/en/manual.html>.