Steve Losh avatar Steve Losh committed f09a5f2

Add caveats to the README.

Comments (0)

Files changed (1)

 avoiding the time it takes to start the Python interpreter and load all the
 Mercurial code.
 
+Caveats
+-------
+
+* Interactive commands, like `hg record` and `hg commit` with no args (usually
+  opens an editor) are borked.
+* Output isn't shown until the command is finished. That means you don't get
+  incremental notifications from `hg push`, etc.
+* Arguments (like `-m` for `hg commit`) cannot contain newlines.
+* Color is always enabled.  Not suitable for scripting.
+* Standard error is combined with standard output.  Not suitable for scripting.
+* It will probably eat your data.
+
 Requirements
 ------------
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.