Jenkins/_build/latex/JenkinsDoc.tex
changeset 4 633ec114762a
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Jenkins/_build/latex/JenkinsDoc.tex	Fri Jan 12 14:16:17 2018 +0100
@@ -0,0 +1,269 @@
+% Generated by Sphinx.
+\def\sphinxdocclass{report}
+\newif\ifsphinxKeepOldNames \sphinxKeepOldNamestrue
+\documentclass[letterpaper,10pt,english]{sphinxmanual}
+\usepackage{iftex}
+
+\ifPDFTeX
+  \usepackage[utf8]{inputenc}
+\fi
+\ifdefined\DeclareUnicodeCharacter
+  \DeclareUnicodeCharacter{00A0}{\nobreakspace}
+\fi
+\usepackage{cmap}
+\usepackage[T1]{fontenc}
+\usepackage{amsmath,amssymb,amstext}
+\usepackage{babel}
+\usepackage{times}
+\usepackage[Bjarne]{fncychap}
+\usepackage{longtable}
+\usepackage{sphinx}
+\usepackage{multirow}
+\usepackage{eqparbox}
+
+
+\addto\captionsenglish{\renewcommand{\figurename}{Fig.\@ }}
+\addto\captionsenglish{\renewcommand{\tablename}{Table }}
+\SetupFloatingEnvironment{literal-block}{name=Listing }
+
+\addto\extrasenglish{\def\pageautorefname{page}}
+
+\setcounter{tocdepth}{1}
+
+
+\title{JenkinsDoc Documentation}
+\date{Jan 12, 2018}
+\release{1.0}
+\author{Jonathan Grimm}
+\newcommand{\sphinxlogo}{}
+\renewcommand{\releasename}{Release}
+\makeindex
+
+\makeatletter
+\def\PYG@reset{\let\PYG@it=\relax \let\PYG@bf=\relax%
+    \let\PYG@ul=\relax \let\PYG@tc=\relax%
+    \let\PYG@bc=\relax \let\PYG@ff=\relax}
+\def\PYG@tok#1{\csname PYG@tok@#1\endcsname}
+\def\PYG@toks#1+{\ifx\relax#1\empty\else%
+    \PYG@tok{#1}\expandafter\PYG@toks\fi}
+\def\PYG@do#1{\PYG@bc{\PYG@tc{\PYG@ul{%
+    \PYG@it{\PYG@bf{\PYG@ff{#1}}}}}}}
+\def\PYG#1#2{\PYG@reset\PYG@toks#1+\relax+\PYG@do{#2}}
+
+\expandafter\def\csname PYG@tok@gd\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.63,0.00,0.00}{##1}}}
+\expandafter\def\csname PYG@tok@gu\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.50,0.00,0.50}{##1}}}
+\expandafter\def\csname PYG@tok@gt\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.27,0.87}{##1}}}
+\expandafter\def\csname PYG@tok@gs\endcsname{\let\PYG@bf=\textbf}
+\expandafter\def\csname PYG@tok@gr\endcsname{\def\PYG@tc##1{\textcolor[rgb]{1.00,0.00,0.00}{##1}}}
+\expandafter\def\csname PYG@tok@cm\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}}
+\expandafter\def\csname PYG@tok@vg\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
+\expandafter\def\csname PYG@tok@vi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
+\expandafter\def\csname PYG@tok@mh\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\expandafter\def\csname PYG@tok@cs\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
+\expandafter\def\csname PYG@tok@ge\endcsname{\let\PYG@it=\textit}
+\expandafter\def\csname PYG@tok@vc\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
+\expandafter\def\csname PYG@tok@il\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\expandafter\def\csname PYG@tok@go\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.20,0.20,0.20}{##1}}}
+\expandafter\def\csname PYG@tok@cp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@gi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.63,0.00}{##1}}}
+\expandafter\def\csname PYG@tok@gh\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.50}{##1}}}
+\expandafter\def\csname PYG@tok@ni\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.84,0.33,0.22}{##1}}}
+\expandafter\def\csname PYG@tok@nl\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.13,0.44}{##1}}}
+\expandafter\def\csname PYG@tok@nn\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.05,0.52,0.71}{##1}}}
+\expandafter\def\csname PYG@tok@no\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.38,0.68,0.84}{##1}}}
+\expandafter\def\csname PYG@tok@na\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@nb\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@nc\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.05,0.52,0.71}{##1}}}
+\expandafter\def\csname PYG@tok@nd\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.33,0.33,0.33}{##1}}}
+\expandafter\def\csname PYG@tok@ne\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@nf\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.02,0.16,0.49}{##1}}}
+\expandafter\def\csname PYG@tok@si\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.44,0.63,0.82}{##1}}}
+\expandafter\def\csname PYG@tok@s2\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@nt\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.02,0.16,0.45}{##1}}}
+\expandafter\def\csname PYG@tok@nv\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
+\expandafter\def\csname PYG@tok@s1\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@ch\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}}
+\expandafter\def\csname PYG@tok@m\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\expandafter\def\csname PYG@tok@gp\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.78,0.36,0.04}{##1}}}
+\expandafter\def\csname PYG@tok@sh\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@ow\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@sx\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.78,0.36,0.04}{##1}}}
+\expandafter\def\csname PYG@tok@bp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@c1\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}}
+\expandafter\def\csname PYG@tok@o\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.40,0.40,0.40}{##1}}}
+\expandafter\def\csname PYG@tok@kc\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@c\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}}
+\expandafter\def\csname PYG@tok@mf\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\expandafter\def\csname PYG@tok@err\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\fcolorbox[rgb]{1.00,0.00,0.00}{1,1,1}{\strut ##1}}}
+\expandafter\def\csname PYG@tok@mb\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\expandafter\def\csname PYG@tok@ss\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.32,0.47,0.09}{##1}}}
+\expandafter\def\csname PYG@tok@sr\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.14,0.33,0.53}{##1}}}
+\expandafter\def\csname PYG@tok@mo\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\expandafter\def\csname PYG@tok@kd\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@mi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
+\expandafter\def\csname PYG@tok@kn\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@cpf\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}}
+\expandafter\def\csname PYG@tok@kr\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@s\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@kp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@w\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.73,0.73}{##1}}}
+\expandafter\def\csname PYG@tok@kt\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.56,0.13,0.00}{##1}}}
+\expandafter\def\csname PYG@tok@sc\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@sb\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@k\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@se\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+\expandafter\def\csname PYG@tok@sd\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
+
+\def\PYGZbs{\char`\\}
+\def\PYGZus{\char`\_}
+\def\PYGZob{\char`\{}
+\def\PYGZcb{\char`\}}
+\def\PYGZca{\char`\^}
+\def\PYGZam{\char`\&}
+\def\PYGZlt{\char`\<}
+\def\PYGZgt{\char`\>}
+\def\PYGZsh{\char`\#}
+\def\PYGZpc{\char`\%}
+\def\PYGZdl{\char`\$}
+\def\PYGZhy{\char`\-}
+\def\PYGZsq{\char`\'}
+\def\PYGZdq{\char`\"}
+\def\PYGZti{\char`\~}
+% for compatibility with earlier versions
+\def\PYGZat{@}
+\def\PYGZlb{[}
+\def\PYGZrb{]}
+\makeatother
+
+\renewcommand\PYGZsq{\textquotesingle}
+
+\begin{document}
+
+\maketitle
+\tableofcontents
+\phantomsection\label{index::doc}
+
+
+
+\chapter{Installation and running of Jenkins}
+\label{Installation::doc}\label{Installation:installation-and-running-of-jenkins}\label{Installation:welcome-to-jenkinsdoc-s-documentation}
+
+\section{Jenkins Debian package}
+\label{Installation:jenkins-debian-package}
+First add the key to your system:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{n}{wget} \PYG{o}{\PYGZhy{}}\PYG{n}{q} \PYG{o}{\PYGZhy{}}\PYG{n}{O} \PYG{o}{\PYGZhy{}} \PYG{n}{https}\PYG{p}{:}\PYG{o}{/}\PYG{o}{/}\PYG{n}{pkg}\PYG{o}{.}\PYG{n}{jenkins}\PYG{o}{.}\PYG{n}{io}\PYG{o}{/}\PYG{n}{debian}\PYG{o}{\PYGZhy{}}\PYG{n}{stable}\PYG{o}{/}\PYG{n}{jenkins}\PYG{o}{.}\PYG{n}{io}\PYG{o}{.}\PYG{n}{key} \PYG{o}{\textbar{}} \PYG{n}{sudo} \PYG{n}{apt}\PYG{o}{\PYGZhy{}}\PYG{n}{key} \PYG{n}{add} \PYG{o}{\PYGZhy{}}
+\end{Verbatim}
+
+Then add the following entry in your /etc/apt/sources.list:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{n}{deb} \PYG{n}{https}\PYG{p}{:}\PYG{o}{/}\PYG{o}{/}\PYG{n}{pkg}\PYG{o}{.}\PYG{n}{jenkins}\PYG{o}{.}\PYG{n}{io}\PYG{o}{/}\PYG{n}{debian}\PYG{o}{\PYGZhy{}}\PYG{n}{stable} \PYG{n}{binary}\PYG{o}{/}
+\end{Verbatim}
+
+Update your local package index, then finally install Jenkins:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{n}{sudo} \PYG{n}{apt}\PYG{o}{\PYGZhy{}}\PYG{n}{get} \PYG{n}{update}
+\PYG{n}{sudo} \PYG{n}{apt}\PYG{o}{\PYGZhy{}}\PYG{n}{get} \PYG{n}{install} \PYG{n}{jenkins}
+\end{Verbatim}
+
+Now you can run Jenkins with:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{n}{sudo} \PYG{n}{service} \PYG{n}{jenkins} \PYG{p}{\PYGZob{}}\PYG{n}{start}\PYG{o}{\textbar{}}\PYG{n}{stop}\PYG{o}{\textbar{}}\PYG{n}{restart}\PYG{p}{\PYGZcb{}}
+\end{Verbatim}
+
+You can access the Jenkins webinterface:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{n}{localhost}\PYG{p}{:}\PYG{l+m+mi}{8080}
+\end{Verbatim}
+
+Follow the instructions to create your admin account.
+
+
+\section{Jenkins generic Java Package (.war)}
+\label{Installation:jenkins-generic-java-package-war}
+Donwload:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{n}{http}\PYG{p}{:}\PYG{o}{/}\PYG{o}{/}\PYG{n}{mirrors}\PYG{o}{.}\PYG{n}{jenkins}\PYG{o}{.}\PYG{n}{io}\PYG{o}{/}\PYG{n}{war}\PYG{o}{\PYGZhy{}}\PYG{n}{stable}\PYG{o}{/}\PYG{n}{latest}\PYG{o}{/}\PYG{n}{jenkins}\PYG{o}{.}\PYG{n}{war}
+\end{Verbatim}
+
+Run:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{n}{java} \PYG{o}{\PYGZhy{}}\PYG{n}{jar} \PYG{n}{jenkins}\PYG{o}{.}\PYG{n}{war} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{httpPort}\PYG{o}{=}\PYG{l+m+mi}{8080}
+\end{Verbatim}
+
+You can access the Jenkins webinterface:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{n}{localhost}\PYG{p}{:}\PYG{l+m+mi}{8080}
+\end{Verbatim}
+
+Follow the instructions to create your admin account.
+
+
+\chapter{Create a job for epics-base-7.0}
+\label{epics7:create-a-job-for-epics-base-7-0}\label{epics7::doc}
+At first you have to install the TAP-plugin. Go to \emph{Manage Jenkins}-\textgreater{}*Manage Plugins* and install the \emph{TAP Plugin}
+
+To create a job, click \emph{New Item} and select \emph{Freestyle project}, Enter a name and click \emph{OK}.
+If you want the change the installation directory(default is ) of epics-base click on the \emph{Advanced..}-Button
+in the \emph{General}-tab check \emph{Use custom workspace} and enter a Directory path e.g. \sphinxcode{/opt/EPICS/\$\{JOB\_NAME\}}.
+If you choose to do this make shure the \emph{Jenkins} user has the appropriate permission in that directory.
+To do that enter the following into the terminal:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{n}{sudo} \PYG{n}{useradd} \PYG{o}{\PYGZhy{}}\PYG{n}{a} \PYG{o}{\PYGZhy{}}\PYG{n}{G} \PYG{n}{root} \PYG{n}{jenkins}
+\PYG{n}{sudo} \PYG{n}{chmod} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{recursive} \PYG{n}{a}\PYG{o}{+}\PYG{n}{rwx} \PYG{o}{/}\PYG{n}{opt}\PYG{o}{/}\PYG{n}{EPICS}\PYG{o}{/}\PYG{n}{epics}\PYG{o}{\PYGZhy{}}\PYG{n}{base}
+\end{Verbatim}
+
+You also have to set you epics environment variables accordingly.
+
+\begin{DUlineblock}{0em}
+\item[] Now setup the git configuration inside the \emph{Source Code Management}-tab
+\item[] Select \emph{Git} and enter the \emph{Repository URL} \sphinxcode{https://git.launchpad.net/epics-base}.
+\item[] Add the Branch Specifier \sphinxcode{core/master}
+\item[] Add with \emph{Additional Behaviours} \textbf{Advanced sub-modules behaviours} and select \emph{Recursively update submodules}
+\end{DUlineblock}
+
+In the \emph{Build Triggers}-tab select \emph{Build periodically} and enter the desired build schedule, e.g:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{n}{H} \PYG{l+m+mi}{1} \PYG{o}{*} \PYG{o}{*} \PYG{o}{*}
+\end{Verbatim}
+
+to update every Day roughly around 1am.
+
+Now add a \emph{build step} in the \emph{Build}-tab, select \emph{Execute shell} and enter:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{n}{make} \PYG{n}{clean} \PYG{n}{uninstall}
+\PYG{n}{make}
+\PYG{n}{make} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{n}{no}\PYG{o}{\PYGZhy{}}\PYG{n+nb}{print}\PYG{o}{\PYGZhy{}}\PYG{n}{directory} \PYG{o}{\PYGZhy{}}\PYG{n}{j4} \PYG{n}{tapfiles}
+\PYG{n}{make} \PYG{o}{\PYGZhy{}}\PYG{n}{s} \PYG{n}{test}\PYG{o}{\PYGZhy{}}\PYG{n}{results}
+\end{Verbatim}
+
+to build epics-base and make tests.
+
+Now add a \emph{post-build action} \textbf{Publish TAP Results} and enter:
+
+\begin{Verbatim}[commandchars=\\\{\}]
+\PYG{o}{*}\PYG{o}{*}\PYG{o}{/}\PYG{n}{O}\PYG{o}{.}\PYG{o}{*}\PYG{o}{/}\PYG{o}{*}\PYG{o}{.}\PYG{n}{tap}
+\end{Verbatim}
+
+You can uncheck \emph{Verbose} if wanted.
+
+\begin{DUlineblock}{0em}
+\item[] You can add another \emph{post-build action} to send a \emph{Editable Email Notification}
+\end{DUlineblock}
+
+
+
+\renewcommand{\indexname}{Index}
+\printindex
+\end{document}