Skip to content

Commit

Permalink
Merge pull request ananthakumaran#113 from mjoerg/add-direntry
Browse files Browse the repository at this point in the history
Add direntry in documentation
  • Loading branch information
Wilfred authored Feb 22, 2023
2 parents a632876 + 6e099c0 commit 7046eee
Show file tree
Hide file tree
Showing 2 changed files with 78 additions and 64 deletions.
135 changes: 72 additions & 63 deletions monky.info
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
This is monky.info, produced by makeinfo version 4.11 from monky.texi.
This is monky.info, produced by makeinfo version 7.0.2 from monky.texi.

Copyright (C) 2010 Anantha Kumaran.
Copyright © 2010 Anantha Kumaran.

Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License,
Version 1.2 or any later version published by the Free Software
Foundation; with no Invariant Sections, with no Front-Cover Texts,
and with no Back-Cover Texts.
INFO-DIR-SECTION Emacs
START-INFO-DIR-ENTRY
* Monky: (monky). An interactive interface for Hg.
END-INFO-DIR-ENTRY


File: monky.info, Node: Top, Next: Introduction, Up: (dir)
Expand Down Expand Up @@ -38,7 +42,7 @@ File: monky.info, Node: Introduction, Next: Sections, Prev: Top, Up: Top
1 Introduction
**************

Monky provides an interactive interface for Hg. Using Monky, your can
Monky provides an interactive interface for Hg. Using Monky, your can
selectively commit files, view the diffs and other things.


Expand All @@ -47,21 +51,21 @@ File: monky.info, Node: Sections, Next: Status, Prev: Introduction, Up: Top
2 Sections
**********

All items in the Monky buffers are nested 'sections'. The visibility of
the current section can be toggled using `TAB' key. When a section is
hidden, only its first line is shown and all its children are
completely invisible.
All items in the Monky buffers are nested sections’. The visibility of
the current section can be toggled using TAB key. When a section is
hidden, only its first line is shown and all its children are completely
invisible.


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

3 Status
********

Running `M-x monky-status' while visiting any file in a repo displays
the status of the hg repo. The status buffer list down the missing
files, untracked files and changed files. By default the diff of the
files are invisible. Use `TAB' key to toggle the visibility.
Running M-x monky-status while visiting any file in a repo displays
the status of the hg repo. The status buffer list down the missing
files, untracked files and changed files. By default the diff of the
files are invisible. Use TAB key to toggle the visibility.

During a merge the buffer will show the list of merged files, and
files unmodified during the merge.
Expand All @@ -72,7 +76,7 @@ File: monky.info, Node: Untracked files, Next: Missing Files, Prev: Status,
4 Untracked files
*****************

you can add a untracked file by typing key `s'. Type `k' to delete the
You can add a untracked file by typing key ‘s’. Type ‘k’ to delete the
file.


Expand All @@ -81,42 +85,42 @@ File: monky.info, Node: Missing Files, Next: Staging and Committing, Prev: Un
5 Missing Files
***************

This section list the files missing from the repo. Typing `s' will
remove the file from the repo. To restore the file type `k'.
This section list the files missing from the repo. Typing ‘s’ will
remove the file from the repo. To restore the file type ‘k’.


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

6 Staging and Committing
************************

_Changes_ section will list all the changes in the repo. Using monky
you can select a subset of your changes and commit it. Type `s' to
stage a file. Typing `S' will stage all files.
_Changes_ section will list all the changes in the repo. Using monky
you can select a subset of your changes and commit it. Type ‘s’ to
stage a file. Typing ‘S’ will stage all files.

_Staged Changes_ section will list all the staged changes in the
repo. Type `u' to unstage a file. Typing `U' will unstage all the
repo. Type ‘u’ to unstage a file. Typing ‘U’ will unstage all the
previously staged files.

Once you staged all the necessary files type `c'. This will pop-up a
buffer for the commit message. Typing `C-c C-c' will commit all the
Once you staged all the necessary files type ‘c’. This will pop-up a
buffer for the commit message. Typing C-c C-c will commit all the
staged files.

You can reset the current working directory by typing `X'.
You can reset the current working directory by typing ‘X’.

Hg doesn't have any staging area. So staging and unstaging won't make
any changes to your repo unless you commit.
Hg doesnt have any staging area. So staging and unstaging won’t
make any changes to your repo unless you commit.


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

7 Merged Files
**************

After a merge, this section will list the files merged. Typing `m' will
mark the file as resolved and `x' will mark the file as unresolved.
After a merge, Hg doesn't allows to commit a subset of changes. so
files can't be staged or unstaged. So committing after a merge will
After a merge, this section will list the files merged. Typing ‘m’ will
mark the file as resolved and ‘x’ will mark the file as unresolved.
After a merge, Hg doesnt allows to commit a subset of changes. so
files cant be staged or unstaged. So committing after a merge will
commit all the merged and unmodified files during the merge.


Expand All @@ -125,33 +129,33 @@ File: monky.info, Node: Pushing and Pulling, Next: Log, Prev: Merged Files,
8 Pushing and Pulling
*********************

Type `P' to push the current branch, `f' to pull changes from remote
and `F' to fetch changes from the remote. You can specify the
source/destination to the previous commands with a prefix argument.
Type ‘P’ to push the current branch, ‘f’ to pull changes from remote and
‘F’ to fetch changes from the remote. You can specify the
source/destination to the previous commands with a prefix argument.


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

9 Log
*****

Typing `l' will bring up the log buffer. This will list the commit logs
of the repo. You can use `n' and `p' to move to the previous and next
commit. Type `RET' to see the commit information, `C' to checkout the
Typing ‘l’ will bring up the log buffer. This will list the commit logs
of the repo. You can use ‘n’ and ‘p’ to move to the previous and next
commit. Type RET to see the commit information, ‘C’ to checkout the
commit.

Monky will show only `monky-log-cutoff-length' entries. Typing `e'
will show twice as many entries. `C-u e' will show all entries, and
given a numeric prefix argument, `e' will add this number of entries.
Monky will show only monky-log-cutoff-length entries. Typing ‘e’
will show twice as many entries. C-u e will show all entries, and
given a numeric prefix argument, ‘e’ will add this number of entries.


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

10 Blame
********

Run `M-x monky-blame-current-file' to see the annotation of the current
file. Type `RET' to see the commit which introduced/changed the current
Run M-x monky-blame-current-file to see the annotation of the current
file. Type RET to see the commit which introduced/changed the current
line.


Expand All @@ -160,35 +164,35 @@ File: monky.info, Node: Branch, Next: Queue, Prev: Blame, Up: Top
11 Branch
*********

Typing `b' will bring up the branch buffer. This will list all the
branches. You can use `C' to checkout a branch.
Typing ‘b’ will bring up the branch buffer. This will list all the
branches. You can use ‘C’ to checkout a branch.


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

12 Queue
********

Use `M-x monky-queue' or `Q' from the status buffer to view the queue
buffer. The queue buffer will list the _Applied Patches_, _UnApplied
Use M-x monky-queue or ‘Q’ from the status buffer to view the queue
buffer. The queue buffer will list the _Applied Patches_, _UnApplied
Patches_ and the _Series_.

Key Description
--------------------------------------------------------------------------
--------------------------------------------------------------------------
u pop the selected patch and all the patches before it
U pop all the applied patches
s push the selected patch and all the patches before it
S push all the unapplied patches
r refresh(update) the current patch with the changes in working
directory
r refresh(update) the current patch with the changes in
working directory
C-u r refresh the current patch and allows to edit the commit
message
R rename the selected patch
k remove the selected patch
N create a new patch on top of current patch
C-u N same as N except this will also read the commit message for
the patch
i import(qimport) patches from change sets. a change set at
i import(qimport) patches from change sets. a change set at
the point or change sets in a selected region (when
selected) will be imported.
d fold the selected patch into the current patch
Expand All @@ -204,26 +208,31 @@ File: monky.info, Node: Using Hg Directly, Prev: Queue, Up: Top
13 Using Hg Directly
********************

To run a Hg command directly type `:' and enter the command in the
minibuffer. This will refresh the status buffer after the execution of
command. The output of the command can be viewed by typing `$'.
To run a Hg command directly type ‘:’ and enter the command in the
minibuffer. This will refresh the status buffer after the execution of
command. The output of the command can be viewed by typing ‘$’.



Tag Table:
Node: Top421
Node: Introduction812
Node: Sections1053
Node: Status1386
Node: Untracked files1864
Node: Missing Files2070
Node: Staging and Committing2339
Node: Merged Files3174
Node: Pushing and Pulling3652
Node: Log3989
Node: Blame4516
Node: Branch4757
Node: Queue4967
Node: Using Hg Directly6480
Node: Top549
Node: Introduction940
Node: Sections1182
Node: Status1525
Node: Untracked files2014
Node: Missing Files2229
Node: Staging and Committing2508
Node: Merged Files3383
Node: Pushing and Pulling3876
Node: Log4225
Node: Blame4793
Node: Branch5043
Node: Queue5263
Node: Using Hg Directly6785

End Tag Table


Local Variables:
coding: utf-8
End:
7 changes: 6 additions & 1 deletion monky.texi
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ Texts.
@end quotation
@end copying

@dircategory Emacs
@direntry
* Monky: (monky). An interactive interface for Hg.
@end direntry

@node Top
@top Monky User Manual

Expand Down Expand Up @@ -65,7 +70,7 @@ files unmodified during the merge.
@node Untracked files
@chapter Untracked files

you can add a untracked file by typing key @kbd{s}. Type @kbd{k} to
You can add a untracked file by typing key @kbd{s}. Type @kbd{k} to
delete the file.

@node Missing Files
Expand Down

0 comments on commit 7046eee

Please sign in to comment.