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.

     1

  $ "$TESTDIR/hghave" execbit || exit 80

     2

     3

Setup

     4

     5

  $ echo "[color]" >> $HGRCPATH

     6

  $ echo "mode = ansi" >> $HGRCPATH

     7

  $ echo "[extensions]" >> $HGRCPATH

     8

  $ echo "color=" >> $HGRCPATH

     9

  $ hg init repo

    10

  $ cd repo

    11

  $ cat > a <<EOF

    12

  > c

    13

  > c

    14

  > a

    15

  > a

    16

  > b

    17

  > a

    18

  > a

    19

  > c

    20

  > c

    21

  > EOF

    22

  $ hg ci -Am adda

    23

  adding a

    24

  $ cat > a <<EOF

    25

  > c

    26

  > c

    27

  > a

    28

  > a

    29

  > dd

    30

  > a

    31

  > a

    32

  > c

    33

  > c

    34

  > EOF

    35

    36

default context

    37

    38

  $ hg diff --nodates --color=always

    39

  \x1b[0;1mdiff -r cf9f4ba66af2 a\x1b[0m (esc)

    40

  \x1b[0;31;1m--- a/a\x1b[0m (esc)

    41

  \x1b[0;32;1m+++ b/a\x1b[0m (esc)

    42

  \x1b[0;35m@@ -2,7 +2,7 @@\x1b[0m (esc)

    43

   c

    44

   a

    45

   a

    46

  \x1b[0;31m-b\x1b[0m (esc)

    47

  \x1b[0;32m+dd\x1b[0m (esc)

    48

   a

    49

   a

    50

   c

    51

    52

--unified=2

    53

    54

  $ hg diff --nodates -U 2  --color=always

    55

  \x1b[0;1mdiff -r cf9f4ba66af2 a\x1b[0m (esc)

    56

  \x1b[0;31;1m--- a/a\x1b[0m (esc)

    57

  \x1b[0;32;1m+++ b/a\x1b[0m (esc)

    58

  \x1b[0;35m@@ -3,5 +3,5 @@\x1b[0m (esc)

    59

   a

    60

   a

    61

  \x1b[0;31m-b\x1b[0m (esc)

    62

  \x1b[0;32m+dd\x1b[0m (esc)

    63

   a

    64

   a

    65

    66

diffstat

    67

    68

  $ hg diff --stat --color=always

    69

   a |  2 \x1b[0;32m+\x1b[0m\x1b[0;31m-\x1b[0m (esc)

    70

   1 files changed, 1 insertions(+), 1 deletions(-)

    71

  $ echo "record=" >> $HGRCPATH

    72

  $ echo "[ui]" >> $HGRCPATH

    73

  $ echo "interactive=true" >> $HGRCPATH

    74

  $ echo "[diff]" >> $HGRCPATH

    75

  $ echo "git=True" >> $HGRCPATH

    76

    77

record

    78

    79

  $ chmod +x a

    80

  $ hg record --color=always -m moda a <<EOF

    81

  > y

    82

  > y

    83

  > EOF

    84

  \x1b[0;1mdiff --git a/a b/a\x1b[0m (esc)

    85

  \x1b[0;36;1mold mode 100644\x1b[0m (esc)

    86

  \x1b[0;36;1mnew mode 100755\x1b[0m (esc)

    87

  1 hunks, 1 lines changed

    88

  \x1b[0;33mexamine changes to 'a'? [Ynesfdaq?]\x1b[0m  (esc)

    89

  \x1b[0;35m@@ -2,7 +2,7 @@\x1b[0m (esc)

    90

   c

    91

   a

    92

   a

    93

  \x1b[0;31m-b\x1b[0m (esc)

    94

  \x1b[0;32m+dd\x1b[0m (esc)

    95

   a

    96

   a

    97

   c

    98

  \x1b[0;33mrecord this change to 'a'? [Ynesfdaq?]\x1b[0m  (esc)

    99

   100

  $ echo "[extensions]" >> $HGRCPATH

   101

  $ echo "mq=" >> $HGRCPATH

   102

  $ hg rollback

   103

  repository tip rolled back to revision 0 (undo commit)

   104

  working directory now based on revision 0

   105

   106

qrecord

   107

   108

  $ hg qrecord --color=always -m moda patch <<EOF

   109

  > y

   110

  > y

   111

  > EOF

   112

  \x1b[0;1mdiff --git a/a b/a\x1b[0m (esc)

   113

  \x1b[0;36;1mold mode 100644\x1b[0m (esc)

   114

  \x1b[0;36;1mnew mode 100755\x1b[0m (esc)

   115

  1 hunks, 1 lines changed

   116

  \x1b[0;33mexamine changes to 'a'? [Ynesfdaq?]\x1b[0m  (esc)

   117

  \x1b[0;35m@@ -2,7 +2,7 @@\x1b[0m (esc)

   118

   c

   119

   a

   120

   a

   121

  \x1b[0;31m-b\x1b[0m (esc)

   122

  \x1b[0;32m+dd\x1b[0m (esc)

   123

   a

   124

   a

   125

   c

   126

  \x1b[0;33mrecord this change to 'a'? [Ynesfdaq?]\x1b[0m  (esc)