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