patches: use the correct plural translation form for French

[git-osx-installer.git] / README_PATCHES.txt

Patches Information
===================

The various patches, enhancements and downright replacements used to build
the version of Git and supplementary software included in the Git OS X
Installer are collected here.

For the files/patches included herein, some have explicit licenses embedded
within them (typically GPLv2).  For the ones that do not explicitly mention
a license the standard Git license applies -- this is especially true for
any 'Signed-off-by' patches taken from the Git mailing list.  The standard
Git license is GPLv2 ONLY.

Other files that do not have an explicit license and did not come from the
Git mailing list are my own code and where the source file does not say
otherwise are licensed under GPLv2 or, at your option, any later version.


Git Patches
-----------

* Use Mac OS X native API to show language translations

  - `src/build-prefix.h`
  - `src/gettext.c`
  - `src/gettext-util.c`
  - `patches/git-sh-i18n-sh-git_gettext.diff`
  - `patches/git-gettext-failures.diff`

* Use libcurl for imap send

  - `patches/km/git-imap-send_use_libcurl.txt`

  This enables using CRAM-MD5 in an imap tunnel without needing OpenSSL.

* Use libcurl for send email

  - `patches/km/git-send-email-libcurl.txt`

  My own patches to make `git-send-email.perl` use libcurl instead of
  OpenSSL.  Has not been posted elsewhere.

* Support Tcl 8.4 for git-gui

  - `patches/km/git-gui-tcl-8_4.txt`

  My own patch to make git-gui actually work with Tcl 8.4 which is all
  it's supposed to require.  Posted to the list and picked up at:
  <http://thread.gmane.org/gmane.comp.version-control.git/262055>.
  Included in Git 2.4.0 now.

* Support auto threads detection on older OS X

  - `patches/km/thread-utils-osx.txt`

  My own patch to make thread-utils.c online_cpus function return the
  correct value on older Mac OS X versions.  Included in Git 2.4.0 now.

* Use a different pack.windowmemory default setting instead of 0

  - `patches/km/window-memory-default.txt`

  My own patch to change the pack.windowmemory default from 0 (meaning
  unlimited) to a sane default that should avoid memory thrashing especially
  when running gc --aggressive with a 64-bit address space.  Has not been
  posted elsewhere.

* Avoid PERL5LIB etc. variable conflicts

  - `patches/km/no-perl-vars.txt`

  My own patch to unset troublesome Perl environment variables before running
  subcommands.  This prevents incompatible PERL5LIB libraries from being picked
  up by Git's perl-based utilities.  Has not been posted elsewhere.

* Allow notes refs to be anywhere if given in full

  - `patches/sc/any-notes-ref.txt`
  - `patches/km/any-notes-ref-tests.txt`

  Both patches included in the thread and discussion at:
  <http://thread.gmane.org/gmane.comp.version-control.git/257281>.

* Backport contrib/hooks/pre-auto-gc-battery update

  - `patches/pa/pre-auto-gc-newer-osx.txt`

  A backport of c54c7b37 that first appeared in Git 2.4.6 that updates
  the checking for newer osxen.

* Improve usability of git-instaweb:

  - `patches/instaweb/q/t_instaweb_subdir.diff`
  - `patches/instaweb/q/t_instaweb_highlight.diff`
  - `patches/instaweb/q/t_instaweb_mimetypes.diff`
  - `patches/instaweb/q/t_instaweb_defaults.diff`
  - `patches/instaweb/q/t_instaweb_git-browser.diff`
  - `patches/instaweb/q/t_instaweb_ipv6.diff`
  - `patches/instaweb/q/t_instaweb_fcgi.diff`
  - `patches/instaweb/q/t_instaweb_readme.diff`
  - `patches/instaweb/q/t_instaweb_default-to-local.diff`
  - `patches/instaweb/q/t_instaweb_no-kill-nothing.diff`
  - `patches/instaweb/q/t_instaweb_auto-port.diff`

  My own patches to improve the usability of git instaweb by making it run
  from within a git checkout that is not at the top-level of the working tree,
  enable source highlighting if highlight is available, use the installed copy
  of mime.types (since there isn't such a file in OS X), enable pathinfo mode,
  blame and better rename detection, add a 'graphiclog' link to the pages that
  uses git-browser to show a graphic representation of commit ancestry, to bind
  to both IPv4 and IPv6 addresses and browse to localhost instead of 127.0.0.1,
  to enable readme blob display, to default to binding only to the localhost
  address if `instaweb.local` has not been set at all, to avoid attempting to
  kill using a process id of "" and finally to attempt to automatically select
  an available port to listen on if one was not specified and the first chosen
  port is not available.  The ipv6 patch is only effective when using lighttpd
  as the web server (which is the default).  The fcgi patch enables FCGI mode
  if the FCGI perl module is present.  Have not been posted elsewhere.

* Add submodule support to gitweb:

  - `patches/gitweb/q/gitweb-find-project-dirs-with-.git-gitdir-links.diff`

  My own patch to allow gitweb to find submodules that use gitdir links.  With
  this patch using git instaweb in a working tree that contains checked-out
  submodules makes it very easy to browse the submodules -- without the patch
  they are not listed in the gitweb projects list.  Has not been posted
  elsewhere.

* Various gitweb bug fixes / enhancements:

- `patches/gitweb/q/*.diff`

  A selection of various patches from Girocco's [1] custom version of
  gitweb [2] that vastly improves the usability of git instaweb by making
  gitweb work so much better.

  [1] <http://repo.or.cz/w/girocco.git>  
  [2] <http://repo.or.cz/w/git/gitweb.git/blob/girocco:README_FIRST.txt>


Curl Patches
------------

In order to provide compatibility with Mac OS X 10.4 AND web sites using
SHA-256/SHA-384 hashes in their certificates, the version of libcurl that has
been included as part of the Git OS X Installer uses the darwinssl backend
that relies on Secure Transport instead of OpenSSL.

Unfortunately the released version of the darwinssl backend has many
deficiencies that make it unsuitable for use as a replacement when users are
expecting to be able to provide multiple client certificates possibly combined
with an RSA private key all in PEM format.

Additionally the as-released darwinssl backend doesn't really work on older
Mac OS X versions as-is.  Oh it may compile on Mac OS X 10.5 without complaints
but it immediately crashes and burns when one tries to use it.  And it does not
support Mac OS X 10.4 at all as released.

* Curl darwinssl backend universal Mac OS X compatibility

  - `patches/curl/curl_darwinssl_macosx.c`
  - `patches/curl/stcompat.c`
  - `patches/curl/stcompat.h`
  - `patches/curl/q/t_ntlm_no-one-shot.diff`
  - `patches/curl/q/t_securetransport_extra-data.diff`
  - `patches/curl/q/t_pinning_darwin.diff`
  - `patches/curl/q/t_pinning_dummy-key.diff`

* Curl mk-ca-bundle script improvements

  - `patches/curl/q/t_mk-ca-bundle_improvements.diff`


Lighttpd Patches
----------------

* Allow the darwin sendfile function to be used

  - `patches/lighttpd/q/t_darwin_sendfile.diff`

* Avoid spurious testing failures on darwin

  - `patches/lighttpd/q/t_darwin_no-test-shutdown.diff`

* Avoid testing unsupported crypt md5 on darwin

  - `patches/lighttpd/q/t_darwin_no-crypt-md5.diff`

* Show the correct crypt status in -V output

  - `patches/lighttpd/q/t_features_crypt.diff`

* Properly zero sockaddr structures before use

  - `patches/lighttpd/q/t_net_zero-sockaddr.diff`

* Provide an idle timeout option

  - `patches/lighttpd/q/t_server_idle-timeout.diff`

* A couple of other lighttpd patches are included to
  avoid having to maintain multiple patch series, but
  their changes are not relevant to the Git OS X Installer.


GnuPG Patches
-------------

The standard build of gpg does not allow one to create any keys with bit
lengths larger than 4096 bits.  (Once created, existing versions of gpg can
use such a key without problems.)  However, according to NIST 800-57, a RSA key
3072 bits in length only provides 128 bits of security strength.  In order to
comply with NIST policy on the use of AES to protect national information and
meet the TOP SECRET requirements a security strength of at least 192 bits is
required.  That necessitates an RSA key of 7680 bits (see NIST 800-57).  Hence
the gpg patch to permit creation of such keys.

* Always allow larger RSA keys up to 16384 bits to be created

  - `patches/gnupg/q/t_gnupg_longer-keys.diff`

* Make trailing ":pid:protocol" part of GPG_AGENT_INFO optional (launchd)

  - `patches/gnupg/q/t_launchd_agent-compat.diff`


Compatibility Patches
---------------------

Other than the giant Curl darwinssl backend patch, some other compatibility
patches are needed in order to build for Mac OS X 10.4 without losing any
functionality.

These consist of the remaining files in the include and src subdirectories
and provide the following compatibility fixes:

* Curl support for NTLM on Mac OS X 10.4

  Special thanks to Libtomcrypt <http://libtom.org/> for providing a public
  domain version of DES needed to make this work.

* Git support CRAM-MD5 when `git-imap-send` is using a tunnel

  This is really just some glue and an implementation of HMAC MD5 based
  on RFC 2104 that uses the OS X Common Crypto MD5 hash implementation.

* GnuPG support using libedit instead of libreadline

  This is just some simplistic linker glue (`src/gnupgcompat.c`) and a clever
  compiler prefix file (`src/gnupg-prefix.h`).


Other Stuff
-----------

For the neophyte using gpg the first time can be rather intimidating.  To this
end a copy of the GNU Privacy Handbook has been included here in doc/gnupg.  It
has not been modified and was simply copied from the original location at
<https://www.gnupg.org/gph/en/manual.html>.