diff doc/hgrc.5.txt @ 1258:1945754e466b

Add file encoding/decoding support
author mpm@selenic.com
date Thu, 15 Sep 2005 02:59:16 -0500
parents a425bb927ede
children a6ffcebd3315 2073e5a71008
line wrap: on
line diff
--- a/doc/hgrc.5.txt	Thu Sep 15 00:49:40 2005 -0500
+++ b/doc/hgrc.5.txt	Thu Sep 15 02:59:16 2005 -0500
@@ -61,6 +61,26 @@
 Mercurial "hgrc" file, the purpose of each section, its possible
 keys, and their possible values.
 
+decode/encode:: 
+  Filters for transforming files on checkout/checkin. This would
+  typically be used for newline processing or other
+  localization/canonicalization of files.
+
+  Filters consist of a filter pattern followed by a filter command.
+  The command must accept data on stdin and return the transformed
+  data on stdout.
+
+  Example:
+
+    [encode]
+    # uncompress gzip files on checkin to improve delta compression
+    # note: not necessarily a good idea, just an example
+    *.gz = gunzip
+
+    [decode]
+    # recompress gzip files when writing them to the working dir
+    *.gz = gzip
+
 hooks::
   Commands that get automatically executed by various actions such as
   starting or finishing a commit.