view tests/test-pending.t @ 16853:7863ff383894

help: format command and option list help using RST

This patch changes the function which generates help text about commands and
options to use RST formatting. Tables describing options have been formatted
using RST table markup for some time already, so their appearance does not
change. Command lists, however, change appearance.

To format non-verbose command lists, RST field list markup was chosen, because
it resembles the old format:

<http://docutils.sourceforge.net/docs/user/rst/quickref.html#field-lists>

In the old (hand-coded) format of non-verbose command lists, the left column is
12 characters wide. Our minirst implementation formats field lists with a left
column 14 characters wide, so this patch changes the appearance of help output
correspondingly:

<http://markmail.org/message/krl4cxopsnii7s6z?q=mercurial+reinert+from:%22Olav+Reinert%22&page=2>

The minirst markup most closely resembling the old verbose command lists is
definition lists. But using it would cause a blank line to be inserted between
each command definition, making the output excessively long, and no more
useful than before. To avoid this, I chose to use field lists also for verbose
command help, resulting in output like this example:

 add           add the specified files on the next commit
 annotate, blame
               show changeset information by line for each file
 clone         make a copy of an existing repository
 commit, ci    commit the specified files or all outstanding changes
 diff          diff repository (or selected files)
 export        dump the header and diffs for one or more changesets
 forget        forget the specified files on the next commit
 init          create a new repository in the given directory
 log, history  show revision history of entire repository or files
 merge         merge working directory with another revision
 phase         set or show the current phase name
 pull          pull changes from the specified source
 push          push changes to the specified destination
 qdiff         diff of the current patch and subsequent modifications
 qinit         init a new queue repository (DEPRECATED)
 qnew          create a new patch
 qpop          pop the current patch off the stack
 qpush         push the next patch onto the stack
 qrefresh      update the current patch
 remove, rm    remove the specified files on the next commit
 serve         start stand-alone webserver
 status, st    show changed files in the working directory
 summary, sum  summarize working directory state
 update, up, checkout, co
               update working directory (or switch revisions)

This change is a move towards generating all help text as a list of strings
marked up with RST.

  $ "$TESTDIR/hghave" system-sh || exit 80

Verify that pending changesets are seen by pretxn* hooks but not by other
processes that access the destination repo while the hooks are running.

The hooks (python and external) both reject changesets after some think time,
during which another process runs pull.  Each hook creates a file ('notify') to
indicate to the controlling process that it is running; the process removes the
file to indicate the hook can terminate.

init env vars

  $ d=`pwd`
  $ maxwait=20

utility to run the test - start a push in the background and run pull

  $ dotest() {
  >     rm -f notify
  >     printf 'push '; hg -R child-push tip --template '{node}\n'
  >     hg -R child-push -q push > push.out 2>&1 &
  > 
  >     # wait for hook to create the notify file
  >     i=$maxwait
  >     while [ ! -f notify -a $i != 0 ]; do
  >         sleep 1
  >         i=`expr $i - 1`
  >     done
  > 
  >     # run pull
  >     hg -R child-pull -q pull
  >     rc=$?
  > 
  >     # tell hook to finish; notify should exist.
  >     rm notify
  >     wait
  > 
  >     cat push.out
  >     printf 'pull '; hg -R child-pull tip --template '{node}\n'
  >     return $rc
  > }

python hook

  $ cat <<EOF > reject.py
  > import os, time
  > from mercurial import ui, localrepo
  > def rejecthook(ui, repo, hooktype, node, **opts):
  >     ui.write('hook %s\\n' % repo['tip'].hex())
  >     # create the notify file so caller knows we're running
  >     fpath = os.path.join('$d', 'notify')
  >     f = open(fpath, 'w')
  >     f.close()
  >     # wait for ack - caller should delete the notify file
  >     i = $maxwait
  >     while os.path.exists(fpath) and i > 0:
  >         time.sleep(1)
  >         i -= 1
  >     return True # reject the changesets
  > EOF

external hook

  $ cat <<EOF > reject.sh
  > #! /bin/sh
  > printf 'hook '; hg tip --template '{node}\\n'
  > # create the notify file so caller knows we're running
  > fpath=$d/notify
  > touch \$fpath
  > # wait for ack - caller should delete the notify file
  > i=$maxwait
  > while [ -f \$fpath -a \$i != 0 ]; do
  >     sleep 1
  >     i=\`expr \$i - 1\`
  > done
  > exit 1 # reject the changesets
  > EOF
  $ chmod +x reject.sh

create repos

  $ hg init parent
  $ hg clone -q parent child-push
  $ hg clone -q parent child-pull
  $ echo a > child-push/a
  $ hg -R child-push add child-push/a
  $ hg -R child-push commit -m a -d '1000000 0'

test python hook

  $ cat <<EOF > parent/.hg/hgrc
  > [extensions]
  > reject = $d/reject.py
  > [hooks]
  > pretxnchangegroup = python:reject.rejecthook
  > EOF

  $ dotest
  push 29b62aeb769fdf78d8d9c5f28b017f76d7ef824b
  hook 29b62aeb769fdf78d8d9c5f28b017f76d7ef824b
  transaction abort!
  rollback completed
  abort: pretxnchangegroup hook failed
  pull 0000000000000000000000000000000000000000

test external hook

  $ cat <<EOF > parent/.hg/hgrc
  > [hooks]
  > pretxnchangegroup = $d/reject.sh
  > EOF

  $ dotest
  push 29b62aeb769fdf78d8d9c5f28b017f76d7ef824b
  hook 29b62aeb769fdf78d8d9c5f28b017f76d7ef824b
  transaction abort!
  rollback completed
  abort: pretxnchangegroup hook exited with status 1
  pull 0000000000000000000000000000000000000000