diff --git a/.gitignore b/.gitignore index ad4e629..5092143 100644 --- a/.gitignore +++ b/.gitignore @@ -2,7 +2,5 @@ .DS_Store /*.src.rock /build-aux/config.ld -/doc -/lib/std/_debug/version.lua /luacov.*.out /stdlib-*.tar.gz diff --git a/Makefile b/Makefile index 300e587..72b75f3 100644 --- a/Makefile +++ b/Makefile @@ -7,7 +7,7 @@ MKDIR = mkdir -p SED = sed SPECL = specl -VERSION = git +VERSION = 1.0.1 luadir = lib/std/_debug SOURCES = \ diff --git a/NEWS.md b/NEWS.md index cf35106..285da86 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,8 +1,5 @@ # Stdlib NEWS - User visible changes -## Noteworthy changes in release ?.? (????-??-??) [?] - - ## Noteworthy changes in release 1.0.1 (2018-09-22) [stable] ### New Features diff --git a/README.md b/README.md index 73f51d8..8d21883 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Debug Hints Library Copyright (C) 2002-2018 [std._debug authors][authors] [![License](http://img.shields.io/:license-mit-blue.svg)](http://mit-license.org) -[![travis-ci status](https://secure.travis-ci.org/lua-stdlib/_debug.png?branch=master)](http://travis-ci.org/lua-stdlib/_debug/builds) +[![travis-ci status](https://secure.travis-ci.org/lua-stdlib/_debug.png?branch=release-v1.0.1)](http://travis-ci.org/lua-stdlib/_debug/builds) [![codecov.io](https://codecov.io/gh/lua-stdlib/_debug/branch/master/graph/badge.svg)](https://codecov.io/gh/lua-stdlib/_debug) [![Stories in Ready](https://badge.waffle.io/lua-stdlib/_debug.png?label=ready&title=Ready)](https://waffle.io/lua-stdlib/_debug) diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 0000000..e56d061 --- /dev/null +++ b/doc/index.html @@ -0,0 +1,234 @@ + + + + + std._debug 1.0.1 Reference + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module std._debug

+

Manage debug mode, and associated substate hints.

+

Set or change all the debug substate hints by calling the returned + module functable with no argument to reset to defaults; with true + to set all substate hints into development mode, or false for + production mode.

+ + +
+local _debug = require 'std._debug'(false)
+
+ +

Query substate hints by indexing the returned module functable keys:

+ + +
+local isstrict = _debug.strict
+
+ +

Beware that even though you can change std._debug state at any time, + stdlib libraries in particular (but probably other clients too) are + configured at load time according to the state at the time they are + required - e.g. changing _debug.strict after require 'std' does not + affect the strict environment already created for the 'std' module + when it was previously loaded.

+ + +

Metamethods

+ + + + + + + + + +
__call ([enable])Change the all builtin debug hints.
__index (name)Lazy loading of std._debug modules.
+

Types

+ + + + + +
SubstatesBuiltin debug substate hints.
+ +
+
+ + +

Metamethods

+ +
+
+ + __call ([enable]) +
+
+ Change the all builtin debug hints. + + +

Parameters:

+
    +
  • enable + bool + or disable all debugging substate hints + (optional) +
    • +
+ +

Returns:

+
    + + Substates + substates +
+ + + +

Usage:

+
    + 
    -- Enable all debugging substates
+local _debug = require 'std._debug'(true)
    +
+ +
+
+ + __index (name) +
+
+ Lazy loading of std._debug modules. + Don't load everything on initial startup, wait until first attempt + to access a submodule, and then load it on demand. + + +

Parameters:

+
    +
  • name + string + submodule name +
    • +
+ +

Returns:

+
    + + table or nil + +

    the submodule that was loaded to satisfy the missing

    +
    `name`, otherwise `nil` if nothing was found
+
    + +
+ + + +

Usage:

+
    + 
    local version = require 'std._debug'.version
    +
+ +
+
+

Types

+ +
+
+ + Substates +
+
+ Builtin debug substate hints.

+ +

Use __call metamethod to set all substate hints at once. + Note that none of the debugging features required to implement these + hints are encoded here, this module is merely a central location to + record systemwide hint; other modules you load subsequently may or may + not choose to behave according to their content. + + +

Fields:

+
    +
  • argcheck + bool + true if runtime argument checking is desired + (default true) +
    • +
  • deprecate + bool + nil if deprecated api warnings are desired; + false if deprecated apis without warnings are desired; true if + removal of deprecated apis is preferred + (optional) +
    • +
  • level + int + debugging level + (default 1) +
    • +
  • strict + bool + true if strict enforcement of variable declaration + before use is desired + (default true) +
    • +
+ + + + +

Usage:

+
    + 
    require 'std._debug'.argcheck = false
    +
+ +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2018-09-22 16:00:27 +
+
+ + diff --git a/doc/ldoc.css b/doc/ldoc.css new file mode 100644 index 0000000..52c4ad2 --- /dev/null +++ b/doc/ldoc.css @@ -0,0 +1,303 @@ +/* BEGIN RESET + +Copyright (c) 2010, Yahoo! Inc. All rights reserved. +Code licensed under the BSD License: +http://developer.yahoo.com/yui/license.html +version: 2.8.2r1 +*/ +html { + color: #000; + background: #FFF; +} +body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td { + margin: 0; + padding: 0; +} +table { + border-collapse: collapse; + border-spacing: 0; +} +fieldset,img { + border: 0; +} +address,caption,cite,code,dfn,em,strong,th,var,optgroup { + font-style: inherit; + font-weight: inherit; +} +del,ins { + text-decoration: none; +} +li { + margin-left: 20px; +} +caption,th { + text-align: left; +} +h1,h2,h3,h4,h5,h6 { + font-size: 100%; + font-weight: bold; +} +q:before,q:after { + content: ''; +} +abbr,acronym { + border: 0; + font-variant: normal; +} +sup { + vertical-align: baseline; +} +sub { + vertical-align: baseline; +} +legend { + color: #000; +} +input,button,textarea,select,optgroup,option { + font-family: inherit; + font-size: inherit; + font-style: inherit; + font-weight: inherit; +} +input,button,textarea,select {*font-size:100%; +} +/* END RESET */ + +body { + margin-left: 1em; + margin-right: 1em; + font-family: arial, helvetica, geneva, sans-serif; + background-color: #ffffff; margin: 0px; +} + +code, tt { font-family: monospace; font-size: 1.1em; } +span.parameter { font-family:monospace; } +span.parameter:after { content:":"; } +span.types:before { content:"("; } +span.types:after { content:")"; } +.type { font-weight: bold; font-style:italic } + +body, p, td, th { font-size: .95em; line-height: 1.2em;} + +p, ul { margin: 10px 0 0 0px;} + +strong { font-weight: bold;} + +em { font-style: italic;} + +h1 { + font-size: 1.5em; + margin: 20px 0 20px 0; +} +h2, h3, h4 { margin: 15px 0 10px 0; } +h2 { font-size: 1.25em; } +h3 { font-size: 1.15em; } +h4 { font-size: 1.06em; } + +a:link { font-weight: bold; color: #004080; text-decoration: none; } +a:visited { font-weight: bold; color: #006699; text-decoration: none; } +a:link:hover { text-decoration: underline; } + +hr { + color:#cccccc; + background: #00007f; + height: 1px; +} + +blockquote { margin-left: 3em; } + +ul { list-style-type: disc; } + +p.name { + font-family: "Andale Mono", monospace; + padding-top: 1em; +} + +pre { + background-color: rgb(245, 245, 245); + border: 1px solid #C0C0C0; /* silver */ + padding: 10px; + margin: 10px 0 10px 0; + overflow: auto; + font-family: "Andale Mono", monospace; +} + +pre.example { + font-size: .85em; +} + +table.index { border: 1px #00007f; } +table.index td { text-align: left; vertical-align: top; } + +#container { + margin-left: 1em; + margin-right: 1em; + background-color: #f0f0f0; +} + +#product { + text-align: center; + border-bottom: 1px solid #cccccc; + background-color: #ffffff; +} + +#product big { + font-size: 2em; +} + +#main { + background-color: #f0f0f0; + border-left: 2px solid #cccccc; +} + +#navigation { + float: left; + width: 14em; + vertical-align: top; + background-color: #f0f0f0; + overflow: visible; +} + +#navigation h2 { + background-color:#e7e7e7; + font-size:1.1em; + color:#000000; + text-align: left; + padding:0.2em; + border-top:1px solid #dddddd; + border-bottom:1px solid #dddddd; +} + +#navigation ul +{ + font-size:1em; + list-style-type: none; + margin: 1px 1px 10px 1px; +} + +#navigation li { + text-indent: -1em; + display: block; + margin: 3px 0px 0px 22px; +} + +#navigation li li a { + margin: 0px 3px 0px -1em; +} + +#content { + margin-left: 14em; + padding: 1em; + width: 700px; + border-left: 2px solid #cccccc; + border-right: 2px solid #cccccc; + background-color: #ffffff; +} + +#about { + clear: both; + padding: 5px; + border-top: 2px solid #cccccc; + background-color: #ffffff; +} + +@media print { + body { + font: 12pt "Times New Roman", "TimeNR", Times, serif; + } + a { font-weight: bold; color: #004080; text-decoration: underline; } + + #main { + background-color: #ffffff; + border-left: 0px; + } + + #container { + margin-left: 2%; + margin-right: 2%; + background-color: #ffffff; + } + + #content { + padding: 1em; + background-color: #ffffff; + } + + #navigation { + display: none; + } + pre.example { + font-family: "Andale Mono", monospace; + font-size: 10pt; + page-break-inside: avoid; + } +} + +table.module_list { + border-width: 1px; + border-style: solid; + border-color: #cccccc; + border-collapse: collapse; +} +table.module_list td { + border-width: 1px; + padding: 3px; + border-style: solid; + border-color: #cccccc; +} +table.module_list td.name { background-color: #f0f0f0; min-width: 200px; } +table.module_list td.summary { width: 100%; } + + +table.function_list { + border-width: 1px; + border-style: solid; + border-color: #cccccc; + border-collapse: collapse; +} +table.function_list td { + border-width: 1px; + padding: 3px; + border-style: solid; + border-color: #cccccc; +} +table.function_list td.name { background-color: #f0f0f0; min-width: 200px; } +table.function_list td.summary { width: 100%; } + +ul.nowrap { + overflow:auto; + white-space:nowrap; +} + +dl.table dt, dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;} +dl.table dd, dl.function dd {padding-bottom: 1em; margin: 10px 0 0 20px;} +dl.table h3, dl.function h3 {font-size: .95em;} + +/* stop sublists from having initial vertical space */ +ul ul { margin-top: 0px; } +ol ul { margin-top: 0px; } +ol ol { margin-top: 0px; } +ul ol { margin-top: 0px; } + +/* make the target distinct; helps when we're navigating to a function */ +a:target + * { + background-color: #FF9; +} + + +/* styles for prettification of source */ +pre .comment { color: #558817; } +pre .constant { color: #a8660d; } +pre .escape { color: #844631; } +pre .keyword { color: #aa5050; font-weight: bold; } +pre .library { color: #0e7c6b; } +pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; } +pre .string { color: #8080ff; } +pre .number { color: #f8660d; } +pre .operator { color: #2239a8; font-weight: bold; } +pre .preprocessor, pre .prepro { color: #a33243; } +pre .global { color: #800080; } +pre .user-keyword { color: #800080; } +pre .prompt { color: #558817; } +pre .url { color: #272fc2; text-decoration: underline; } + diff --git a/lib/std/_debug/version.lua b/lib/std/_debug/version.lua new file mode 100644 index 0000000..5fc4c84 --- /dev/null +++ b/lib/std/_debug/version.lua @@ -0,0 +1 @@ +return "Debug hints library / 1.0.1" diff --git a/std._debug-git-1.rockspec b/std._debug-1.0.1-1.rockspec similarity index 95% rename from std._debug-git-1.rockspec rename to std._debug-1.0.1-1.rockspec index 1bb7bd7..3a6ca84 100644 --- a/std._debug-git-1.rockspec +++ b/std._debug-1.0.1-1.rockspec @@ -1,4 +1,4 @@ -local _MODREV, _SPECREV = 'git', '-1' +local _MODREV, _SPECREV = '1.0.1', '-1' package = 'std._debug' version = _MODREV .. _SPECREV