Commits

Juri Pakaste committed d988c7a

more explanation, syntax, example, merge config documentation in README

  • Participants
  • Parent commits 7f4b16c

Comments (0)

Files changed (1)

 About
 =====
 
-hg-status-sections provides a new flag for hg status, -s, that lists files in groups without a line prefix, like bzr does. The idea is to make it possible to triple-click on status lines in terminal to select the whole file name, regardless of what is contained in it.
+hg-status-sections provides a new command, ``hg sstatus``, as well as a flag for ``hg status``, ``-s``, that list files in groups without a line prefix, like bzr does. The idea is to make it possible to triple-click on status lines in terminal to select the whole file name, regardless of what is contained in it.
 
 Obviously if you're working with file names with embedded newlines this doesn't work.
 
+The extension also supports displaying merge status of files.
+
+Syntax
+======
+
+``hg status -s`` shows status in sections.
+
+``hg sstatus`` and ``hg sst`` do the same.
+
+Adding the option ``-M`` or ``--merge`` shows merge status.
+
+If you've configured merge status to be always on, you can override it with ``--no-merge``.
+
+Example
+=======
+
+::
+
+  $ hg sst
+  modified:
+    README.rst
+  unknown:
+    .#README.rst
+    README.txt~
+
 Installation
 ============
 
-Just store the this directory somewhere and add the following line to [extensions] in your ~/.hgrc:
+Just store the this directory somewhere and add the following line to ``[extensions]`` in your ``~/.hgrc``::
 
-statussections = ~/Path/to/sections-directory
+  statussections = ~/Path/to/sections-directory
+
+To configure merge status display to be automatically on, add::
+
+  [statussections]
+  showmerge = True
+
+Any non-blank value for ``showmerge`` is considered true.