PageRenderTime 145ms CodeModel.GetById 0ms RepoModel.GetById 0ms app.codeStats 0ms

/monky.info

http://github.com/ananthakumaran/monky
Unknown | 229 lines | 174 code | 55 blank | 0 comment | 0 complexity | 53d973837654d5ebe0c9bf2ef6813a80 MD5 | raw file
Possible License(s): GPL-3.0 
    

  1. This is monky.info, produced by makeinfo version 4.11 from monky.texi.
    2. 

  2. 

  3. Copyright (C) 2010 Anantha Kumaran.
    4. 

  4. 

  5.      Permission is granted to copy, distribute and/or modify this
    6. 

  6.      document under the terms of the GNU Free Documentation License,
    7. 

  7.      Version 1.2 or any later version published by the Free Software
    8. 

  8.      Foundation; with no Invariant Sections, with no Front-Cover Texts,
    9. 

  9.      and with no Back-Cover Texts.
    10. 

  10. 

  11. 
    12. 

  12. File: monky.info,  Node: Top,  Next: Introduction,  Up: (dir)
    13. 

  13. 

  14. Monky User Manual
    15. 

  15. *****************
    16. 

  16. 

  17. Monky is an emacs extension, provides an interactive interface for Hg
    18. 

  18. 

  19. * Menu:
    20. 

  20. 

  21. * Introduction::
    22. 

  22. * Sections::
    23. 

  23. * Status::
    24. 

  24. * Untracked files::
    25. 

  25. * Missing Files::
    26. 

  26. * Staging and Committing::
    27. 

  27. * Merged Files::
    28. 

  28. * Pushing and Pulling::
    29. 

  29. * Log::
    30. 

  30. * Blame::
    31. 

  31. * Branch::
    32. 

  32. * Queue::
    33. 

  33. * Using Hg Directly::
    34. 

  34. 

  35. 
    36. 

  36. File: monky.info,  Node: Introduction,  Next: Sections,  Prev: Top,  Up: Top
    37. 

  37. 

  38. 1 Introduction
    39. 

  39. **************
    40. 

  40. 

  41. Monky provides an interactive interface for Hg. Using Monky, your can
    42. 

  42. selectively commit files, view the diffs and other things.
    43. 

  43. 

  44. 
    45. 

  45. File: monky.info,  Node: Sections,  Next: Status,  Prev: Introduction,  Up: Top
    46. 

  46. 

  47. 2 Sections
    48. 

  48. **********
    49. 

  49. 

  50. All items in the Monky buffers are nested 'sections'. The visibility of
    51. 

  51. the current section can be toggled using `TAB' key. When a section is
    52. 

  52. hidden, only its first line is shown and all its children are
    53. 

  53. completely invisible.
    54. 

    55. 

  55. 
    56. 

  56. File: monky.info,  Node: Status,  Next: Untracked files,  Prev: Sections,  Up: Top
    57. 

    58. 

  58. 3 Status
    59. 

  59. ********
    60. 

    61. 

  61. Running `M-x monky-status' while visiting any file in a repo displays
    62. 

  62. the status of the hg repo. The status buffer list down the missing
    63. 

  63. files, untracked files and changed files. By default the diff of the
    64. 

  64. files are invisible. Use `TAB' key to toggle the visibility.
    65. 

    66. 

  66.    During a merge the buffer will show the list of merged files, and
    67. 

  67. files unmodified during the merge.
    68. 

    69. 

  69. 
    70. 

  70. File: monky.info,  Node: Untracked files,  Next: Missing Files,  Prev: Status,  Up: Top
    71. 

    72. 

  72. 4 Untracked files
    73. 

  73. *****************
    74. 

    75. 

  75. you can add a untracked file by typing key `s'. Type `k' to delete the
    76. 

  76. file.
    77. 

  77. 

  78. 
    79. 

  79. File: monky.info,  Node: Missing Files,  Next: Staging and Committing,  Prev: Untracked files,  Up: Top
    80. 

  80. 

  81. 5 Missing Files
    82. 

  82. ***************
    83. 

  83. 

  84. This section list the files missing from the repo. Typing `s' will
    85. 

  85. remove the file from the repo. To restore the file type `k'.
    86. 

    87. 

  87. 
    88. 

  88. File: monky.info,  Node: Staging and Committing,  Next: Merged Files,  Prev: Missing Files,  Up: Top
    89. 

  89. 

  90. 6 Staging and Committing
    91. 

  91. ************************
    92. 

  92. 

  93. _Changes_ section will list all the changes in the repo. Using monky
    94. 

  94. you can select a subset of your changes and commit it. Type `s' to
    95. 

  95. stage a file. Typing `S' will stage all files.
    96. 

    97. 

  97.    _Staged Changes_ section will list all the staged changes in the
    98. 

  98. repo. Type `u' to unstage a file. Typing `U' will unstage all the
    99. 

  99. previously staged files.
    100. 

  100. 

  101.    Once you staged all the necessary files type `c'. This will pop-up a
    102. 

  102. buffer for the commit message. Typing `C-c C-c' will commit all the
    103. 

  103. staged files.
    104. 

  104. 

  105.    You can reset the current working directory by typing `X'.
    106. 

    107. 

  107.    Hg doesn't have any staging area. So staging and unstaging won't make
    108. 

  108. any changes to your repo unless you commit.
    109. 

    110. 

  110. 
    111. 

  111. File: monky.info,  Node: Merged Files,  Next: Pushing and Pulling,  Prev: Staging and Committing,  Up: Top
    112. 

    113. 

  113. 7 Merged Files
    114. 

  114. **************
    115. 

    116. 

  116. After a merge, this section will list the files merged. Typing `m' will
    117. 

  117. mark the file as resolved and `x' will mark the file as unresolved.
    118. 

  118. After a merge, Hg doesn't allows to commit a subset of changes. so
    119. 

  119. files can't be staged or unstaged. So committing after a merge will
    120. 

  120. commit all the merged and unmodified files during the merge.
    121. 

    122. 

  122. 
    123. 

  123. File: monky.info,  Node: Pushing and Pulling,  Next: Log,  Prev: Merged Files,  Up: Top
    124. 

    125. 

  125. 8 Pushing and Pulling
    126. 

  126. *********************
    127. 

    128. 

  128. Type `P' to push the current branch, `f' to pull changes from remote
    129. 

  129. and `F' to fetch changes from the remote. You can specify the
    130. 

  130. source/destination to the previous commands  with a prefix argument.
    131. 

    132. 

  132. 
    133. 

  133. File: monky.info,  Node: Log,  Next: Blame,  Prev: Pushing and Pulling,  Up: Top
    134. 

    135. 

  135. 9 Log
    136. 

  136. *****
    137. 

    138. 

  138. Typing `l' will bring up the log buffer. This will list the commit logs
    139. 

  139. of the repo. You can use `n' and `p' to move to the previous and next
    140. 

  140. commit. Type `RET' to see the commit information, `C' to checkout the
    141. 

  141. commit.
    142. 

  142. 

  143.    Monky will show only `monky-log-cutoff-length' entries. Typing `e'
    144. 

  144. will show twice as many entries. `C-u e' will show all entries, and
    145. 

  145. given a numeric prefix argument, `e' will add this number of entries.
    146. 

    147. 

  147. 
    148. 

  148. File: monky.info,  Node: Blame,  Next: Branch,  Prev: Log,  Up: Top
    149. 

  149. 

  150. 10 Blame
    151. 

  151. ********
    152. 

  152. 

  153. Run `M-x monky-blame-current-file' to see the annotation of the current
    154. 

  154. file. Type `RET' to see the commit which introduced/changed the current
    155. 

  155. line.
    156. 

  156. 

  157. 
    158. 

  158. File: monky.info,  Node: Branch,  Next: Queue,  Prev: Blame,  Up: Top
    159. 

  159. 

  160. 11 Branch
    161. 

  161. *********
    162. 

  162. 

  163. Typing `b' will bring up the branch buffer. This will list all the
    164. 

  164. branches. You can use `C' to checkout a branch.
    165. 

    166. 

  166. 
    167. 

  167. File: monky.info,  Node: Queue,  Next: Using Hg Directly,  Prev: Branch,  Up: Top
    168. 

  168. 

  169. 12 Queue
    170. 

  170. ********
    171. 

  171. 

  172. Use `M-x monky-queue' or `Q' from the status buffer to view the queue
    173. 

  173. buffer. The queue buffer will list the _Applied Patches_, _UnApplied
    174. 

  174. Patches_ and the _Series_.
    175. 

  175. 

  176. Key         Description
    177. 

  177. -------------------------------------------------------------------------- 
    178. 

  178. u           pop the selected patch and all the patches before it
    179. 

  179. U           pop all the applied patches
    180. 

  180. s           push the selected patch and all the patches before it
    181. 

  181. S           push all the unapplied patches
    182. 

  182. r           refresh(update) the current patch with the changes in working
    183. 

  183.             directory
    184. 

  184. C-u r       refresh the current patch and allows to edit the commit
    185. 

  185.             message
    186. 

  186. R           rename the selected patch
    187. 

  187. k           remove the selected patch
    188. 

  188. N           create a new patch on top of current patch
    189. 

  189. C-u N       same as N except this will also read the commit message for
    190. 

  190.             the patch
    191. 

  191. i           import(qimport) patches from change sets. a change set at
    192. 

  192.             the point or change sets in a selected region (when
    193. 

  193.             selected) will be imported.
    194. 

  194. d           fold the selected patch into the current patch
    195. 

  195. f           apply(qfinish) the selected patch into repo history
    196. 

  196. F           apply(qfinish) all applied patches into repo history
    197. 

  197. G           reset the guards of the selected patch with new guards
    198. 

  198. o           pop all patches and edit .hg/patches/series file to reorder
    199. 

  199.             them
    200. 

  200. 

  201. 
    202. 

  202. File: monky.info,  Node: Using Hg Directly,  Prev: Queue,  Up: Top
    203. 

  203. 

  204. 13 Using Hg Directly
    205. 

  205. ********************
    206. 

  206. 

  207. To run a Hg command directly type `:' and enter the command in the
    208. 

  208. minibuffer. This will refresh the status buffer after the execution of
    209. 

  209. command.  The output of the command can be viewed by typing `$'.
    210. 

    211. 

  211. 

  212. 
    213. 

  213. Tag Table:
    214. 

  214. Node: Top421
    215. 

  215. Node: Introduction812
    216. 

  216. Node: Sections1053
    217. 

  217. Node: Status1386
    218. 

  218. Node: Untracked files1864
    219. 

  219. Node: Missing Files2070
    220. 

  220. Node: Staging and Committing2339
    221. 

  221. Node: Merged Files3174
    222. 

  222. Node: Pushing and Pulling3652
    223. 

  223. Node: Log3989
    224. 

  224. Node: Blame4516
    225. 

  225. Node: Branch4757
    226. 

  226. Node: Queue4967
    227. 

  227. Node: Using Hg Directly6480
    228. 

  228. 
    229. 

  229. End Tag Table
    230. 

  230.