Skip to content

Commit

Permalink
more documentation updates for auto-recompilation
Browse files Browse the repository at this point in the history
  • Loading branch information
stevengj committed Aug 5, 2015
1 parent caf19c5 commit 451ab02
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
3 changes: 2 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ New language features

* Incremental compilation of modules: `Base.compile(module::Symbol)` imports the named module,
but instead of loading it into the current session saves the result of compiling it in
`~/.julia/lib/v0.4` ([#8745]).
`~/.julia/lib/v0.4` ([#8745]). The module will automatically be recompiled as needed ([#12458]).

* See manual section on `Module initialization and precompilation` (under `Modules`) for details and errata.

Expand Down Expand Up @@ -1557,3 +1557,4 @@ Too numerous to mention.
[#12137]: https://github.com/JuliaLang/julia/issues/12137
[#12162]: https://github.com/JuliaLang/julia/issues/12162
[#12393]: https://github.com/JuliaLang/julia/issues/12393
[#12458]: https://github.com/JuliaLang/julia/issues/12458
6 changes: 6 additions & 0 deletions doc/manual/modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,12 @@ recompile Julia after modifying the file ``base/userimg.jl`` to require the desi
To create an incremental precompiled module file,
call ``Base.compile(modulename::Symbol)``.
The resulting cache files will be stored in ``Base.LOAD_CACHE_PATH[1]``.
(This will also compile any modules that your module depends on.)
Once it has been compiled, the module will automatically be recompiled
as needed (if any of its ``include`` dependencies or imported modules
have changed) when it is imported. (The ``include_dependency(path)``
function can be called in your module to declare a dependency on
an arbitrary file that you did not ``include``.)

In order to make your module work with precompilation,
however, you may need to change your module to explicitly separate any
Expand Down

0 comments on commit 451ab02

Please sign in to comment.