doc: some documentation on the configuration part of the tutorial stable
authorPierre-Yves David <pierre-yves.david@fb.com>
Thu, 09 Jan 2014 15:24:16 -0800
branchstable
changeset 766 32936a9f4389
parent 765 015cd9d3bfdd
child 767 01a270481a61
doc: some documentation on the configuration part of the tutorial Trying to make it less obscure on first contact
docs/conf.py
tests/test-tutorial.t
--- a/docs/conf.py	Thu Jan 09 21:22:00 2014 -0800
+++ b/docs/conf.py	Thu Jan 09 15:24:16 2014 -0800
@@ -73,7 +73,7 @@
 
 # The name of an image file (within the static path) to place at the top of
 # the sidebar.
-html_logo = 'logo-evolve.svg'
+#html_logo = 'logo-evolve.svg'
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
--- a/tests/test-tutorial.t	Thu Jan 09 21:22:00 2014 -0800
+++ b/tests/test-tutorial.t	Thu Jan 09 15:24:16 2014 -0800
@@ -7,12 +7,15 @@
 
   $ cat >> $HGRCPATH << EOF
   > [ui]
+  > # This is change the default output of log for clear tutorial
   > logtemplate ="{node|short} ({phase}): {desc}\n"
   > [diff]
+  > # use "git" diff format, clearer and smarter format
   > git = 1
   > [alias]
   > # "-d '0 0'" means that the new commit will be at January 1st 1970.
   > # This is used for stable hash during test
+  > # (this tutorial is automatically tested.)
   > amend = amend -d '0 0'
   > EOF
 
@@ -44,8 +47,7 @@
 
 A compact log template with phase data:
 
-  $ hg showconfig ui
-  ui.slash=True
+  $ hg showconfig ui | grep log
   ui.logtemplate="{node|short} ({phase}): {desc}\n"
 
 Improved git format diff:
@@ -57,8 +59,9 @@
 
   $ cat >> $HGRCPATH <<EOF
   > [extensions]
+  > evolve = $TESTDIR/../hgext/evolve.py
+  > # enabling rebase is also needed for now
   > rebase =
-  > evolve = $TESTDIR/../hgext/evolve.py
   > EOF
 
 -----------------------