eol: document new eol.fix-trailing-newline setting
authorMartin Geisler <mg@aragost.com>
Thu, 07 Jul 2011 12:13:07 +0200
changeset 14856 9f5cd6b6d758
parent 14855 f33579435378
child 14857 5b46c16e7121
eol: document new eol.fix-trailing-newline setting
hgext/eol.py
--- a/hgext/eol.py	Fri Jul 01 23:12:52 2011 +0400
+++ b/hgext/eol.py	Thu Jul 07 12:13:07 2011 +0200
@@ -52,9 +52,10 @@
    The rules will first apply when files are touched in the working
    copy, e.g. by updating to null and back to tip to touch all files.
 
-The extension uses an optional ``[eol]`` section in your hgrc file
-(not the ``.hgeol`` file) for settings that control the overall
-behavior. There are two settings:
+The extension uses an optional ``[eol]`` section read from both the
+normal Mercurial configuration files and the ``.hgeol`` file, with the
+latter overriding the former. You can use that section to control the
+overall behavior. There are three settings:
 
 - ``eol.native`` (default ``os.linesep``) can be set to ``LF`` or
   ``CRLF`` to override the default interpretation of ``native`` for
@@ -67,6 +68,10 @@
   Such files are normally not touched under the assumption that they
   have mixed EOLs on purpose.
 
+- ``eol.fix-trailing-newline`` (default False) can be set to True to
+  ensure that converted files end with a EOL character (either ``\n``
+  or ``\r\n`` as per the configured patterns).
+
 The extension provides ``cleverencode:`` and ``cleverdecode:`` filters
 like the deprecated win32text extension does. This means that you can
 disable win32text and enable eol and your filters will still work. You