Merge lp:~gary-wilson/bzr/eol-doc into lp:~bzr/bzr/trunk-old

[Gary Wilson]

[Gary Wilson (gary-wilson)]

Edits to the EOL documentation to use inline literals for "lf" and "clrf" where not already being used.

[Robert Collins (lifeless)]

 review approve

review: Approve

[Ian Clatworthy (ian-clatworthy)]

Thanks.

review: Approve

=== modified file 'bzrlib/help_topics/en/eol.txt'
--- bzrlib/help_topics/en/eol.txt	2009-04-02 04:12:11 +0000
+++ bzrlib/help_topics/en/eol.txt	2009-05-13 07:35:23 +0000
@@ -14,17 +14,17 @@
 To configure which files to filter, set ``eol`` to one of the values below.
 (If a value is not set, ``exact`` is the default.)
 
- ============== ============================== ======================
- Value          Checkout end-of-lines as       Commit end-of-lines as
- ============== ============================== ======================
- native         crlf on Windows, lf otherwise  lf
- -------------- ------------------------------ ----------------------
- lf             lf                             lf
- -------------- ------------------------------ ----------------------
- crlf           crlf                           lf
- -------------- ------------------------------ ----------------------
- exact          No conversion                  exactly as in file
- ============== ============================== ======================
+ ========== ===================================== ======================
+ Value      Checkout end-of-lines as              Commit end-of-lines as
+ ========== ===================================== ======================
+ ``native`` ``crlf`` on Windows, ``lf`` otherwise ``lf``
+ ---------- ------------------------------------- ----------------------
+ ``lf``     ``lf``                                ``lf``
+ ---------- ------------------------------------- ----------------------
+ ``crlf``   ``crlf``                              ``lf``
+ ---------- ------------------------------------- ----------------------
+ ``exact``  No conversion                         Exactly as in file
+ ========== ===================================== ======================
 
 Note: For safety reasons, no conversion is applied to any file where a null
 byte is detected in the file.
@@ -82,20 +82,21 @@
 supported yet.)
 
 If you have an existing repository with text files already stored using
-Windows newline conventions (crlf), then you may want to keep using that
+Windows newline conventions (``crlf``), then you may want to keep using that
 convention in the repository. Forcing certain files to this convention
 may also help users who do not have rules configured. To do this, set
 ``eol`` to one of the values below.
 
- ========================= ============================== ======================
- Value                     Checkout end-of-lines as       Commit end-of-lines as
- ========================= ============================== ======================
- native-with-crlf-in-repo  crlf on Windows, lf otherwise  crlf
- ------------------------- ------------------------------ ----------------------
- lf-with-crlf-in-repo      lf                             crlf
- ------------------------- ------------------------------ ----------------------
- crlf-with-crlf-in-repo    crlf                           crlf
- ========================= ============================== ======================
+ ============================ ======================== ======================
+ Value                        Checkout end-of-lines as Commit end-of-lines as
+ ============================ ======================== ======================
+ ``native-with-crlf-in-repo`` ``crlf`` on Windows,     ``crlf``
+                              ``lf`` otherwise
+ ---------------------------- ------------------------ ----------------------
+ ``lf-with-crlf-in-repo``     ``lf``                   ``crlf``
+ ---------------------------- ------------------------ ----------------------
+ ``crlf-with-crlf-in-repo``   ``crlf``                 ``crlf``
+ ============================ ======================== ======================
 
 For users working on an existing project that uses Windows newline
 conventions in their Bazaar repository, this rule is suggested as a
@@ -104,7 +105,7 @@
   [name *]
   eol = native-with-crlf-in-repo
 
-For new projects, it is recommended that end-of-lines be stored as lf
+For new projects, it is recommended that end-of-lines be stored as ``lf``
 and that users stick to the basic settings, i.e. ``native``, ``lf``,
 ``crlf`` and ``exact``.