changeset 32137:c4eb23116a09 stable

help: document color/pager pitfalls on Windows Even though I figured this out a few weeks ago, I was initially puzzled where the color went when I upgraded to 4.2 on a different Windows machine. Let's point users reading the help into the right direction. I wonder if we should be even more explicit about cmd.exe/MSYS/pager/color interplay, but at least all of the breadcrumbs are here (I think).
author Matt Harbison <matt_harbison@yahoo.com>
date Wed, 03 May 2017 21:58:11 -0400
parents 1add41fc3c62
children edbbd18a47ab
files mercurial/help/color.txt mercurial/help/pager.txt
diffstat 2 files changed, 14 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/mercurial/help/color.txt	Tue May 02 22:26:09 2017 -0400
+++ b/mercurial/help/color.txt	Wed May 03 21:58:11 2017 -0400
@@ -17,6 +17,13 @@
 
 See :hg:`help config.ui.color` for details.
 
+.. container:: windows
+
+  The default pager on Windows does not support color, so enabling the pager
+  will effectively disable color.  See :hg:`help config.ui.paginate` to disable
+  the pager.  Alternately, MSYS and Cygwin shells provide `less` as a pager,
+  which can be configured to support ANSI color mode.
+
 Mode
 ====
 
--- a/mercurial/help/pager.txt	Tue May 02 22:26:09 2017 -0400
+++ b/mercurial/help/pager.txt	Wed May 03 21:58:11 2017 -0400
@@ -10,6 +10,13 @@
 $PAGER. If neither pager.pager, nor $PAGER is set, a default pager
 will be used, typically `less` on Unix and `more` on Windows.
 
+.. container:: windows
+
+  On Windows, `more` is not color aware, so using it effectively disables color.
+  MSYS and Cygwin shells provide `less` as a pager, which can be configured to
+  support ANSI color codes.  See :hg:`help config.color.pagermode` to configure
+  the color mode when invoking a pager.
+
 You can disable the pager for certain commands by adding them to the
 pager.ignore list::