%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% Version Control Systems

%

% Author: FOSSEE 

% Copyright (c) 2009, FOSSEE, IIT Bombay

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\documentclass[14pt,compress]{beamer}

\mode<presentation>

{

  \usetheme{Warsaw}

  \useoutertheme{infolines}

  \setbeamercovered{transparent}

}

\usepackage[english]{babel}

\usepackage[latin1]{inputenc}

%\usepackage{times}

\usepackage[T1]{fontenc}

% Taken from Fernando's slides.

\usepackage{ae,aecompl}

\usepackage{mathpazo,courier,euler}

\usepackage[scaled=.95]{helvet}

\definecolor{darkgreen}{rgb}{0,0.5,0}

\usepackage{listings}

\lstset{language=Python,

    basicstyle=\ttfamily\bfseries,

    commentstyle=\color{red}\itshape,

  stringstyle=\color{darkgreen},

  showstringspaces=false,

  keywordstyle=\color{blue}\bfseries}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% Macros

\setbeamercolor{emphbar}{bg=blue!20, fg=black}

\newcommand{\emphbar}[1]

{\begin{beamercolorbox}[rounded=true]{emphbar} 

      {#1}

 \end{beamercolorbox}

}

\newcounter{time}

\setcounter{time}{0}

\newcommand{\inctime}[1]{\addtocounter{time}{#1}{\tiny \thetime\ m}}

\newcommand{\typ}[1]{\lstinline{#1}}

\newcommand{\kwrd}[1]{ \texttt{\textbf{\color{blue}{#1}}}  }

%%% This is from Fernando's setup.

% \usepackage{color}

% \definecolor{orange}{cmyk}{0,0.4,0.8,0.2}

% % Use and configure listings package for nicely formatted code

% \usepackage{listings}

% \lstset{

%    language=Python,

%    basicstyle=\small\ttfamily,

%    commentstyle=\ttfamily\color{blue},

%    stringstyle=\ttfamily\color{orange},

%    showstringspaces=false,

%    breaklines=true,

%    postbreak = \space\dots

% }

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% Title page

\title[Version Control Systems]{SEES: Version Control Systems}

\author[FOSSEE] {FOSSEE}

\institute[IIT Bombay] {Department of Aerospace Engineering\\IIT Bombay}

\date[]{}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%\pgfdeclareimage[height=0.75cm]{iitmlogo}{iitmlogo}

%\logo{\pgfuseimage{iitmlogo}}

%% Delete this, if you do not want the table of contents to pop up at

%% the beginning of each subsection:

\AtBeginSubsection[]

{

  \begin{frame}<beamer>

    \frametitle{Outline}

    \tableofcontents[currentsection,currentsubsection]

  \end{frame}

}

\AtBeginSection[]

{

  \begin{frame}<beamer>

    \frametitle{Outline}

    \tableofcontents[currentsection,currentsubsection]

  \end{frame}

}

% If you wish to uncover everything in a step-wise fashion, uncomment

% the following command: 

%\beamerdefaultoverlayspecification{<+->}

%%\includeonlyframes{current,current1,current2,current3,current4,current5,current6}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% DOCUMENT STARTS

\begin{document}

\begin{frame}

  \maketitle

\end{frame}

% CREATING TOC 

\begin{frame}

  \frametitle{Outline}

  \tableofcontents

  % You might wish to add the option [pausesections]

\end{frame}

%% There are some %$ used just to minimise the effect of $ sign used in lstlisting. In emacs it looks unhealthy.

% Introduction to course-need of version control, history, options available.

\section{Introduction}

%% Home made version control system?

\begin{frame}[fragile]

  \frametitle{Home-brew}

  \begin{center}

    \includegraphics[height=1.8in,width=4.2in]{folder.png}

  \end{center}

  \begin{lstlisting}

$ ls

a.out  id1.txt  id2.txt  identifier.cpp  id.txt  lex  pda1.cpp  pda2.cpp  pda.cpp  pda.txt  string.txt

  \end{lstlisting} %%$

    %%a screen-shot of folder with all crazy names.  

\end{frame}

\begin{frame}[fragile]

  \frametitle{Problems with such nomenclature}  

  \begin{block}{}    

  \begin{itemize}

  \item Difficult to relate to content of file.

  \item Cant track changes done to file.

  \item It wont scale.

  \end{itemize}

    \end{block}

\end{frame}

\begin{frame}

  \frametitle{What is version control}

  \begin{block}{From a blog post}

    ``Version control (or source control) is nothing more than keeping copies of work as we make changes to it.''

  \end{block}

\end{frame}

\begin{frame}[fragile]

  \frametitle{Need of Version Control}

  \begin{itemize}

  \item Track the history and evolution of a program.

  \item To collaborate effectively on a project.

  \item \begin{color}{red}``To err is Human''\end{color} for recovery we have ...

  \end{itemize}

\end{frame}

%% Introduction to how logs are managed in VCS.

%% A analogy in logs and day-to-day life?

\begin{frame}[fragile]

  \frametitle{How does it work? Analogy}

  It can roughly be related to Computer/Video Games.

  \begin{itemize}

  \item We play games in stages.

  \item We pass a stage/task- \begin{color}{red}we SAVE the game.\end{color}

  \item We resume playing from there onwards.

  \item In-case we want to replay or revisit some particular stage, we start from position we saved earlier.

  \item Even we can change the course of play henceforth.

  \end{itemize}

\end{frame}

\begin{frame}[fragile]

  \frametitle{Better way to say:}

  \begin{center}

    \includegraphics[height=2.5in,width=2.5in, interpolate=true]{mario}

  \end{center}  

  \emphbar{VCS provides power to save and resume from a stage.}

\end{frame}

\begin{frame}

  \frametitle{How is it done?}

  \begin{itemize}

  \item It keeps track of changes you make to a file. You can improve, revisit, and amend.

  \item All changes are logged/recorded, so you and others can follow the development cycle.

  \end{itemize}  

\end{frame}

%% Introduction to jargon 

%% This should have some excerpts from normal systems.

%% Like diffs, folders etc.

%% \section{Learning the Lingo!}

%% \begin{frame}[fragile]

%%   \frametitle{Common jargon: Basic setup}

%%   \begin{lstlisting}

%% $ ls slides/

%% filter.png  lena_mean.png  lena.png  

%% neighbour.png  pool.aux  pool.log  

%% pool.nav  pool.out  pool.pdf  pool.snm  

%% pool.tex  pool.tex~  pool.toc  pool.vrb    

%%   \end{lstlisting}  %%$

%%   \begin{itemize}

%%   \item Repository(repo):\\

%%         The folder with all files.

%%   %% \item Server:\\

%%   %%       Machine with main inventory/repo.

%%   %% \item Client:\\

%%   %%       Local machines with copy of main repo.

%%   \end{itemize}

%% \end{frame}

%% \begin{frame}[fragile]

%%   \frametitle{Actions}

%%   \begin{itemize}

%%   \item Add:\\

%%     Creating/Copying files(cp, touch).

%%   \item Check out/Clone:\\

%%     Creating copy of working folder.

%%   \end{itemize}

%%   \begin{lstlisting}

%% $ cp -rv circulate/ local

%% `circulate/' -> `local'

%% `circulate/sslc1.txt' -> `local/sslc1.txt'

%% `circulate/pos.txt' -> `local/pos.txt'

%% `circulate/pendulum.txt' -> `local/pendulum.txt'

%% `circulate/lena.png' -> `local/lena.png'

%% `circulate/sslc1.py' -> `local/sslc1.py'

%% `circulate/points.txt' -> `local/points.txt'    

%%   \end{lstlisting}  %%$

%% \end{frame}

%% \begin{frame}

%%   \frametitle{Actions cont...}

%%   \begin{itemize}

%%     \item Version:\\

%%     Version number(Die Hard 4.0).\\

%%     Making changes to folder, changes state/version.

%%     \item Head/Tip:\\

%%     Most recent revision/stage.

%%     \item Commit:\\

%%     Saving(recording) a change.

%%   \item Change log/History:\\

%%     List of all past changes.

%%   \end{itemize}

%% \end{frame}

%% \begin{frame}

%%   \frametitle{Actions cont...}

%%   \begin{itemize}

%%   \item Branch:\\

%%     Separate local copy for bug fixing, testing.

%%   \item Diff/Change:\\

%%     Changes made in a file in two different versions.

%%   \item Merge (or patch):\\

%%     Appling the changes to file, to make it up-to-date.

%%   \item Conflict:\\

%%     When merging a file is not obvious.

%%   \item Resolve:\\

%%     Fixing the conflict manually.

%%   \end{itemize}

%% \end{frame}

%% % Types of Version Controls

%% %% \section{Types of VCS}

%% %% \begin{frame}

%% %%   \frametitle{Types:}

%% %%   Based on ways of managing the repo there are two types of VCS:

%% %%   \begin{itemize}

%% %%   \item Centralized VCS\\

%% %%     cvs, svn fall under this category.

%% %%   \item Distributed VCS\\

%% %%     hg, bzr, git follows this methodology.

%% %%   \end{itemize}

%% %%   \emphbar{We would be covering \typ{hg}}

%% %% \end{frame}

\begin{frame}

  \frametitle{We will cover hg?}

    \includegraphics[height=.75in, interpolate=true]{mercurial}\\

  Because it is:

  \begin{itemize}

  \item Easy to learn and use.

  \item Lightweight.

  \item Scales excellently.

  \item Written in Python.

  \end{itemize}

  \inctime{15}

\end{frame}

% Initializing the repo, cloning, committing changes, pushing, pulling to repo.

\section{Getting Started}

\begin{frame}

  \frametitle{Objective}

  \begin{block}{}

  \end{block}

  %% \pause

  %% \begin{block}{Disclaimer}

  %%   Please note, objective is not to learn creative writing, but to learn \alert{hg(mercurial)} via \alert{interesting} use case.

  %% \end{block}    

\end{frame}

\begin{frame}[fragile]

  \frametitle{Getting comfortable:}

  For checking \typ{hg} installation and its version type:

  \begin{lstlisting}

    $ hg version    

  \end{lstlisting}

  To get broad help on \typ{hg} and commands available:

  \begin{lstlisting}

    $ man hg

    $ hg help

  \end{lstlisting}

  To get help on particular \typ{hg} related option try:

  \begin{lstlisting}

    $ hg help diff

  \end{lstlisting} %$

\end{frame}

\begin{frame}[fragile]

  \frametitle{Getting working/existing code base}

  \begin{lstlisting}

$ hg clone 

http://hg.serpentine.com/tutorial/hello 

localCopyhello

  \end{lstlisting}

\typ{localCopyhello} is copy of code-base. 

  \begin{lstlisting}

$ ls localCopyhello/

hello.c  Makefile

  \end{lstlisting}

\end{frame}

%%introduction to clone, repo, server, client.

\begin{frame}[fragile]

  \frametitle{What did we do!}

  \begin{block}{Explanation}

    \begin{itemize}

    \item<1-> \typ{hello} is a \alert{repo}, it's a collection of files and folders. 

    \item<2-> This repo is located on remote(\alert{server}) machine.    

    \item<3-> We copy(\alert{clone}) repo to our local machine.

    \end{itemize}    

  \end{block}

\end{frame}

\begin{frame}[fragile]

  \frametitle{Creating repo of existing files}

  I have some files which I want to bring under version control. \typ{hg} provides \alert{\typ{init}} command for this: 

  \begin{lstlisting}

$ ls -a circulate/

.  ..  lena.png  pendulum.txt  points.txt  pos.txt  sslc1.py  sslc1.txt

$ cd circulate/

$ hg init

$ ls -a

.  ..  .hg  lena.png  pendulum.txt  points.txt  pos.txt  sslc1.py  sslc1.txt    

  \end{lstlisting}

  \emphbar{\typ{.hg} directory keeps log of changes made henceforth.}

\end{frame}

\begin{frame}[fragile]

  \frametitle{Starting fresh}

  We can use \typ{init} to start a new repository also

  \begin{lstlisting}

$ mkdir letter

$ cd letter

$ touch letter.tex

$ ls -a

.  ..  letter.tex

$ hg init

$ ls -a

.  ..  letter.tex  .hg

  \end{lstlisting}

\end{frame}

\begin{frame}[fragile]

  \frametitle{Making copies: Branching}

  All \typ{hg} repositories are self-contained, and independent which can be copied(cloned):

  \begin{lstlisting}

$ hg clone localCopyhello newCopy

updating working directory

2 files updated, 0 files merged, 

0 files removed, 0 files unresolved

  \end{lstlisting}

  \alert{or}

  \begin{lstlisting}

$ hg clone letter letter-clone

updating working directory

0 files updated, 0 files merged, 

0 files removed, 0 files unresolved 

 \end{lstlisting}

\end{frame}

%%introduction to branch

\begin{frame}[fragile]

  \frametitle{Why do we need branching?}

  \begin{block}{}

    \begin{itemize}

    \item To keep separate set for \alert{experimentation}.

    \item Simple way to \alert{backup} all in one go!

    \item It helps in collaborative environment.

    %% should we mention it at all? there is no need to know atleast here.

    %% syncing and integrating in backup files and testing environment can also be mentioned.

    \end{itemize}

  \end{block}

  \inctime{15}

\end{frame}

%% Should we here stress on how are distribute VCS have 

%% different approach then centralized ones? Maybe a pic

%% or some other graphical representation.

\begin{frame}[fragile]

  \frametitle{Revisiting saved points:history/logs}

  In \typ{hg}, the difference between consecutive stages is termed as \alert{changeset}.\\

  Once we have saved stages, we need a mechanism to review and access them, for that use \alert{\typ{log}} command.

  \begin{lstlisting}

$ cd localCopyhello

$ hg log    

  \end{lstlisting}

\end{frame}

\begin{frame}[fragile]

  \frametitle{Understanding output}

  It provides following information:

  \begin{itemize}

  \item \alert{changeset}: Identifiers for the changeset.

  \item \alert{user}: Person who created the changeset.

  \item \alert{date}: Date and time of creation of changeset.

  \item \alert{summary}: One line description.

  \end{itemize}

\end{frame}

%% here we should have image of dotA or halo for resuming from a stage in game.

\begin{frame}[fragile]

  \frametitle{History/Logs cont...}

  By default \typ{log} returns complete list of all changes. \\

  For selective view try:

\begin{lstlisting}

$ hg log -r 3

$ hg log -r 2:4

\end{lstlisting}

  tip/latest changes can be seen via:

  \begin{lstlisting}

$ hg tip    

  \end{lstlisting} %%$

  \inctime{5}

\end{frame}

\begin{frame}[fragile]

  \frametitle{Advancing through a stage:status}

  We often need to add/delete some files from directory(repo). The structure keeps on evolving, and tools for handling them are needed.\\

  We will use the \typ{letter} repo we created earlier.

  \begin{lstlisting}

$ cd letter

$ hg log

$ hg st

? letter.tex

  \end{lstlisting} %%$

  \alert{\typ{st}} (aka status) is command to show changed files in the working directory.\\

\end{frame}

%% track record is confusing for some. Duma have some doubts :(

\begin{frame}[fragile]

  \frametitle{Adding files}

  "?" indicates that this file are aliens to track record.\\

  \alert{\typ{add}} command is available to add new files to present structure.

  \begin{lstlisting}

$ hg add letter.tex

$ hg st

A letter.tex

  \end{lstlisting}

\end{frame}

\begin{frame}[fragile]

  \frametitle{Saving present stage: committing}

  \emphbar{This is equivalent to completing tasks, before reaching a stage where you want to save.}

  \typ{hg} uses \alert{\typ{ci}}(aka \typ{commit}) command to save changes. So after adding file, we have to commit it also:

  \begin{lstlisting}

$ hg ci -u "Shantanu <shantanu@fossee.in>" 

        -m "First commit."

$ hg log

changeset:   0:210664b4ed58

tag:         tip

user:        Shantanu <shantanu@fossee.in>

date:        Tue Feb 23 19:41:45 2010 +0530

summary:     First commit.

  \end{lstlisting}

\end{frame}