From 9ee26e43abaeb2948adbf97fc120994d3379b1ec Mon Sep 17 00:00:00 2001 From: =?utf8?q?Jan=20Posp=C3=AD=C5=A1il?= Date: Fri, 25 Jul 2008 08:14:10 +0000 Subject: [PATCH] versions update --- org.glite.lb.doc/Makefile | 4 ++++ org.glite.lb.doc/src/LBAG-Abstract.tex | 3 +++ org.glite.lb.doc/src/LBAG-Introduction.tex | 2 -- org.glite.lb.doc/src/LBAG.tex | 9 ++++----- org.glite.lb.doc/src/LBDG-Abstract.tex | 4 ++++ org.glite.lb.doc/src/LBDG-Introduction.tex | 4 +--- org.glite.lb.doc/src/LBDG.tex | 8 ++++---- org.glite.lb.doc/src/LBTP-Abstract.tex | 4 ++++ org.glite.lb.doc/src/LBTP-Introduction.tex | 9 ++++----- org.glite.lb.doc/src/LBTP.tex | 9 ++++----- org.glite.lb.doc/src/LBUG-Abstract.tex | 4 ++++ org.glite.lb.doc/src/LBUG-Introduction.tex | 2 -- org.glite.lb.doc/src/LBUG.tex | 10 ++++------ org.glite.lb.doc/src/lbjp.bib | 5 ++++- org.glite.lb.doc/src/versions.tex | 19 ++++++++++++++----- 15 files changed, 58 insertions(+), 38 deletions(-) create mode 100644 org.glite.lb.doc/src/LBAG-Abstract.tex create mode 100644 org.glite.lb.doc/src/LBDG-Abstract.tex create mode 100644 org.glite.lb.doc/src/LBTP-Abstract.tex create mode 100644 org.glite.lb.doc/src/LBUG-Abstract.tex diff --git a/org.glite.lb.doc/Makefile b/org.glite.lb.doc/Makefile index 903997c..fbe3dad 100644 --- a/org.glite.lb.doc/Makefile +++ b/org.glite.lb.doc/Makefile @@ -81,6 +81,7 @@ COMMON:= copyright.tex \ LBUG.pdf: ${COMMON} \ LBUG.tex \ + LBUG-Abstract.tex \ LBUG-Introduction.tex components.tex \ LBUG-Tools.tex logevent.tex notify.tex \ LBUG-UseCases.tex log_usertag.tex change_acl.tex \ @@ -88,12 +89,14 @@ LBUG.pdf: ${COMMON} \ LBAG.pdf: ${COMMON} \ LBAG.tex \ + LBAG-Abstract.tex \ LBAG-Introduction.tex components.tex \ LBAG-Installation.tex \ LBAG-Running.tex LBDG.pdf: ${COMMON} \ LBDG.tex \ + LBDG-Abstract.tex \ LBDG-Introduction.tex \ producer_api.tex \ consumer_api.tex \ @@ -102,6 +105,7 @@ LBDG.pdf: ${COMMON} \ LBTP.pdf: ${COMMON} \ LBTP.tex \ + LBTP-Abstract.tex \ LBTP-Introduction.tex \ LBTP-Tests.tex \ LBTP-PerfTests.tex \ diff --git a/org.glite.lb.doc/src/LBAG-Abstract.tex b/org.glite.lb.doc/src/LBAG-Abstract.tex new file mode 100644 index 0000000..c47dd6c --- /dev/null +++ b/org.glite.lb.doc/src/LBAG-Abstract.tex @@ -0,0 +1,3 @@ +This administrator's guide explains how to administer the Logging and +Bookkeeping (\LB) service. Several deployment scenarios are described together +with the installation, configuration, running and troubleshooting steps. diff --git a/org.glite.lb.doc/src/LBAG-Introduction.tex b/org.glite.lb.doc/src/LBAG-Introduction.tex index f417b69..fddad7a 100644 --- a/org.glite.lb.doc/src/LBAG-Introduction.tex +++ b/org.glite.lb.doc/src/LBAG-Introduction.tex @@ -1,6 +1,4 @@ \section{Introduction} -% \TODO{This document should contain:} -\input versions \subsection{Service overview} diff --git a/org.glite.lb.doc/src/LBAG.tex b/org.glite.lb.doc/src/LBAG.tex index 6ff8ee5..efe1d20 100644 --- a/org.glite.lb.doc/src/LBAG.tex +++ b/org.glite.lb.doc/src/LBAG.tex @@ -12,11 +12,7 @@ \DocStatus{DRAFT} \Dissemination{PUBLIC} \DocumentLink{http://...} - -\Abstract{ This administrator's guide explains how to administer the Logging -and Bookkeeping (\LB) service. Several deployment scenarios are described -together with the installation, configuration, running and troubleshooting -steps. } +\Abstract{\input{LBAG-Abstract}} \begin{document} @@ -25,6 +21,9 @@ steps. } \tableofcontents \newpage +\input{versions} + +\newpage \input{LBAG-Introduction} \newpage diff --git a/org.glite.lb.doc/src/LBDG-Abstract.tex b/org.glite.lb.doc/src/LBDG-Abstract.tex new file mode 100644 index 0000000..e3ddc9d --- /dev/null +++ b/org.glite.lb.doc/src/LBDG-Abstract.tex @@ -0,0 +1,4 @@ +This developer's guide explains how to use the Logging and Bookkeeping (\LB) +service API. Logging (producer), querying (consumer) and notification API as +well as the Web Services Interface is described in details together with +programing examples. diff --git a/org.glite.lb.doc/src/LBDG-Introduction.tex b/org.glite.lb.doc/src/LBDG-Introduction.tex index fa8f64c..64f5362 100644 --- a/org.glite.lb.doc/src/LBDG-Introduction.tex +++ b/org.glite.lb.doc/src/LBDG-Introduction.tex @@ -2,8 +2,6 @@ \section{Introduction} -\input{versions} - This document is intented to guide the reader through basic steps of writing, compiling and running programs communicating with the \LB service using the \LB library. It is not intended as a complete API @@ -350,4 +348,4 @@ attributes: \subsubsection{Header Files} \subsubsection{Event} -\subsubsection{Building Programs} \ No newline at end of file +\subsubsection{Building Programs} diff --git a/org.glite.lb.doc/src/LBDG.tex b/org.glite.lb.doc/src/LBDG.tex index c0631ca..0942da6 100644 --- a/org.glite.lb.doc/src/LBDG.tex +++ b/org.glite.lb.doc/src/LBDG.tex @@ -14,10 +14,7 @@ \DocStatus{DRAFT} \Dissemination{PUBLIC} \DocumentLink{http://...} - -\Abstract{This developer's guide explains how to use the Logging and Bookkeeping -(\LB) service API. Logging (producer), querying (consumer) and notification API as well as the Web Services -Interface is described in details together with programing examples. } +\Abstract{\input{LBDG-Abstract}} \usepackage{listings} @@ -64,6 +61,9 @@ Interface is described in details together with programing examples. } \tableofcontents \newpage +\input{versions} + +\newpage \input{LBDG-Introduction} \newpage diff --git a/org.glite.lb.doc/src/LBTP-Abstract.tex b/org.glite.lb.doc/src/LBTP-Abstract.tex new file mode 100644 index 0000000..c49d6e6 --- /dev/null +++ b/org.glite.lb.doc/src/LBTP-Abstract.tex @@ -0,0 +1,4 @@ +This test plan document explains how to test the Logging and Bookkeeping (\LB) +service. Tests are described at six different layers, from elementary tests if +the service is up and running, through tests of the fully supported +functionality, performance and stress tests to interoperability tests. diff --git a/org.glite.lb.doc/src/LBTP-Introduction.tex b/org.glite.lb.doc/src/LBTP-Introduction.tex index 6fe61db..5e25b08 100644 --- a/org.glite.lb.doc/src/LBTP-Introduction.tex +++ b/org.glite.lb.doc/src/LBTP-Introduction.tex @@ -1,10 +1,9 @@ \section{Introduction} -\input{versions} - -This document explains how to test the \LB service. Tests are described at six different layers, from elementary tests -if the service is up and running, through tests of the fully supported functionality, -performance and stress tests to interoperability tests. +This document explains how to test the \LB service. Tests are described at six +different layers, from elementary tests if the service is up and running, +through tests of the fully supported functionality, performance and stress +tests to interoperability tests. \TODO{add some more introduction} diff --git a/org.glite.lb.doc/src/LBTP.tex b/org.glite.lb.doc/src/LBTP.tex index 896543b..bd37170 100644 --- a/org.glite.lb.doc/src/LBTP.tex +++ b/org.glite.lb.doc/src/LBTP.tex @@ -12,11 +12,7 @@ \DocStatus{DRAFT} \Dissemination{PUBLIC} \DocumentLink{http://...} - -\Abstract{This document explains how to test the Logging and Bookkeeping -(\LB) service. Tests are described at six different layers, from elementary tests -if the service is up and running, through tests of the fully supported functionality, -performance and stress tests to interoperability tests.} +\Abstract{\input{LBTP-Abstract}} \begin{document} @@ -24,6 +20,9 @@ performance and stress tests to interoperability tests.} \tableofcontents \newpage +\input{versions} + +\newpage \input{LBTP-Introduction} \newpage diff --git a/org.glite.lb.doc/src/LBUG-Abstract.tex b/org.glite.lb.doc/src/LBUG-Abstract.tex new file mode 100644 index 0000000..e3ad607 --- /dev/null +++ b/org.glite.lb.doc/src/LBUG-Abstract.tex @@ -0,0 +1,4 @@ +This user's guide explains how to use the Logging and Bookkeeping (\LB) service +from the user's point of view. The service architecture is described +thoroughly. Examples on using \LB\ event logging command to log a~user tag and +change job ACL are given, as well as \LB\ query and notification use cases. diff --git a/org.glite.lb.doc/src/LBUG-Introduction.tex b/org.glite.lb.doc/src/LBUG-Introduction.tex index 815cbeb..b51c1ee 100644 --- a/org.glite.lb.doc/src/LBUG-Introduction.tex +++ b/org.glite.lb.doc/src/LBUG-Introduction.tex @@ -1,7 +1,5 @@ \section{\LB Architecture} -\input versions - %historie: vyrobeno pro WMS v EDG, 1. a 2. verze (seq. èísla, %cache a dotazy na stavy), v EGEE gLite---ustabilnìní, proxy diff --git a/org.glite.lb.doc/src/LBUG.tex b/org.glite.lb.doc/src/LBUG.tex index 6e06fa2..3a68516 100644 --- a/org.glite.lb.doc/src/LBUG.tex +++ b/org.glite.lb.doc/src/LBUG.tex @@ -12,12 +12,7 @@ \DocStatus{DRAFT} \Dissemination{PUBLIC} \DocumentLink{http://...} - -\Abstract{This user's guide explains how to use the Logging and Bookkeeping -(\LB) service from the user's point of view. The service architecture is -described thoroughly. Examples on using \LB\ event logging command to log -a~user tag and change job ACL are given, as well as \LB\ query and notification -use cases. } +\Abstract{\input{LBUG-Abstract}} \begin{document} @@ -25,6 +20,9 @@ use cases. } \tableofcontents \newpage +\input{versions} + +\newpage \input{LBUG-Introduction} \newpage diff --git a/org.glite.lb.doc/src/lbjp.bib b/org.glite.lb.doc/src/lbjp.bib index 0321dcc..6100c59 100644 --- a/org.glite.lb.doc/src/lbjp.bib +++ b/org.glite.lb.doc/src/lbjp.bib @@ -693,22 +693,25 @@ @Misc{ lbug, author = "A. K\v{r}enek and others", title = "{L\&B User's Guide}", - howpublished = "\url{https://edms.cern.ch/file/571273/2/LB-guide.pdf}" + howpublished = "\url{http://egee.cesnet.cz/LB/LBUG.pdf}", } @Misc{ lbdg, author = "A. K\v{r}enek and others", title = "{L\&B Developer's Guide}", + howpublished = "\url{http://egee.cesnet.cz/LB/LBDG.pdf}", } @Misc{ lbag, author = "A. K\v{r}enek and others", title = "{L\&B Administrator's Guide}", + howpublished = "\url{http://egee.cesnet.cz/LB/LBAG.pdf}", } @Misc{ lbtp, author = "A. K\v{r}enek and others", title = "{L\&B Test Plan}", + howpublished = "\url{http://egee.cesnet.cz/LB/LBTP.pdf}", } @Misc{ wmsug, diff --git a/org.glite.lb.doc/src/versions.tex b/org.glite.lb.doc/src/versions.tex index 2b5cfb0..179e048 100644 --- a/org.glite.lb.doc/src/versions.tex +++ b/org.glite.lb.doc/src/versions.tex @@ -1,4 +1,5 @@ -%\subsection{Versions overview} +\section*{\LB Documentation and versions overview} +\addcontentsline{toc}{section}{\uppercase{\LB Documentation and versions overview}} The Logging and Bookkeeping service (\LB\ for short) was initially developed in the EU DataGrid @@ -14,9 +15,17 @@ that appeared in gLite 3.0 become obsolete and is not maintained anymore.} The complete \LB Documentation consists of the following parts: \begin{itemize} -\item \LB User's Guide \ifx\insideUG\undefined{\cite{lbug}}\else{- this document}\fi, -\item \LB Administrator's Guide \ifx\insideAG\undefined{\cite{lbag}}\else{- this document}\fi, -\item \LB Developer's Guide \ifx\insideDG\undefined{\cite{lbdg}}\else{- this document}\fi, -\item \LB Test Plan \ifx\insideTP\undefined{\cite{lbtp}}\else{- this document}\fi. +\item \textbf{\LB User's Guide} + \ifx\insideUG\undefined{\cite{lbug}}\else{- this document}\fi. + \input{LBUG-Abstract} +\item \textbf{\LB Administrator's Guide} + \ifx\insideAG\undefined{\cite{lbag}}\else{- this document}\fi. + \input{LBAG-Abstract} +\item \textbf{\LB Developer's Guide} + \ifx\insideDG\undefined{\cite{lbdg}}\else{- this document}\fi. + \input{LBDG-Abstract} +\item \textbf{\LB Test Plan} + \ifx\insideTP\undefined{\cite{lbtp}}\else{- this document}\fi. + \input{LBTP-Abstract} \end{itemize} -- 1.8.2.3