From a8b0cb2d31f3e36b3c845c1e5c6f86161b3925df Mon Sep 17 00:00:00 2001 From: =?utf8?q?R=C4=83zvan=20Crainea?= Date: Mon, 4 Jun 2012 14:49:06 +0300 Subject: [PATCH] doc: split sections in different files --- doc/Makefile | 4 +-- doc/paper.tex | 56 ++++++++++---------------------------- doc/src/abstract.tex | 3 ++ doc/src/conclusions.tex | 3 ++ doc/src/design.tex | 12 ++++++++ doc/src/implementation.tex | 6 ++++ doc/src/introduction.tex | 4 +++ doc/src/related.tex | 7 +++++ doc/src/results.tex | 5 ++++ doc/src/testing.tex | 4 +++ 10 files changed, 60 insertions(+), 44 deletions(-) create mode 100644 doc/src/abstract.tex create mode 100644 doc/src/conclusions.tex create mode 100644 doc/src/design.tex create mode 100644 doc/src/implementation.tex create mode 100644 doc/src/introduction.tex create mode 100644 doc/src/related.tex create mode 100644 doc/src/results.tex create mode 100644 doc/src/testing.tex diff --git a/doc/Makefile b/doc/Makefile index 5b4c045..f9842e9 100755 --- a/doc/Makefile +++ b/doc/Makefile @@ -19,5 +19,5 @@ pdf: $(TEX) .PHONY: clean clean: - @rm -rf $(BASENAME).aux $(BASENAME).bbl \ - $(BASENAME).blg $(BASENAME).log + @-rm -rf $(BASENAME).aux $(BASENAME).bbl \ + $(BASENAME).blg $(BASENAME).log src/*.aux diff --git a/doc/paper.tex b/doc/paper.tex index b55acc2..0cdfbb7 100644 --- a/doc/paper.tex +++ b/doc/paper.tex @@ -4,7 +4,7 @@ % paper info -\title{Peer-to-Peer Kernel Protocol (P2PKP)} +\title{SWIFT Peer-to-Peer Kernel Protocol (P2PKP) implementation} \author{Răzvan Crainea \\ razvan.crainea@cti.pub.ro \\ University `Politehnica' \\ @@ -29,58 +29,30 @@ Bucharest % title \maketitle -% abstract -\begin{abstract} -This is the abstract of the paper. -\end{abstract} +%\let\clearpage\relax +% abstract +\input{src/abstract} % rest of the content -\section{Introduction} -\label{sec:intro} -Paper introduction. - -\section{Related Work} -\label{sec:related} -Perhaps here we can talk a bit about the Swift protocol, or other -implementations of application layer protocols that are implemented in kernel -\cite{tux}. - -\section{Design} -\label{sec:design} - -%\subsection{User Space} -%\label{subsec:userspace} -How this implementation is seen in the userspace. - -%\subsection{Kernel Space} -%\label{subsec:kernelspace} -\section{Implementation} -\label{sec:implementation} -How this protocol is implemented in kernel space - perhaps split it in -multiple subsections - sending/receiving. - -\section{Testing Scenarios} -\label{subsec:testing} -List the three scenarios we are going to test. +\input{src/introduction} +\input{src/related} -\section{Results} -\label{sec:results} -The results of the tests performed. +\input{src/design} +\input{src/implementation} -\section{Conclusions} -\label{sec:conclusions} -Our conclusions based on the results gathered at Section \ref{sec:results}. +\input{src/testing} -\section{Further Work} -\label{sec:future} -Probably merge this with Section \ref{sec:conclusions}. +\input{src/results} +\input{src/conclusions} \section*{Acknowledgements} -Here will be the acknowledgments. +We would like to thank our supervisor, Răzvan Deaconescu, whose help, +valuable suggestions, knowledge, experience and encouragement helped us during +the times of study for this research project. % bibliography \bibliographystyle{plain} diff --git a/doc/src/abstract.tex b/doc/src/abstract.tex new file mode 100644 index 0000000..97f3d10 --- /dev/null +++ b/doc/src/abstract.tex @@ -0,0 +1,3 @@ +\begin{abstract} +This is the abstract of the paper. +\end{abstract} diff --git a/doc/src/conclusions.tex b/doc/src/conclusions.tex new file mode 100644 index 0000000..d53f2d4 --- /dev/null +++ b/doc/src/conclusions.tex @@ -0,0 +1,3 @@ +\section{Conclusions and Further Work} +\label{sec:conclusions} +Our conclusions based on the results gathered at Section \ref{sec:results}. diff --git a/doc/src/design.tex b/doc/src/design.tex new file mode 100644 index 0000000..186fa80 --- /dev/null +++ b/doc/src/design.tex @@ -0,0 +1,12 @@ +\section{Design} +\label{sec:design} + +How this implementation is seen in the userspace. + +\subsection{P2PKP Sender} +\label{subsec:sender} +How files are sent. + +\subsection{P2PKP Received} +\label{subsec:receiver} +How files are received. diff --git a/doc/src/implementation.tex b/doc/src/implementation.tex new file mode 100644 index 0000000..aebd31e --- /dev/null +++ b/doc/src/implementation.tex @@ -0,0 +1,6 @@ +\section{Implementation} +\label{sec:implementation} +How this protocol is implemented in kernel space - perhaps split it in +multiple subsections - sending/receiving. + + diff --git a/doc/src/introduction.tex b/doc/src/introduction.tex new file mode 100644 index 0000000..bac26ce --- /dev/null +++ b/doc/src/introduction.tex @@ -0,0 +1,4 @@ + +\section{Introduction} +\label{sec:intro} +Paper introduction. diff --git a/doc/src/related.tex b/doc/src/related.tex new file mode 100644 index 0000000..77d2879 --- /dev/null +++ b/doc/src/related.tex @@ -0,0 +1,7 @@ +\section{Related Work} +\label{sec:related} +Perhaps here we can talk a bit about the Swift protocol, or other +implementations of application layer protocols that are implemented in kernel +\cite{tux}. + + diff --git a/doc/src/results.tex b/doc/src/results.tex new file mode 100644 index 0000000..ec91d7c --- /dev/null +++ b/doc/src/results.tex @@ -0,0 +1,5 @@ +\section{Results} +\label{sec:results} +The results of the tests performed. + + diff --git a/doc/src/testing.tex b/doc/src/testing.tex new file mode 100644 index 0000000..8eb6e73 --- /dev/null +++ b/doc/src/testing.tex @@ -0,0 +1,4 @@ +\section{Testing Scenarios} +\label{subsec:testing} +List the three scenarios we are going to test. + -- 2.20.1