diff options
Diffstat (limited to 'Version_Control/vcs3')
-rw-r--r-- | Version_Control/vcs3/vcs3.rst | 268 | ||||
-rw-r--r-- | Version_Control/vcs3/vcslide3.tex | 320 |
2 files changed, 588 insertions, 0 deletions
diff --git a/Version_Control/vcs3/vcs3.rst b/Version_Control/vcs3/vcs3.rst new file mode 100644 index 0000000..4f43f6b --- /dev/null +++ b/Version_Control/vcs3/vcs3.rst @@ -0,0 +1,268 @@ + +--------------------------------- +Version Control using Hg Part 3 +--------------------------------- + +.. Prerequisites +.. ------------- + +.. Version Control with hg - Part 1,2 + +.. Author : Primal Pappachan + Internal Reviewer : + Date: Jan 27, 2012 + + +-------- +Script +-------- + +.. L1 + +{{{ Show the first slide containing title, name of the production team along with the logo of MHRD}}} + +.. R1 + +Hello friends and welcome to the tutorial on 'Version Control with Hg' + +.. L2 + +{{{Show the slide 'Prerequisite'}}} + +.. R2 + +Please make sure that you have gone through the following tutorials before you +continue on this tutorial + +.. L3 + +{{{Show the slide containing the objectives}}} + +.. R3 + +At the end of this tutorial you will be able to + 1. Learn how to view and revert changes made to files in a repository. + #. Learn how to share repositories and deal with simultaneous conflicting changes. + +.. L4 + +{{{Show the slide 'Operational overhead?'}}} + +.. R4 + +Let's first try to find out why we should commit inspite of the additional operational costs and loss of time? + +.. L4 + +{{{Show the slide 'Revert Changes'}}} + +.. R4 + +While you were wondering, let's say your friend walks in and together you make +a lot of changes. You replace all the occurrences of & in chapter1.txt with and. 2. You delete +the chapter3.txt file. + +.. L5 + +$ rm chapter3.txt +$ hg st +M chapter1.txt +! chapter3.txt + +.. R6 + +But after a while, you realize that these changes are unwarranted. You want to +go back to the previous state, undoing all the changes that you made, after +your friend arrived. + +The undo in your editor may allow undoing some changes(if you haven't closed it after making the changes) but there's no way of getting back deleted files using your editor. That's where mercurial comes to the rescue. + +We shall use the revert command of hg to undo all the changes after the last commit. If we want to undo all the changes, we use the revert command with the --all argument, else use revert command with specific filename as argument. + +.. L5 + +$ hg revert --all +reverting chapter1.txt +reverting chapter3.txt +$ hg st +? chapter1.txt.orig +$ ls +chapter1.txt chapter1.txt.orig chapter2.txt chapter3.txt + +.. R5 + +After running this command, you can see that all deleted files have been restored. +But hg has generated new files with .orig extension. Mercurial actually doesn't like +to delete any of the changes that you have made. So, it makes a back-up of the already +existing files in the present state and gives you back the old file. + +If we now decide, that we want to redo the changes that we had done to the +existing file, we can just overwrite it with the backed up file. + +.. L6 + +$ mv chapter1.txt.orig chapter1.txt +$ hg st +M chapter1.txt + +.. L7 + +{{{Show the slide 'Viewing Changes'}}} + +.. R6 + +Let's say we now want to commit these changes, but we are not sure of all the changes that we have made to the file, since it's been a while after we made the changes. We could use the diff command to see all the changes that have been made in the file. + +.. L8 + +$ hg diff + +.. R7 + +You see some cryptic output, but it's essentially giving you the list of changes made to the file. All the lines that were deleted are preceded by a - and all the new-lines are preceded by a +. You can see that the & occurrences have been replaces with and. + +We should note here that, the diff wouldn't make much sense, if we had some +binary files like .jpg or .pdf files. We would see some gibberish in the +output. Let's now commit this change. + +.. L9 + +$hg commit +$hg log + +.. R8 + +We can pass an additional argument, -v or --verbose, to hg log to get the whole +commit message, instead of just the summary. + +.. L10 + +$hg log -v + +.. R9 + +Also, we are not always, interested to see the whole history of the project. It +would often suffice to see the last few commits. + +.. L11 + +$ hg log -v -l3 + +.. R10 + +To limit the output of hg log, we could use the -l or --limit argument. Now it +will print only last three commits. + +.. L12 + +{{{Show the slide 'Revision Numbering'}}} + +.. R11 + +Often, the level of detail provided by the commit messages is also not enough. +We would want to see what exactly changed with a commit, probably as a diff. We +could do that using revision numbers. + +Use the log command to get a brief description of all the changes made, by +showing us the summary line of all the commits. Look at the changeset line in +the output of the command. It shows a number followed by a semi-colon and some +long hexa-decimal string. The number is called the revision number. It is an +identifier for the commit, and can be along with various commands to specify +the revision number, if required. + +.. L13 + +{{{Show the slide 'Using revision numbers'}}} + + +.. R12 + +The revision number can also be passed as an argument to many commands. Let's say we wish to see the changes between revision 1 and revision 2. We shall use the diff command to do this. + +.. L14 + +$ hg diff -r1 -r2 + +.. R13 + +The diff command takes two revision numbers as arguments and gives the changes made from revision in the first argument to revision in the second argument. + +.. R14 + +It can be passed to other commands as well. For instance, we can check the logs of the very first commit, by saying + +.. L15 + +$ hg log -r0 + +.. R15 + +You could also specify a range of commits whose logs you would like to see. Say, we would like to see the last two commits, + +.. L16 + +$ hg log -r0:2 + +.. R16 + +To see changes made to a particular file, in the speciifed range of commits, + +.. L17 + +$ hg log -r0:2 chapter2.txt + + +.. R17 + +This brings us to the end of the tutorial. In this tutorial, we have +seen, + +.. L18 + +{{{Show the 'summary' slide'}}} + +.. R18 + +In this tutorial, we have learnt to, + 1. Undo changes to the repository using hg revert, + #. View changes done to the repository using hg diff + #. Use revision numbers as arguments to different hg commands + +.. L19 + +{{{ Show self assessment questions slide }}} + +.. R19 + +Here are some self assessment questions for you to solve + + +.. L20 + +{{{ Solution of self assessment questions on slide }}} + +.. R20 + +And the answers, + + + +.. L21 + +{{{ Show the Thank you slide }}} + +.. R21 + +Hope you have enjoyed this tutorial and found it useful. +Thank you! + + + + + + + + + + + diff --git a/Version_Control/vcs3/vcslide3.tex b/Version_Control/vcs3/vcslide3.tex new file mode 100644 index 0000000..9073747 --- /dev/null +++ b/Version_Control/vcs3/vcslide3.tex @@ -0,0 +1,320 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Version Control Systems +% +% Author: FOSSEE +% Copyright (c) 2009, FOSSEE, IIT Bombay +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\documentclass[12pt,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=bash, + basicstyle=\ttfamily\bfseries, + commentstyle=\color{red}\itshape, + stringstyle=\color{darkgreen}, + showstringspaces=false, + keywordstyle=\color{blue}\bfseries} + +\newcommand{\inctime}[1]{\addtocounter{time}{#1}{\tiny \thetime\ m}} + +\newcommand{\typ}[1]{\lstinline{#1}} + +\newcommand{\kwrd}[1]{ \texttt{\textbf{\color{blue}{#1}}} } + +\setbeamercolor{emphbar}{bg=blue!20, fg=black} +\newcommand{\emphbar}[1] + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% DOCUMENT STARTS +\begin{document} + +\begin{frame} + +\begin{center} +\vspace{12pt} +\textcolor{blue}{\huge Version Control with hg} +\end{center} +\vspace{18pt} +\begin{center} +\vspace{10pt} +\includegraphics[scale=0.95]{../images/fossee-logo.png}\\ +\vspace{5pt} +\scriptsize Developed by FOSSEE Team, IIT-Bombay. \\ +\scriptsize Funded by National Mission on Education through ICT\\ +\scriptsize MHRD,Govt. of India\\ +\includegraphics[scale=0.30]{../images/iitb-logo.jpg}\\ +\end{center} +\end{frame} + +\begin{frame} + \frametitle{Objectives} +\label{sec-2} + At the end of this session, you will be able to: + \begin{itemize} + \item Learn how to view and revert changes made to files in a repository. + \item Learn how to share repositories and deal with simultaneous conflicting changes. + \end{itemize} +\end{frame} + +\begin{frame} +\frametitle{Pre-requisite} +\textbf{Version Control Using Hg} + \begin{itemize} + \item Part 1 + \item Part 2 + \end{itemize} +\end{frame} + +\begin{frame} + \frametitle{Operational overhead?} + \begin{itemize} + \item But why do we \typ{commit}? + \item Isn't all this just adding to operational costs? + \item Isn't all this a waste of time? + \end{itemize} + \begin{center} + \emphbar{No! You shall see the benefits, soon!} + \end{center} +\end{frame} + +\begin{frame} + \frametitle{Revert Changes} + \begin{itemize} + \item Undo all changes; the editor can only do so much. + \item \typ{hg revert --all} + \item \typ{hg revert filename} + \item Present file, with changes --- \typ{filename.orig} + \end{itemize} +\end{frame} + +\begin{frame}[fragile] + \frametitle{Viewing Changes} + \begin{itemize} + \item \typ{hg diff} --- all changes since last commit + \end{itemize} + \begin{block}{} + \begin{lstlisting} + - this line was deleted + + this line was added + \end{lstlisting} + \end{block} +\end{frame} + + +\begin{frame}[fragile] + \frametitle{Revision numbering} + \begin{itemize} + \item \typ{changeset: n:cbf6e2a375b4} + \item \typ{n} is the revision number + \item The revision number is local to a repository + \item \typ{cbf6e2a375b4} is the unique identifier + \end{itemize} +\end{frame} + +\begin{frame}[fragile] + \frametitle{Using revision numbers} + \begin{itemize} + \item \typ{-r n} can be passed as arguments to commands to specify + the revision number + \item For instance, \typ{hg diff -r1 -r2} + \item \typ{m:n} specifies a range of revision numbers + \item For instance, \typ{hg log -r0:2} + \end{itemize} +\end{frame} + +\section{Collaborating with Mercurial} +\begin{frame}[fragile] + \frametitle{Cloning Repositories} + \begin{itemize} + \item \typ{hg clone SOURCE [DEST]} + \item All \typ{hg} repositories are self-contained + \end{itemize} +\end{frame} + +\begin{frame}[fragile] + \frametitle{Sharing Repositories} + \begin{itemize} + \item \typ{hg serve} + \item Can be cloned with \typ{hg clone http://my-ip-address:8000} + \item We share a central repository; work on our local copies. + \item Set write permissions in \typ{.hg/hgrc} + \end{itemize} + \begin{lstlisting} + [web] + push_ssl=False + allow_push=* + \end{lstlisting} +\end{frame} + +\begin{frame} + \frametitle{Sharing Changes} + \begin{itemize} + \item Use \typ{hg push} to push your \typ{commits} + (\typ{changesets}) to the central repository + \end{itemize} +\end{frame} + + +\begin{frame} + \frametitle{Pulling Changes} + \begin{itemize} + \item \typ{hg incoming} shows new \typ{changesets} in the server + \item To get these \typ{changesets}, we use \typ{hg pull} + \item These changes do not affect our working directory + \item \typ{hg parent} shows the parents of the working directory + \end{itemize} +\end{frame} + +\begin{frame} + \frametitle{Pulling Changes \ldots} + \begin{itemize} + \item \typ{hg update} will update the working directory + \begin{itemize} + \item Updates to the \typ{tip} if no revision is specified + \item \typ{tip} is the most recently added changeset + \item Can specify revision number to update to + \end{itemize} + \item \typ{hg tip} shows the \typ{tip} of the repository + \end{itemize} +\end{frame} + +\begin{frame} + \frametitle{Simultaneous Changes} + \begin{itemize} + \item The logs of both repositories will be different + \item The repositories have diverged + \item \typ{hg push} fails, in such a scenario + \item \alert{Never, Never, Never, Ever} use \typ{hg push -f} + \end{itemize} +\end{frame} + +\begin{frame} + \frametitle{Merging} + \begin{itemize} + \item Pull and merge, when \typ{abort: push creates new remote + heads!} + \item \typ{hg merge} will merge the two diverged heads + \item \typ{commit} after you have \typ{merged}! + \end{itemize} +\end{frame} + +\begin{frame} + \frametitle{Simultaneous Changes \ldots} + \begin{itemize} + \item \typ{outgoing} shows the \typ{changesets} that will be pushed + \item \typ{hg push} works! + \item Look at the `Change graph'! + \end{itemize} +\end{frame} + +\begin{frame} + \frametitle{Simultaneous Conflicting Changes} + \begin{itemize} + \item What if the changes conflict? -- overlapping edits + \item \typ{hg push} fails; \typ{hg pull}; \typ{hg merge} + \item You now get a diff view with 3 panes + \begin{itemize} + \item First --- current file + \item Second --- \typ{changesets} that you pulled + \item Third --- file before you made your changes + \end{itemize} + \item Resolve conflict and save + \item \typ{hg commit}; \typ{hg push} + \item Look at the `Change graph'! + \end{itemize} +\end{frame} + +\section{Conclusion} + +\begin{frame} + \frametitle{\alert{Advice}: Work-flow} + General work-flow + \begin{itemize} + \item \typ{pull}; \typ{update} + \item Make changes + \item \typ{commit} + \item If changes on repo, \typ{pull} and \typ{merge} + \item \typ{push} + \end{itemize} + \emphbar{Commit Early, Commit Often} +\end{frame} + +\begin{frame} +\frametitle{Summary} +\label{sec-18} + +In this tutorial, we have learnt to, + +\begin{itemize} +\item Undo changes to the repository using hg revert, +\item View changes done to the repository using hg diff +\item Use revision numbers as arguments to different hg commands +\item Clone repositories, using hg clone, +\item Serve our repositories via http using hg serve, +\item push changes to a repository using hg push, +\item check the changesets in a repository after last pull, using hg incoming, +\item pull changes from a repository using hg pull , +\item update the working directory, using hg update, +\item merge two heads, using hg merge, +\item and resolve conflicts using hg resolve. +\end{itemize} +\end{frame} +\begin{frame}[fragile] +\frametitle{Evaluation} +\label{sec-19} + + +\begin{enumerate} +\item +\item +\item +\end{enumerate} +\end{frame} +\begin{frame} +\frametitle{Solutions} +\label{sec-20} + + +\begin{enumerate} +\item +\vspace{15pt} +\item +\end{enumerate} +\end{frame} +\begin{frame} + + +\begin{block}{} + \begin{center} + \textcolor{blue}{\Large THANK YOU!} + \end{center} + \end{block} +\begin{block}{} + \begin{center} + For more Information, visit our website\\ + \url{http://fossee.in/} + \end{center} + \end{block} +\end{frame} + +\end{document} + |