Changes between Version 1 and Version 2 of ManagingFiles

Timestamp:

May 11, 2015, 11:14:26 AM (10 years ago)

Author:

manualwiki

Comment:

Adding ri:add_app(...) section.

ManagingFiles

@@ -194 +194 @@
 
 Applications can be dropped from the database in the same way as the normal files.
+===  Adding applications using unified build tools ri:add_app(1|2) ===
+
+The main goal of this approach to make the application loading method simpler to the end user.
+
+The loading of files are simplified to the ri:add_app(1|2) interface that is extensible and can support various build tools.
+
+Control flow details 
+{{{#!erlang
+ri:add_app(1|2) ==> reflib_ui_router:request/2 ==> reflib_ui:add_app/3 ==> 
+==> refcore_apploader:add_app/3 ==> refcore_confparser:parser/2 ==> refcore_$(parser):parse/2
+               +
+    refcore_apploader:add_files                                             $(parser) : [rebar, emakefile, erlang_mk, makefile]
+}}}
+
+The confparser tries to recognize the parser primarily by the name of the file if the passed path is a regular file (rebar, Emakefile, erlang.mk, Makefile).
+When the passed path is a directory the following priority takes place in detecting the appropriate parser : rebar, rebar.config, Emakefile, erlang.mk, Makefile.
+See the configuration of various parsers below:
+
+see [#point1 Rebar Parser]
+
+see [#point2 Emakefile Parser]
+
+see [#point3 erlang_mk Parser]
+
+see [#point4 Makefile Parse]
+
+[=#point1] 
+==== 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 subdirectories inhert the the rebar.config options from the parent directories the rebar.config options from the actual directory may overrides them.
+
+
+Interface options refcore_rebar_parser:parse/2
+* BaseDirectoryOrRebarPath - Application base dir or the path including the rebar.config file
+* UserOptions - user properties [{rebar_load_tests, true}]
+
+The parser extracts the following options from rebar.config file:
+   * lib_dirs - additional library directories to add to the code path
+   * erl_first_files - rrlang files to compile before the rest
+   * erl_opts - erlang compiler options
+   * sub_dirs - subdirectories
+   * deps_dir - location of dependencies.
+   * deps - dependencies 
+When the user property rebar_load_tests is set to true the tests related options are also loaded:
+   * ct_dir - test SUITEs location
+   * ct_extra_params - option to pass extra parameters when launching Common Test (-dir, -include, -spec ) 
+   * eunit_first_files - same as erl_first_files, but used only when running 'eunit'
+   * eunit_compile_opts - additional compile options for eunit. erl_opts is also used (-dir, -include, -spec ), 
+   * qc_first_files - same as erl_first_files, but used only when running 'qc'
+   * qc_compile_opts - additional compile options for qc. erl_opts is also used (-dir, -include, -spec ) 
+
+Further details and a more complete example of the rebar.config file is available at: https://github.com/rebar/rebar/blob/master/rebar.config.sample
+[=#point2 ] 
+==== Emakefile Parser ====
+The Emakefile Parser consults the given Emakefile and extracts the files and other information (appbase,def).
+
+Example Emakefile:
+{{{#!erlang
+{'src/hello',
+
+   [debug_info,
+     {i,"include"},
+     {outdir, "ebin"}
+   ]
+
+}.
+
+{'src/*',
+   [debug_info]
+}.
+}}}
+
+Further reading: http://www.erlang.org/doc/man/make.html.
+
+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 ====
+
+Further reading: https://github.com/ninenines/erlang.mk
+[=#point4 ] 
+==== Makefile Parser ====
+Further reading: http://www.gnu.org/software/make/manual/make.html
 
 == Refreshing your database ==