1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
%% -*- erlang-indent-level: 4;indent-tabs-mode: nil -*-
%% ex: ts=4 sw=4 et
%% -------------------------------------------------------------------
%%
%% rebar: Erlang Build Tools
%%
%% Copyright (c) 2010 Dave Smith (dizzyd@dizzyd.com)
%%
%% Permission is hereby granted, free of charge, to any person obtaining a copy
%% of this software and associated documentation files (the "Software"), to deal
%% in the Software without restriction, including without limitation the rights
%% to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
%% copies of the Software, and to permit persons to whom the Software is
%% furnished to do so, subject to the following conditions:
%%
%% The above copyright notice and this permission notice shall be included in
%% all copies or substantial portions of the Software.
%%
%% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
%% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
%% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
%% AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
%% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
%% OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
%% THE SOFTWARE.
%% -------------------------------------------------------------------
%% @author Dave Smith <dizzyd@dizzyd.com>
%% @doc rebar_edoc supports the following command:
%% <ul>
%% <li>doc (essentially erl -noshell -run edoc_run application
%% "'$(<app_name>)'"
%% '"."' '[<options>]')</li>
%% </ul>
%% EDoc options can be given in the <code>edoc_opts</code> option in
%% <code>rebar.config</code>.
%% @copyright 2010 Dave Smith
%% -------------------------------------------------------------------
-module(rebar_edoc).
-export([doc/2]).
%% for internal use only
-export([info/2]).
-include("rebar.hrl").
%% ===================================================================
%% Public API
%% ===================================================================
doc(Config, File) ->
%% Save code path
CodePath = setup_code_path(),
%% Get the edoc_opts and app file info
EDocOpts = rebar_config:get(Config, edoc_opts, []),
{ok, Config1, AppName, _AppData} =
rebar_app_utils:load_app_file(Config, File),
case needs_regen(EDocOpts) of
true ->
?INFO("Regenerating edocs for ~p\n", [AppName]),
ok = edoc:application(AppName, ".", EDocOpts);
false ->
?INFO("Skipping regeneration of edocs for ~p\n", [AppName]),
ok
end,
%% Restore code path
true = rebar_utils:cleanup_code_path(CodePath),
{ok, Config1}.
%% ===================================================================
%% Internal functions
%% ===================================================================
info(help, doc) ->
?CONSOLE(
"Generate Erlang program documentation.~n"
"~n"
"Valid rebar.config options:~n"
" {edoc_opts, []} (see edoc:application/3 documentation)~n",
[]).
setup_code_path() ->
%% Setup code path prior to calling edoc so that edown, asciiedoc,
%% and the like can work properly when generating their own
%% documentation.
CodePath = code:get_path(),
_ = code:add_patha(rebar_utils:ebin_dir()),
CodePath.
-type path_spec() :: {'file', file:filename()} | file:filename().
-spec newer_file_exists(Paths::[path_spec()], OldFile::string()) -> boolean().
newer_file_exists(Paths, OldFile) ->
OldModTime = filelib:last_modified(OldFile),
ThrowIfNewer = fun(Fn, _Acc) ->
FModTime = filelib:last_modified(Fn),
(FModTime > OldModTime) andalso
throw({newer_file_exists, {Fn, FModTime}})
end,
try
lists:foldl(fun({file, F}, _) ->
ThrowIfNewer(F, false);
(P, _) ->
filelib:fold_files(P, ".*.erl", true,
ThrowIfNewer, false)
end, undefined, Paths)
catch
throw:{newer_file_exists, {Filename, FMod}} ->
?DEBUG("~p is more recent than ~p: "
"~120p > ~120p\n",
[Filename, OldFile, FMod, OldModTime]),
true
end.
%% Needs regen if any dependent file is changed since the last
%% edoc run. Dependent files are the erlang source files,
%% and the overview file, if it exists.
-spec needs_regen(proplists:proplist()) -> boolean().
needs_regen(EDocOpts) ->
DocDir = proplists:get_value(dir, EDocOpts, "doc"),
EDocInfoName = filename:join(DocDir, "edoc-info"),
OverviewFile = proplists:get_value(overview, EDocOpts, "overview.edoc"),
EDocOverviewName = filename:join(DocDir, OverviewFile),
SrcPaths = proplists:get_value(source_path, EDocOpts, ["src"]),
newer_file_exists([{file, EDocOverviewName} | SrcPaths], EDocInfoName).
|
