record: allow splitting of hunks by manually editing patches
It is possible that unrelated changes in a file are on sequential lines. The
current record extension does not allow these to be committed independently.
An example use case for this is in software development for deeply embedded
real-time systems. In these environments, it is not always possible to use a
debugger (due to time-constraints) and hence inline UART-based printing is
often used. When fixing a bug in a module, it is often convenient to add a
large number of 'printf's (linked to the UART via a custom fputc) to the module
in order to work out what is going wrong. printf is a very slow function (and
also variadic so somewhat frowned upon by the MISRA standard) and hence it is
highly undesirable to commit these lines to the repository. If only a partial
fix is implemented, however, it is desirable to commit the fix without deleting
all of the printf lines. This is also simplifies removal of the printf lines
as once the final fix is committed, 'hg revert' does the rest. It is likely
that the printf lines will be very near the actual fix, so being able to split
the hunk is very useful in this case.
There were two alternatives I considered for the user interface. One was to
manually edit the patch, the other to allow a hunk to be split into individual
lines for consideration. The latter option would require a significant
refactor of the record module and is less flexible. While the former is
potentially more complicated to use, this is a feature that is likely to only
be used in certain exceptional cases (such as the use case proposed above) and
hence I felt that the complexity would not be a considerable issue.
I've also written a follow-up patch that refactors the 'prompt' code to base
everything on the choices variable. This tidies up and clarifies the code a
bit (removes constructs like 'if ret == 7' and removes the 'e' option from the
file scope options as it's not relevant there. It's not really a necessity, so
I've excluded it from this submission for now, but I can send it separately if
there's a desire and it's on bitbucket (see below) in the meantime.
Possible future improvements include:
* Tidying up the 'prompt' code to base everything on the choices variable.
This would allow entries to be removed from the prompt as currently 'e' is
offered even for entire file patches, which is currently unsupported.
* Allowing the entire file (or even multi-file) patch to be edited manually:
this would require quite a large refactor without much benefit, so I decided
to exclude it from the initial submission.
* Allow the option to retry if a patch fails to apply (this is what Git does).
This would require quite a bit of refactoring given the current 'hg record'
implementation, so it's debatable whether it's worth it.
Output is similar to existing record user interface except that an additional
option ('e') exists to allow manual editing of the patch. This opens the
user's configured editor with the patch. A comment is added to the bottom of
the patch explaining what to do (based on Git's one).
A large proportion of the changeset is test-case changes to update the options
reported by record (Ynesfdaq? instead of Ynsfdaq?). Functional changes are in
record.py and there are some new test cases in test-record.t.
$ echo "[extensions]" >> $HGRCPATH
$ echo "convert=" >> $HGRCPATH
$ echo 'graphlog =' >> $HGRCPATH
$ glog()
> {
> hg glog --template '{rev}:{node|short} "{desc|firstline}"\
> files: {files}\n' "$@"
> }
$ hg init repo1
$ cd repo1
$ echo a > a
$ hg ci -Am adda
adding a
$ echo b > b
$ echo a >> a
$ hg ci -Am addb
adding b
$ PARENTID1=`hg id --debug -i`
$ echo c > c
$ hg ci -Am addc
adding c
$ PARENTID2=`hg id --debug -i`
$ cd ..
$ glog -R repo1
@ 2:e55c719b85b6 "addc" files: c
|
o 1:6d4c2037ddc2 "addb" files: a b
|
o 0:07f494440405 "adda" files: a
$ hg init repo2
$ cd repo2
$ echo b > a
$ echo d > d
$ hg ci -Am addaandd
adding a
adding d
$ CHILDID1=`hg id --debug -i`
$ echo d >> d
$ hg ci -Am changed
$ CHILDID2=`hg id --debug -i`
$ echo e > e
$ hg ci -Am adde
adding e
$ cd ..
$ glog -R repo2
@ 2:a39b65753b0a "adde" files: e
|
o 1:e4ea00df9189 "changed" files: d
|
o 0:527cdedf31fb "addaandd" files: a d
test invalid splicemap
$ cat > splicemap <<EOF
> $CHILDID2
> EOF
$ hg convert --splicemap splicemap repo2 repo1
abort: syntax error in splicemap(1): child parent1[,parent2] expected
[255]
splice repo2 on repo1
$ cat > splicemap <<EOF
> $CHILDID1 $PARENTID1
> $CHILDID2 $PARENTID2,$CHILDID1
>
> EOF
$ cat splicemap
527cdedf31fbd5ea708aa14eeecf53d4676f38db 6d4c2037ddc2cb2627ac3a244ecce35283268f8e
e4ea00df91897da3079a10fab658c1eddba6617b e55c719b85b60e5102fac26110ba626e7cb6b7dc,527cdedf31fbd5ea708aa14eeecf53d4676f38db
$ hg clone repo1 target1
updating to branch default
3 files updated, 0 files merged, 0 files removed, 0 files unresolved
$ hg convert --splicemap splicemap repo2 target1
scanning source...
sorting...
converting...
2 addaandd
spliced in ['6d4c2037ddc2cb2627ac3a244ecce35283268f8e'] as parents of 527cdedf31fbd5ea708aa14eeecf53d4676f38db
1 changed
spliced in ['e55c719b85b60e5102fac26110ba626e7cb6b7dc', '527cdedf31fbd5ea708aa14eeecf53d4676f38db'] as parents of e4ea00df91897da3079a10fab658c1eddba6617b
0 adde
$ glog -R target1
o 5:16bc847b02aa "adde" files: e
|
o 4:e30e4fee3418 "changed" files: d
|\
| o 3:e673348c3a3c "addaandd" files: a d
| |
@ | 2:e55c719b85b6 "addc" files: c
|/
o 1:6d4c2037ddc2 "addb" files: a b
|
o 0:07f494440405 "adda" files: a
Test splicemap and conversion order
$ hg init ordered
$ cd ordered
$ echo a > a
$ hg ci -Am adda
adding a
$ hg branch branch
marked working directory as branch branch
(branches are permanent and global, did you want a bookmark?)
$ echo a >> a
$ hg ci -Am changea
$ echo a >> a
$ hg ci -Am changeaagain
$ hg up 0
1 files updated, 0 files merged, 0 files removed, 0 files unresolved
$ echo b > b
$ hg ci -Am addb
adding b
We want 2 to depend on 1 and 3. Since 3 is always converted after 2,
the bug should be exhibited with all conversion orders.
$ cat > ../splicemap <<EOF
> $(hg id -r 2 -i --debug) $(hg id -r 1 -i --debug), $(hg id -r 3 -i --debug)
> EOF
$ cd ..
$ cat splicemap
7c364e7fa7d70ae525610c016317ed717b519d97 717d54d67e6c31fd75ffef2ff3042bdd98418437, 102a90ea7b4a3361e4082ed620918c261189a36a
Test regular conversion
$ hg convert --splicemap splicemap ordered ordered-hg1
initializing destination ordered-hg1 repository
scanning source...
sorting...
converting...
3 adda
2 changea
1 addb
0 changeaagain
spliced in ['717d54d67e6c31fd75ffef2ff3042bdd98418437', '102a90ea7b4a3361e4082ed620918c261189a36a'] as parents of 7c364e7fa7d70ae525610c016317ed717b519d97
$ glog -R ordered-hg1
o 3:4cb04b9afbf2 "changeaagain" files: a
|\
| o 2:102a90ea7b4a "addb" files: b
| |
o | 1:717d54d67e6c "changea" files: a
|/
o 0:07f494440405 "adda" files: a
Test conversion with parent revisions already in dest, using source
and destination identifiers. Test unknown splicemap target.
$ hg convert -r1 ordered ordered-hg2
initializing destination ordered-hg2 repository
scanning source...
sorting...
converting...
1 adda
0 changea
$ hg convert -r3 ordered ordered-hg2
scanning source...
sorting...
converting...
0 addb
$ cat > splicemap <<EOF
> $(hg -R ordered id -r 2 -i --debug) \
> $(hg -R ordered-hg2 id -r 1 -i --debug),\
> $(hg -R ordered-hg2 id -r 2 -i --debug)
> deadbeef102a90ea7b4a3361e4082ed620918c26 deadbeef102a90ea7b4a3361e4082ed620918c27
> EOF
$ hg convert --splicemap splicemap ordered ordered-hg2
scanning source...
splice map revision deadbeef102a90ea7b4a3361e4082ed620918c26 is not being converted, ignoring
sorting...
converting...
0 changeaagain
spliced in ['717d54d67e6c31fd75ffef2ff3042bdd98418437', '102a90ea7b4a3361e4082ed620918c261189a36a'] as parents of 7c364e7fa7d70ae525610c016317ed717b519d97
$ glog -R ordered-hg2
o 3:4cb04b9afbf2 "changeaagain" files: a
|\
| o 2:102a90ea7b4a "addb" files: b
| |
o | 1:717d54d67e6c "changea" files: a
|/
o 0:07f494440405 "adda" files: a
Test empty conversion
$ hg convert --splicemap splicemap ordered ordered-hg2
scanning source...
splice map revision deadbeef102a90ea7b4a3361e4082ed620918c26 is not being converted, ignoring
sorting...
converting...
Test clonebranches
$ hg --config convert.hg.clonebranches=true convert \
> --splicemap splicemap ordered ordered-hg3
initializing destination ordered-hg3 repository
scanning source...
abort: revision 717d54d67e6c31fd75ffef2ff3042bdd98418437 not found in destination repository (lookups with clonebranches=true are not implemented)
[255]
Test invalid dependency
$ cat > splicemap <<EOF
> $(hg -R ordered id -r 2 -i --debug) \
> deadbeef102a90ea7b4a3361e4082ed620918c26,\
> $(hg -R ordered-hg2 id -r 2 -i --debug)
> EOF
$ hg convert --splicemap splicemap ordered ordered-hg4
initializing destination ordered-hg4 repository
scanning source...
abort: unknown splice map parent: deadbeef102a90ea7b4a3361e4082ed620918c26
[255]