--testing: version and date does not change. Bump to 1.4.4
This commit is contained in:
parent
f09d617005
commit
3d31f32b93
23
ldoc.lua
23
ldoc.lua
|
@ -27,17 +27,18 @@ local tablex = require 'pl.tablex'
|
||||||
|
|
||||||
-- Penlight compatibility
|
-- Penlight compatibility
|
||||||
utils.unpack = utils.unpack or unpack or table.unpack
|
utils.unpack = utils.unpack or unpack or table.unpack
|
||||||
|
|
||||||
local append = table.insert
|
local append = table.insert
|
||||||
|
|
||||||
local lapp = require 'pl.lapp'
|
local lapp = require 'pl.lapp'
|
||||||
|
|
||||||
|
local version = '1.4.4'
|
||||||
|
|
||||||
-- so we can find our private modules
|
-- so we can find our private modules
|
||||||
app.require_here()
|
app.require_here()
|
||||||
|
|
||||||
--- @usage
|
--- @usage
|
||||||
local usage = [[
|
local usage = [[
|
||||||
ldoc, a documentation generator for Lua, vs 1.4.3
|
ldoc, a documentation generator for Lua, vs ]]..version..[[
|
||||||
|
|
||||||
-d,--dir (default doc) output directory
|
-d,--dir (default doc) output directory
|
||||||
-o,--output (default 'index') output name
|
-o,--output (default 'index') output name
|
||||||
-v,--verbose verbose
|
-v,--verbose verbose
|
||||||
|
@ -66,6 +67,8 @@ ldoc, a documentation generator for Lua, vs 1.4.3
|
||||||
--filter (default none) filter output as Lua data (e.g pl.pretty.dump)
|
--filter (default none) filter output as Lua data (e.g pl.pretty.dump)
|
||||||
--tags (default none) show all references to given tags, comma-separated
|
--tags (default none) show all references to given tags, comma-separated
|
||||||
--fatalwarnings non-zero exit status on any warning
|
--fatalwarnings non-zero exit status on any warning
|
||||||
|
--testing reproducible build; no date or version on output
|
||||||
|
|
||||||
<file> (string) source file or directory containing source
|
<file> (string) source file or directory containing source
|
||||||
|
|
||||||
`ldoc .` reads options from an `config.ld` file in same directory;
|
`ldoc .` reads options from an `config.ld` file in same directory;
|
||||||
|
@ -101,8 +104,6 @@ function ProjectMap:_init ()
|
||||||
self.fieldname = 'type'
|
self.fieldname = 'type'
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
local lua, cc = lang.lua, lang.cc
|
local lua, cc = lang.lua, lang.cc
|
||||||
|
|
||||||
local file_types = {
|
local file_types = {
|
||||||
|
@ -120,7 +121,7 @@ local file_types = {
|
||||||
------- ldoc external API ------------
|
------- ldoc external API ------------
|
||||||
|
|
||||||
-- the ldoc table represents the API available in `config.ld`.
|
-- the ldoc table represents the API available in `config.ld`.
|
||||||
local ldoc = { charset = 'UTF-8' }
|
local ldoc = { charset = 'UTF-8', version = version }
|
||||||
|
|
||||||
local known_types, kind_names = {}
|
local known_types, kind_names = {}
|
||||||
|
|
||||||
|
@ -238,7 +239,7 @@ local ldoc_contents = {
|
||||||
'unqualified', 'custom_display_name_handler', 'kind_names', 'custom_references',
|
'unqualified', 'custom_display_name_handler', 'kind_names', 'custom_references',
|
||||||
'dont_escape_underscore','global_lookup','prettify_files','convert_opt', 'user_keywords',
|
'dont_escape_underscore','global_lookup','prettify_files','convert_opt', 'user_keywords',
|
||||||
'postprocess_html',
|
'postprocess_html',
|
||||||
'custom_css',
|
'custom_css','version'
|
||||||
}
|
}
|
||||||
ldoc_contents = tablex.makeset(ldoc_contents)
|
ldoc_contents = tablex.makeset(ldoc_contents)
|
||||||
|
|
||||||
|
@ -806,14 +807,18 @@ ldoc.title = ldoc.title or args.title
|
||||||
ldoc.project = ldoc.project or args.project
|
ldoc.project = ldoc.project or args.project
|
||||||
ldoc.package = args.package:match '%a+' and args.package or nil
|
ldoc.package = args.package:match '%a+' and args.package or nil
|
||||||
|
|
||||||
if os.getenv("SOURCE_DATE_EPOCH") == nil then
|
local source_date_epoch = os.getenv("SOURCE_DATE_EPOCH")
|
||||||
|
if args.testing then
|
||||||
|
ldoc.updatetime = "2015-01-01 12:00:00"
|
||||||
|
ldoc.version = 'TESTING'
|
||||||
|
elseif source_date_epoch == nil then
|
||||||
if args.date == 'system' then
|
if args.date == 'system' then
|
||||||
ldoc.updatetime = os.date("%Y-%m-%d %H:%M:%S")
|
ldoc.updatetime = os.date("%Y-%m-%d %H:%M:%S")
|
||||||
else
|
else
|
||||||
ldoc.updatetime = args.date
|
ldoc.updatetime = args.date
|
||||||
end
|
end
|
||||||
else
|
else
|
||||||
ldoc.updatetime = os.date("!%Y-%m-%d %H:%M:%S",os.getenv("SOURCE_DATE_EPOCH"))
|
ldoc.updatetime = os.date("!%Y-%m-%d %H:%M:%S",source_date_epoch)
|
||||||
end
|
end
|
||||||
|
|
||||||
local html = require 'ldoc.html'
|
local html = require 'ldoc.html'
|
||||||
|
|
|
@ -306,7 +306,7 @@ return [==[
|
||||||
</div> <!-- id="content" -->
|
</div> <!-- id="content" -->
|
||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc $(ldoc.version)</a></i>
|
||||||
<i style="float:right;">Last updated $(ldoc.updatetime) </i>
|
<i style="float:right;">Last updated $(ldoc.updatetime) </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
|
|
|
@ -1,6 +1,18 @@
|
||||||
function run_test(dir)
|
local run
|
||||||
os.execute('cd '..dir..' && ldoc --testing . && diff -r doc cdocs')
|
if not arg[1] then
|
||||||
|
run = function (dir)
|
||||||
|
local cmd = 'cd '..dir..' && ldoc --testing . && diff -r doc cdocs'
|
||||||
|
print(cmd)
|
||||||
|
os.execute(cmd)
|
||||||
|
end
|
||||||
|
elseif arg[1] == 'update' then
|
||||||
|
run = function (dir)
|
||||||
|
local cmd = 'cd '..dir..' && ldoc --dir cdocs --testing .'
|
||||||
|
print(cmd)
|
||||||
|
os.execute(cmd)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
for _,d in ipairs{'tests','tests/example','tests/md-test'} do
|
||||||
|
run(d)
|
||||||
end
|
end
|
||||||
run_test('tests')
|
|
||||||
run_test('tests/example')
|
|
||||||
run_test('tests/md-test')
|
|
||||||
|
|
|
@ -10,7 +10,7 @@ local _M = {}
|
||||||
_M.Bonzo = class()
|
_M.Bonzo = class()
|
||||||
|
|
||||||
--- a method.
|
--- a method.
|
||||||
-- function one
|
-- function one; reference to @{one.md.classes|documentation}
|
||||||
function Bonzo:one()
|
function Bonzo:one()
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
|
@ -2,4 +2,4 @@ format='markdown'
|
||||||
project = 'Basic Example'
|
project = 'Basic Example'
|
||||||
file = {'types.lua','classes.lua'}
|
file = {'types.lua','classes.lua'}
|
||||||
use_markdown_titles=true
|
use_markdown_titles=true
|
||||||
topics = {'one 1.md','two.md'}
|
topics = {'one.md','two.md'}
|
||||||
|
|
Loading…
Reference in New Issue