Changes between Version 3 and Version 4 of ErlangShellInterface

Timestamp:

Mar 13, 2012, 10:20:04 AM (13 years ago)

Author:

daniel_h

Comment:

--

ErlangShellInterface

@@ -1 +1 @@
 
 == !RefactorErl Console Interface ==
-After start up you can use the ri module to interact easily with the tool. With this you can add files/directories to the database, run semantic queries, create backups, or even do transformations, etc.
-
-
-== General help ==
-Help can be acquired in ri with
+
+When running !RefactorErl, you can control the tool via function calls typed into the Erlang shell. !RefactorErl has many features, and is quite a complex system with dozen of functions whose name we do not expect our users to remember. In order to ease and unify the command-level access to all the analysis and refactoring functionality, we have designed a group of Erlang functions that cover the most frequently used features of the tool. The module these functions are located in is called {{{ri}}}, you can use this module to interact easily with the tool. You can add files/directories to the database, run semantic queries, create backups, or even do transformations via this Erlang-level interface.
+
+== Command-line help ==
+
+Help can be acquired in {{{ri}}} with
 
 {{{
@@ -17 +18 @@
 }}}
 
-This function lists several topics, on which further help is available as
+This function lists several topics, on which further help is available by
 
 {{{
@@ -23 +24 @@
 }}}
 
-If the name of a function is known, specic help can be acquired by adding
-an _h postfix to the name. For example, help for the function add is available
-as
-
+If you need specific help with a function, simply call it with an {{{_h}}} postfix to the name. For example, help for the function add is available by calling
 
 {{{
@@ -34 +32 @@
 
 == Compiling the tool ==
-The tool can be recompiled by invoking
+
+The tool can be compiled/recompiled by invoking
 
 {{{
@@ -40 +39 @@
 }}}
 
-This function can also take a list of build parameters. This feature is mostly
-used through development.
-Note that this function tries to compile the C++ files as well, if these were
-not compiled before. So if you want to prevent this, then you have to specify the
-no_nif additional parameter to the function. So in this case the recompilation
-looks like this:
-
-{{{
-ri:build(no_nif).
-}}}
-
+You can also specify build parameters, but this feature is mostly applied through the development, so please find the module documentation for the details. Note that this build function tries to compile the C++ files as well, if they have not been compiled yet. If you want to prevent the C++ compilation, you can use the {{{no_nif}}} build parameter.
 
 == Managing files ==
+
 You can add files to the !RefactorErl database by calling the
 add function with either a filename as a string or a module name as an atom.