The unified diff between revisions [cd10ac1d..] and [a53d96b5..] is displayed below. It can also be downloaded as a raw diff.

#
#
# add_file "doc/GNUmakefile"
#  content [757ea53bb2cf738f41d445256ae3bd422fc5595c]
#
# add_file "doc/log4Ada.tex"
#  content [5bbc8a44599174e6286ea736bd1fd30fb93fe930]
#
============================================================
--- doc/GNUmakefile	757ea53bb2cf738f41d445256ae3bd422fc5595c
+++ doc/GNUmakefile	757ea53bb2cf738f41d445256ae3bd422fc5595c
@@ -0,0 +1,12 @@
+.SUFFIXES: .aux .pdf .tex
+
+.tex.aux:
+	pdflatex -draftmode $<
+
+.aux.pdf:
+	pdflatex $*.tex
+
+doc:log4Ada.pdf
+
+clean:
+	rm -f *~ *.aux *.pdf *.dvi *.log *.toc *.lof *.out *.bak
============================================================
--- doc/log4Ada.tex	5bbc8a44599174e6286ea736bd1fd30fb93fe930
+++ doc/log4Ada.tex	5bbc8a44599174e6286ea736bd1fd30fb93fe930
@@ -0,0 +1,54 @@
+\documentclass[a4paper]{article}
+\usepackage{graphicx}
+\usepackage[colorlinks]{hyperref}
+\title{Log4Ada documentation}
+\author{X. Grave}
+\begin{document}
+\maketitle
+\tableofcontents
+\section*{Introduction}
+Log4Ada is a library written in the intend to ease logging in applications
+written in Ada. For more information about the logging scheme developed in
+this library see the log4j project~:
+\href{http://logging.apache.org/log4j/docs/}{Log4J}
+
+This documentation is in a very preliminary state.
+\section{Logging Levels}
+There is five level of logging~:
+\begin{itemize}
+\item Debug
+\item Info
+\item Warn
+\item Error
+\item Fatal
+\end{itemize}
+Associated to each level there is a procedure in the Log4ada.Loggers package~:
+\begin{itemize}
+\item Debug\_Out
+\item Info\_out
+\item Warn\_Out
+\item Error\_Out
+\item Fatal\_Out
+\end{itemize}
+All these procedures exists in two flavour, the first one with two parameters~:
+\begin{itemize}
+\item Logger which is a not null access Logger\_Type
+\item Message which is a String containing the information you want to log
+\end{itemize}
+The second one add a third parameter which is an Exception\_Occurrence. Log4Ada
+adds automatically the information extracted from the exception to the message.
+\section{Appenders}
+In order to have log out of the system, one needs to associate one or more
+appender to a Logger. This is done using the Add\_Appender procedure from the
+Log4ada.Loggers package. Log4Ada already provides a few appenders~:
+\begin{itemize}
+\item a console based one (Log4ada.Appenders.Consoles)
+\item logging to a file (Log4ada.Appenders.Files)
+\item logging to a log4j compatible tcp stream (Log4ada.Appenders.Tcp\_Stream)
+\subitem one can connect to
+\href{http://logging.apache.org/chainsaw/index.html}{chainsaw} for example.
+\item xml output (Log4ada.Appenders.Xml)
+\item Annex E logging facility to concentrate all logs from a distributed
+application (Log4ada.Appenders.Annex\_E)
+\end{itemize}
+\end{document}