PageRenderTime 76ms CodeModel.GetById 20ms RepoModel.GetById 1ms 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. Copyright (C) 2010 Anantha Kumaran.
  3. Permission is granted to copy, distribute and/or modify this
  4. document under the terms of the GNU Free Documentation License,
  5. Version 1.2 or any later version published by the Free Software
  6. Foundation; with no Invariant Sections, with no Front-Cover Texts,
  7. and with no Back-Cover Texts.
  8. 
  9. File: monky.info, Node: Top, Next: Introduction, Up: (dir)
  10. Monky User Manual
  11. *****************
  12. Monky is an emacs extension, provides an interactive interface for Hg
  13. * Menu:
  14. * Introduction::
  15. * Sections::
  16. * Status::
  17. * Untracked files::
  18. * Missing Files::
  19. * Staging and Committing::
  20. * Merged Files::
  21. * Pushing and Pulling::
  22. * Log::
  23. * Blame::
  24. * Branch::
  25. * Queue::
  26. * Using Hg Directly::
  27. 
  28. File: monky.info, Node: Introduction, Next: Sections, Prev: Top, Up: Top
  29. 1 Introduction
  30. **************
  31. Monky provides an interactive interface for Hg. Using Monky, your can
  32. selectively commit files, view the diffs and other things.
  33. 
  34. File: monky.info, Node: Sections, Next: Status, Prev: Introduction, Up: Top
  35. 2 Sections
  36. **********
  37. All items in the Monky buffers are nested 'sections'. The visibility of
  38. the current section can be toggled using `TAB' key. When a section is
  39. hidden, only its first line is shown and all its children are
  40. completely invisible.
  41. 
  42. File: monky.info, Node: Status, Next: Untracked files, Prev: Sections, Up: Top
  43. 3 Status
  44. ********
  45. Running `M-x monky-status' while visiting any file in a repo displays
  46. the status of the hg repo. The status buffer list down the missing
  47. files, untracked files and changed files. By default the diff of the
  48. files are invisible. Use `TAB' key to toggle the visibility.
  49. During a merge the buffer will show the list of merged files, and
  50. files unmodified during the merge.
  51. 
  52. File: monky.info, Node: Untracked files, Next: Missing Files, Prev: Status, Up: Top
  53. 4 Untracked files
  54. *****************
  55. you can add a untracked file by typing key `s'. Type `k' to delete the
  56. file.
  57. 
  58. File: monky.info, Node: Missing Files, Next: Staging and Committing, Prev: Untracked files, Up: Top
  59. 5 Missing Files
  60. ***************
  61. This section list the files missing from the repo. Typing `s' will
  62. remove the file from the repo. To restore the file type `k'.
  63. 
  64. File: monky.info, Node: Staging and Committing, Next: Merged Files, Prev: Missing Files, Up: Top
  65. 6 Staging and Committing
  66. ************************
  67. _Changes_ section will list all the changes in the repo. Using monky
  68. you can select a subset of your changes and commit it. Type `s' to
  69. stage a file. Typing `S' will stage all files.
  70. _Staged Changes_ section will list all the staged changes in the
  71. repo. Type `u' to unstage a file. Typing `U' will unstage all the
  72. previously staged files.
  73. Once you staged all the necessary files type `c'. This will pop-up a
  74. buffer for the commit message. Typing `C-c C-c' will commit all the
  75. staged files.
  76. You can reset the current working directory by typing `X'.
  77. Hg doesn't have any staging area. So staging and unstaging won't make
  78. any changes to your repo unless you commit.
  79. 
  80. File: monky.info, Node: Merged Files, Next: Pushing and Pulling, Prev: Staging and Committing, Up: Top
  81. 7 Merged Files
  82. **************
  83. After a merge, this section will list the files merged. Typing `m' will
  84. mark the file as resolved and `x' will mark the file as unresolved.
  85. After a merge, Hg doesn't allows to commit a subset of changes. so
  86. files can't be staged or unstaged. So committing after a merge will
  87. commit all the merged and unmodified files during the merge.
  88. 
  89. File: monky.info, Node: Pushing and Pulling, Next: Log, Prev: Merged Files, Up: Top
  90. 8 Pushing and Pulling
  91. *********************
  92. Type `P' to push the current branch, `f' to pull changes from remote
  93. and `F' to fetch changes from the remote. You can specify the
  94. source/destination to the previous commands with a prefix argument.
  95. 
  96. File: monky.info, Node: Log, Next: Blame, Prev: Pushing and Pulling, Up: Top
  97. 9 Log
  98. *****
  99. Typing `l' will bring up the log buffer. This will list the commit logs
  100. of the repo. You can use `n' and `p' to move to the previous and next
  101. commit. Type `RET' to see the commit information, `C' to checkout the
  102. commit.
  103. Monky will show only `monky-log-cutoff-length' entries. Typing `e'
  104. will show twice as many entries. `C-u e' will show all entries, and
  105. given a numeric prefix argument, `e' will add this number of entries.
  106. 
  107. File: monky.info, Node: Blame, Next: Branch, Prev: Log, Up: Top
  108. 10 Blame
  109. ********
  110. Run `M-x monky-blame-current-file' to see the annotation of the current
  111. file. Type `RET' to see the commit which introduced/changed the current
  112. line.
  113. 
  114. File: monky.info, Node: Branch, Next: Queue, Prev: Blame, Up: Top
  115. 11 Branch
  116. *********
  117. Typing `b' will bring up the branch buffer. This will list all the
  118. branches. You can use `C' to checkout a branch.
  119. 
  120. File: monky.info, Node: Queue, Next: Using Hg Directly, Prev: Branch, Up: Top
  121. 12 Queue
  122. ********
  123. Use `M-x monky-queue' or `Q' from the status buffer to view the queue
  124. buffer. The queue buffer will list the _Applied Patches_, _UnApplied
  125. Patches_ and the _Series_.
  126. Key Description
  127. --------------------------------------------------------------------------
  128. u pop the selected patch and all the patches before it
  129. U pop all the applied patches
  130. s push the selected patch and all the patches before it
  131. S push all the unapplied patches
  132. r refresh(update) the current patch with the changes in working
  133. directory
  134. C-u r refresh the current patch and allows to edit the commit
  135. message
  136. R rename the selected patch
  137. k remove the selected patch
  138. N create a new patch on top of current patch
  139. C-u N same as N except this will also read the commit message for
  140. the patch
  141. i import(qimport) patches from change sets. a change set at
  142. the point or change sets in a selected region (when
  143. selected) will be imported.
  144. d fold the selected patch into the current patch
  145. f apply(qfinish) the selected patch into repo history
  146. F apply(qfinish) all applied patches into repo history
  147. G reset the guards of the selected patch with new guards
  148. o pop all patches and edit .hg/patches/series file to reorder
  149. them
  150. 
  151. File: monky.info, Node: Using Hg Directly, Prev: Queue, Up: Top
  152. 13 Using Hg Directly
  153. ********************
  154. To run a Hg command directly type `:' and enter the command in the
  155. minibuffer. This will refresh the status buffer after the execution of
  156. command. The output of the command can be viewed by typing `$'.
  157. 
  158. Tag Table:
  159. Node: Top421
  160. Node: Introduction812
  161. Node: Sections1053
  162. Node: Status1386
  163. Node: Untracked files1864
  164. Node: Missing Files2070
  165. Node: Staging and Committing2339
  166. Node: Merged Files3174
  167. Node: Pushing and Pulling3652
  168. Node: Log3989
  169. Node: Blame4516
  170. Node: Branch4757
  171. Node: Queue4967
  172. Node: Using Hg Directly6480
  173. 
  174. End Tag Table