% help

mq extension - manage a stack of patches

This extension lets you work with a stack of patches in a Mercurial

repository. It manages two stacks of patches - all known patches, and applied

patches (subset of known patches).

Known patches are represented as patch files in the .hg/patches directory.

Applied patches are both patch files and changesets.

Common tasks (use "hg help command" for more details):

  create new patch                          qnew

  import existing patch                     qimport

  print patch series                        qseries

  print applied patches                     qapplied

  add known patch to applied stack          qpush

  remove patch from applied stack           qpop

  refresh contents of top applied patch     qrefresh

By default, mq will automatically use git patches when required to avoid

losing file mode changes, copy records, binary files or empty files creations

or deletions. This behaviour can be configured with:

  [mq]

  git = auto/keep/yes/no

If set to 'keep', mq will obey the [diff] section configuration while

preserving existing git patches upon qrefresh. If set to 'yes' or 'no', mq

will override the [diff] section and always generate git or regular patches,

possibly losing data in the second case.

list of commands:

 qapplied     print the patches already applied

 qclone       clone main and patch repository at same time

 qdelete      remove patches from queue

 qdiff        diff of the current patch and subsequent modifications

 qfinish      move applied patches into repository history

 qfold        fold the named patches into the current patch

 qgoto        push or pop patches until named patch is at top of stack

 qguard       set or print guards for a patch

 qheader      print the header of the topmost or specified patch

 qimport      import a patch

 qnew         create a new patch

 qnext        print the name of the next patch

 qpop         pop the current patch off the stack

 qprev        print the name of the previous patch

 qpush        push the next patch onto the stack

 qrefresh     update the current patch

 qrename      rename a patch

 qselect      set or print guarded patches to push

 qseries      print the entire series file

 qtop         print the name of the current patch

 qunapplied   print the patches not yet applied

 strip        strip a changeset and all its descendants from the repository

use "hg -v help mq" to show aliases and global options

adding a

updating to branch default

1 files updated, 0 files merged, 0 files removed, 0 files unresolved

adding b/z

% qinit

% -R qinit

% qinit -c

A .hgignore

A series

% qinit; qinit -c

  .hgignore:

^\.hg

^\.mq

syntax: glob

status

guards

  series:

abort: repository already exists!

% qinit; <stuff>; qinit -c

adding .hg/patches/A

adding .hg/patches/B

A .hgignore

A A

A B

A series

  .hgignore:

status

bleh

  series:

A

B

% init --mq without repo

abort: There is no Mercurial repository here (.hg not found)

% init --mq with repo path

ok

% init --mq with nonexistent directory

abort: repository nonexistentdir not found!

% init --mq with bundle (non "local")

abort: only a local queue repository may be initialized

% qrefresh

foo bar

diff -r  xa

--- a/a

+++ b/a

@@ -1,1 +1,2 @@

 a

+a

% empty qrefresh

revision:

patch:

foo bar

working dir diff:

--- a/a

+++ b/a

@@ -1,1 +1,2 @@

 a

+a

% qpop

popping test.patch

patch queue now empty

% qpush with dump of tag cache

.hg/tags.cache (pre qpush):

1

applying test.patch

now at: test.patch

.hg/tags.cache (post qpush):

2

% pop/push outside repo

popping test.patch

patch queue now empty

applying test.patch

now at: test.patch

% qrefresh in subdir

% pop/push -a in subdir

popping test2.patch

popping test.patch

patch queue now empty

applying test.patch

applying test2.patch

now at: test2.patch

% qseries

test.patch

test2.patch

0 A test.patch: f...

1 A test2.patch: 

popping test2.patch

now at: test.patch

0 A test.patch: foo bar

1 U test2.patch: 

mq:     1 applied, 1 unapplied

applying test2.patch

now at: test2.patch

mq:     2 applied

% qapplied

test.patch

test2.patch

% qtop

test2.patch

% prev

test.patch

% next

all patches applied

popping test2.patch

now at: test.patch

% commit should fail

abort: cannot commit over an applied mq patch

% push should fail

pushing to ../../k

abort: source has mq patches applied

% import should fail

abort: cannot import over an applied patch

% import --no-commit should succeed

applying ../../import.diff

M a

% qunapplied

test2.patch

% qpush/qpop with index

applying test2.patch

now at: test2.patch

popping test2.patch

popping test1b.patch

now at: test.patch

applying test1b.patch

now at: test1b.patch

applying test2.patch

now at: test2.patch

popping test2.patch

now at: test1b.patch

popping test1b.patch

now at: test.patch

applying test1b.patch

applying test2.patch

now at: test2.patch

% qpush --move

popping test2.patch

popping test1b.patch

popping test.patch

patch queue now empty

applying test2.patch

now at: test2.patch

applying test1b.patch

now at: test1b.patch

applying test.patch

now at: test.patch

0 A test2.patch

1 A test1b.patch

2 A test.patch

popping test.patch

popping test1b.patch

popping test2.patch

patch queue now empty

applying test.patch

now at: test.patch

applying test1b.patch

now at: test1b.patch

abort: patch bogus not in series

abort: cannot push to a previous patch: test.patch

applying test2.patch

now at: test2.patch

% pop, qapplied, qunapplied

0 A test.patch

1 A test1b.patch

2 A test2.patch

% qapplied -1 test.patch

only one patch applied

% qapplied -1 test1b.patch

test.patch

% qapplied -1 test2.patch

test1b.patch

% qapplied -1

test1b.patch

% qapplied

test.patch

test1b.patch

test2.patch

% qapplied test1b.patch

test.patch

test1b.patch

% qunapplied -1

all patches applied

% qunapplied

% popping

popping test2.patch

now at: test1b.patch

% qunapplied -1

test2.patch

% qunapplied

test2.patch

% qunapplied test2.patch

% qunapplied -1 test2.patch

all patches applied

% popping -a

popping test1b.patch

popping test.patch

patch queue now empty

% qapplied

% qapplied -1

no patches applied

applying test.patch

now at: test.patch

% push should succeed

popping test.patch

patch queue now empty

pushing to ../../k

searching for changes

adding changesets

adding manifests

adding file changes

added 1 changesets with 1 changes to 1 files

% qpush/qpop error codes

applying test.patch

applying test1b.patch

applying test2.patch

now at: test2.patch

  % pops all patches and succeeds

popping test2.patch

popping test1b.patch

popping test.patch

patch queue now empty

  qpop -a succeeds

  % does nothing and succeeds

no patches applied

  qpop -a succeeds

  % fails - nothing else to pop

no patches applied

  qpop fails

  % pushes a patch and succeeds

applying test.patch

now at: test.patch

  qpush succeeds

  % pops a patch and succeeds

popping test.patch

patch queue now empty

  qpop succeeds

  % pushes up to test1b.patch and succeeds

applying test.patch

applying test1b.patch

now at: test1b.patch

  qpush test1b.patch succeeds

  % does nothing and succeeds

qpush: test1b.patch is already at the top

  qpush test1b.patch succeeds

  % does nothing and succeeds

qpop: test1b.patch is already at the top

  qpop test1b.patch succeeds

  % fails - can't push to this patch

abort: cannot push to a previous patch: test.patch

  qpush test.patch fails

  % fails - can't pop to this patch

abort: patch test2.patch is not applied

  qpop test2.patch fails

  % pops up to test.patch and succeeds

popping test1b.patch

now at: test.patch

  qpop test.patch succeeds

  % pushes all patches and succeeds

applying test1b.patch

applying test2.patch

now at: test2.patch

  qpush -a succeeds

  % does nothing and succeeds

all patches are currently applied

  qpush -a succeeds

  % fails - nothing else to push

patch series already fully applied

  qpush fails

  % does nothing and succeeds

qpush: test2.patch is already at the top

  qpush test2.patch succeeds

% strip

adding x

0 files updated, 0 files merged, 1 files removed, 0 files unresolved

adding changesets

adding manifests

adding file changes

added 1 changesets with 1 changes to 1 files

(run 'hg update' to get a working copy)

% strip with local changes, should complain

1 files updated, 0 files merged, 0 files removed, 0 files unresolved

abort: local changes found

% --force strip with local changes

0 files updated, 0 files merged, 1 files removed, 0 files unresolved

% cd b; hg qrefresh

adding a

foo

diff -r cb9a9f314b8b a

--- a/a

+++ b/a

@@ -1,1 +1,2 @@

 a

+a

diff -r cb9a9f314b8b b/f

--- /dev/null

+++ b/b/f

@@ -0,0 +1,1 @@

+f

% hg qrefresh .

foo

diff -r cb9a9f314b8b b/f

--- /dev/null

+++ b/b/f

@@ -0,0 +1,1 @@

+f

M a

% qpush failure

popping bar

popping foo