Changes between Version 2 and Version 3 of ManagingFiles

Timestamp:

May 11, 2015, 2:16:09 PM (10 years ago)

Author:

manualwiki

Comment:

Extending ri:add_app(...) section.

ManagingFiles

@@ -223 +223 @@
 ==== Rebar Parser ====
 
-The application directory layout must follow the Rebar and OTP conventions (src, priv, include, ebin), for further details please refer to https://github.com/rebar/rebar/wiki.
-The rebar parser reads recursively the directories and the rebar.config files. 
+The application directory layout must follow the Rebar and OTP conventions (src, priv, include, ebin), for further details please refer to https://github.com/rebar/rebar/wiki.\\
+The rebar parser reads recursively the directories and the rebar.config files.\\
 The subdirectories inhert the the rebar.config options from the parent directories the rebar.config options from the actual directory may overrides them.
 
@@ -270 +270 @@
 Further reading: http://www.erlang.org/doc/man/make.html.
 
-refcore_emakefile_parser:parse/2
+Interface options refcore_emakefile_parser:parse/2
 * DirectoryOrEmakefilePath - Path to the Emakefile or to the application directory
 * _  - second argument is ignored during the Emakefile parsing.
 [=#point3 ] 
 ==== erlang_mk Parser ====
+Expected directory structure: src, ebin, test
+Application requirements:
+erlang.mk contains common makefile rules for building an application.\\
+Use it together with GNU make, add it to your project an include it in your Makefile:
+{{{
+#!sh
+PROJECT = my_project
+include erlang.mk
+}}}
+It provides a set of core rules like all, deps, app, rel, docs, tests, clean, etc...
+
+A convenient way to create an application skeleton using erlang.mk is:
+{{{
+#!sh
+make -f erlang.mk bootstrap
+}}}
 
 Further reading: https://github.com/ninenines/erlang.mk
+
+Interface options refcore_erlang_mk_parser:parse/2
+* DirectoryOrErlMkPath - Path to the Makefile or to the application directory
+* _  - second argument is ignored during the Emakefile parsing.
+
+The parser reads the files from the src, test directories. \\Also processes the Makefile and checks the presence of the required "include erlang.mk" keywords and reads the variables below:
+* ERLC_OPTS - compilation options 
+* DEPS_DIR - location of the dependencies
+* DEPS - names of the dependencies
+
 [=#point4 ] 
 ==== Makefile Parser ====
+The Makefile Parser tries to evaluate three kind of macros directly from the Makefile.\\
+
+Default Makefile variables:
+* INCDIR - Makefile macro that contains the includes
+* CXC_TARGET - Makefile macro that contains the destination files
+* CXA_TARGET - Secondary include Makefile macro.
+
+The default Makefile macros can be overridden via ri:add_app("....", UserOptions) \\
+UserOptions = [{include_macro, 'INCDIR'}, {target_macro, 'CXC_TARGET'}, {sec_include_macro,'CXA_TARGET'}] \\
+
+
 Further reading: http://www.gnu.org/software/make/manual/make.html