Module Logs.Src
Contents
Instructions: Use this module in your project
In the IDE (CLion, Visual Studio Code, Xcode, etc.) you use for your DkSDK project:
Add the following to your project's
dependencies/CMakeLists.txt:DkSDKProject_DeclareAvailable(logs CONSTRAINT "= 0.7.0+dune2" FINDLIBS logs logs.cli logs.fmt logs.lwt logs.threaded logs.top) DkSDKProject_MakeAvailable(logs)Add the
Findlib::logslibrary to any desired targets insrc/*/CMakeLists.txt:target_link_libraries(YourPackage_YourLibraryName # ... existing libraries, if any ... Findlib::logs)Click your IDE's
Buildbutton
Not using DkSDK?
FIRST, do one or all of the following:
Run:
opam install logs.0.7.0+dune2Edit your
dune-projectand add:(package (name YourExistingPackage) (depends ; ... existing dependenices ... (logs (>= 0.7.0+dune2))))Then run:
dune build *.opam # if this fails, run: dune buildEdit your
<package>.opamfile and add:depends: [ # ... existing dependencies ... "logs" {>= "0.7.0+dune2"} ]Then run:
opam install . --deps-only
FINALLY, add the logs library to any desired (library)and/or (executable) targets in your **/dune files:
(library
(name YourLibrary)
; ... existing library options ...
(libraries
; ... existing libraries ...
logs))
(executable
(name YourExecutable)
; ... existing executable options ...
(libraries
; ... existing libraries ...
logs))Sources
typet`` =src
The type for log sources.
valcreate : ``?doc:string->``string->src
create ?doc name is a new log source. name is the name of the
source; it doesn't need to be unique but it is good practice to prefix
the name with the name of your package or library (e.g.
"mypkg.network"). doc is a documentation string describing the
source, defaults to "undocumented". The initial reporting level of the
source is defined by Logs.level.
valname :src->string
name is src's name.
valdoc :src->string
doc src is src's documentation string.
set_level src l sets the report level of src to l. Only
applications should use this function directly, see usage
conventions.
valpp :Stdlib.Format.formatter->src->unit
pp ppf src prints an unspecified representation of src on ppf.
vallist : ``unit->srclist
list () is the current exisiting source list.
