This command will search all the contents of the directory subdirectory/
and display every line in any of the files that contains
-functionName. The @code{-i} option makes @command{grep} ignore
+functionName. The @option{-i} option makes @command{grep} ignore
case -- this can be very useful if you are not yet familiar with
our capitalization conventions.
@item WARN: Only error messages and warnings
@item BASIC_PROGRESS: Warnings, errors and basic progress (success, etc.)
@item PROGRESS: Warnings, errors and full progress messages
-@item INFO: Warnings, errors, progress and more detailed information
+@item INFO: Warnings, errors, progress and more detailed information (default)
@item DEBUG: All messages, including vull debug messages (very verbose!)
@end itemize
The loglevel can either be set with the environment variable
-@code{LILYPOND_LOGLEVEL} or on the command line with the @code{--loglevel=...}
+@code{LILYPOND_LOGLEVEL} or on the command line with the @option{--loglevel=...}
option.
@unnumberedsubsec Functions for debug and log output
@end itemize
There are also Scheme functions to access all of these logging functions from
-scheme.
+scheme. In addition, the Grob class contains some convenience wrappers for
+even easier access to these functions.
The message and debug functions in @code{warn.hh} also have an optional
argument @code{newline}, which specifies whether the message should always
-start on a new line or continue a previous message.
+start on a new line or continue a previous message.
By default, @code{progress_indication} does NOT start on a new line, but rather
-continue the previous output. All other functions by default start their
-output on a new line.
+continue the previous output. They also do not have a particular input
+position associated, so there are no progress functions in the Input class.
+All other functions by default start their output on a new line.
-@unnumberedsubsec All logging functions at a glance
+The error functions come in three different flavors: fatal error messages,
+programming error messages and normal error messages. Errors written
+by the @code{error ()} function will cause LilyPond to exit immediately,
+errors by @code{Input::error ()} will continue the compilation, but
+return a non-zero return value of the lilypond call (i.e. indicate an
+unsuccessful program execution). All other errors will be printed on the
+console, but not exit LilyPond or indicate an unsuccessful return code.
+Their only differences to a warnings are the displayed text and that
+they will be shown with loglevel @code{ERROR}.
+
+If the Scheme option @code{warning-as-error} is set, any warning will be
+treated as if @code{Input::error} was called.
-Currently, there are no particular message functions for the INFO loglevel,
-so it is basically identical to PROGRESS.
+@unnumberedsubsec All logging functions at a glance
@multitable @columnfractions 0.16 0.42 0.42
@headitem
@tab @code{Input::error (msg)}, @code{Input::programming_error (msg)}
@item WARN
-@tab @code{warning (msg)} @c WARN
-@tab @code{Input::warning (msg)} @c WARN
+@tab @code{warning (msg)}
+@tab @code{Input::warning (msg)}
@item BASIC
-@tab @code{successful (msg)}
+@tab @code{basic_progress (msg)}
@tab -
@item PROGRESS
-@tab @code{progress_indication (msg)}, @code{message (msg)}
+@tab @code{progress_indication (msg)}
+@tab -
+
+@item INFO
+@tab @code{message (msg)}
@tab @code{Input::message (msg)}
@item DEBUG
@item @tab @tab
@headitem
-@tab Scheme, no location
-@tab Scheme, input location
+@tab C++ from a Grob
+@tab Scheme, music expression
@item ERROR
+@tab @code{Grob::programming_error (msg)}
@tab -
-@tab @code{(ly:error msg args)}, @code{(ly:programming-error msg args)}
@item WARN
-@tab @code{(ly:warning msg args)}
-@tab @code{(ly:input-warning input msg args)}
+@tab @code{Grob::warning (msg)}
+@tab @code{(ly:music-warning music msg)}
@item BASIC
-@tab @code{(ly:success msg args)}
+@tab -
@tab -
@item PROGRESS
-@tab (ly:progress msg args), (ly:message msg args)
-@tab @code{(ly:input-message input msg args)}
+@tab -
+@tab -
-@item DEBUG
-@tab @code{(ly:debug msg args)}
+@item INFO
@tab -
+@tab @code{(ly:music-message music msg)}
+@item DEBUG
+@tab -
+@tab -
@item @tab @tab
@headitem
-@tab Scheme, music expression
-@tab
+@tab Scheme, no location
+@tab Scheme, input location
@item ERROR
@tab -
+@tab @code{(ly:error msg args)}, @code{(ly:programming-error msg args)}
@item WARN
-@tab @code{(ly:music-warning music msg)}
+@tab @code{(ly:warning msg args)}
+@tab @code{(ly:input-warning input msg args)}
@item BASIC
+@tab @code{(ly:basic-progress msg args)}
@tab -
@item PROGRESS
-@tab @code{(ly:music-message music msg)}
+@tab @code{(ly:progress msg args)}
+@tab -
+
+@item INFO
+@tab @code{(ly:message msg args)}
+@tab @code{(ly:input-message input msg args)}
@item DEBUG
+@tab @code{(ly:debug msg args)}
@tab -
@end multitable
In order for the Graphviz tool to work, config.make must be modified.
It is probably a good idea to first save a copy of config.make under
a different name. Then, edit config.make by removing every occurrence
-of @code{-DNDEBUG}.
+of @option{-DNDEBUG}.
@item Rebuilding LilyPond
The pdf file can then be viewed with any pdf viewer.
-When compiled without @code{-DNDEBUG}, lilypond may run slower
+When compiled without @option{-DNDEBUG}, lilypond may run slower
than normal. The original configuration can be restored by either
renaming the saved copy of @code{config.make} or rerunning
@code{configure}. Then rebuild lilypond with
projects / lilypond.git / blobdiff