From 60398057c1f020063142b6af9181376343a5ec32 Mon Sep 17 00:00:00 2001 From: =?utf8?q?R=C4=83zvan=20Crainea?= Date: Sat, 2 Jun 2012 11:49:07 +0300 Subject: [PATCH] doc: added initial doc files --- doc/.gitignore | 5 +++ doc/Makefile | 23 +++++++++++++ doc/paper.bib | 5 +++ doc/paper.tex | 90 ++++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 123 insertions(+) create mode 100644 doc/.gitignore create mode 100755 doc/Makefile create mode 100644 doc/paper.bib create mode 100644 doc/paper.tex diff --git a/doc/.gitignore b/doc/.gitignore new file mode 100644 index 0000000..76e6f67 --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1,5 @@ +P2PKP-Paper.pdf +*.aux +*.bbl +*.blg +*.log diff --git a/doc/Makefile b/doc/Makefile new file mode 100755 index 0000000..5b4c045 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,23 @@ +# builds a Latex paper +BASENAME = paper +OUTPUT = "P2PKP-Paper.pdf" +PDF = $(addsuffix .pdf, $(BASENAME)) +TEX = $(addsuffix .tex, $(BASENAME)) +R = $(addsuffix .r, $(BASENAME)) +PDFLATEX = pdflatex +BIBTEX = bibtex + + +build: pdf + +pdf: $(TEX) + $(PDFLATEX) $(TEX) + $(BIBTEX) $(BASENAME) + $(PDFLATEX) $(TEX) + $(PDFLATEX) $(TEX) + mv $(PDF) $(OUTPUT) + +.PHONY: clean +clean: + @rm -rf $(BASENAME).aux $(BASENAME).bbl \ + $(BASENAME).blg $(BASENAME).log diff --git a/doc/paper.bib b/doc/paper.bib new file mode 100644 index 0000000..63e6f47 --- /dev/null +++ b/doc/paper.bib @@ -0,0 +1,5 @@ +@misc{tux, + title = {Tux Httpd Server}, + note = "http://www.redhat.com/products/software/ecommerce/tux" +} + diff --git a/doc/paper.tex b/doc/paper.tex new file mode 100644 index 0000000..b55acc2 --- /dev/null +++ b/doc/paper.tex @@ -0,0 +1,90 @@ +\documentclass{article}[12pt] +\usepackage{listings} +\usepackage[utf8]{inputenc} + + +% paper info +\title{Peer-to-Peer Kernel Protocol (P2PKP)} +\author{Răzvan Crainea \\ +razvan.crainea@cti.pub.ro \\ +University `Politehnica' \\ +Bucharest +\and +Tudor Cazangiu \\ +tudor.cazangiu@cti.pub.ro \\ +University `Politehnica' \\ +Bucharest +} + +% date specification (use \date{} to disable or \date{\today} otherwise) +\date{} + +% remove page number +%\pagestyle{empty} + + +% begins the document +\begin{document} + +% title +\maketitle + +% abstract +\begin{abstract} +This is the abstract of the paper. +\end{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. + + +\section{Results} +\label{sec:results} +The results of the tests performed. + + +\section{Conclusions} +\label{sec:conclusions} +Our conclusions based on the results gathered at Section \ref{sec:results}. + +\section{Further Work} +\label{sec:future} +Probably merge this with Section \ref{sec:conclusions}. + + +\section*{Acknowledgements} +Here will be the acknowledgments. + +% bibliography +\bibliographystyle{plain} +\bibliography{paper} + + +\end{document} -- 2.20.1