diff options
| author | Parth Buch | 2012-05-11 15:19:53 +0530 |
|---|---|---|
| committer | Parth Buch | 2012-05-11 15:19:53 +0530 |
| commit | 2c09415a3b25ea7606168fdcf162caa1a2529db9 (patch) | |
| tree | 9289e5237c709b847ea929e5ba0cd96fb96434cc | |
| parent | 732cf029e454e184a8288ac806d75129bdf57486 (diff) | |
| download | sdes-stscripts-2c09415a3b25ea7606168fdcf162caa1a2529db9.tar.gz sdes-stscripts-2c09415a3b25ea7606168fdcf162caa1a2529db9.tar.bz2 sdes-stscripts-2c09415a3b25ea7606168fdcf162caa1a2529db9.zip | |
vcs1 reviewed by Kiran
| -rw-r--r-- | Version_Control/vcs1/vcs1.rst | 325 |
1 files changed, 196 insertions, 129 deletions
diff --git a/Version_Control/vcs1/vcs1.rst b/Version_Control/vcs1/vcs1.rst index c022513..02eb080 100644 --- a/Version_Control/vcs1/vcs1.rst +++ b/Version_Control/vcs1/vcs1.rst @@ -1,6 +1,3 @@ ---------------------------------- -Version Control using Hg Part I ---------------------------------- .. Prerequisites .. ------------- @@ -9,231 +6,301 @@ Version Control using Hg Part I .. Author : Primal Pappachan Internal Reviewer : Kiran Isukapatla - Date: Jan 27, 2012 - ----------------------- -Spoken Tutorial Script ----------------------- + Date: Jan 8, 2012 +-------- +Script +-------- .. L1 -*{{{ Show the first slide containing title, name of the production team along -with the logo of MHRD}}}* +{{{ Show the first slide containing title, name of the production team along with the logo of MHRD}}} -.. R1 +i.. R1 -Hello friends and welcome to the first part of tutorial on 'Version Control -using Hg' +Hello friends and welcome to the tutorial on 'Version Control with Hg' .. L2 -*{{{Show the slide containing the objectives}}}* +{{{Show the slide containing the objectives}}} .. R2 At the end of this tutorial you will be able to - 1. Understand what is Version Control - #. Identify the need for using Version Control - #. Install Mercurial and intialize a repository +1. Understand what is Version Control and the need for it. + +#. Create and use a repository on a daily basis. +.. R3 First, let's understand what 'Version Control' is. .. L3 -*{{{Show the slide 'what is version control'}}*} +{{{Show the slide 'what is version control'}}} -.. R3 +.. R4 -'Version control' is a way to track files over time and share them. This allows -access to earlier versions of a file(s) if and when required. It therefore -enables us to make changes to the content of a file, view it's change log and -collaborate on a single piece of work with a team of people. +'Version control' is a way to track files over time and share them. This allows access to earlier versions of a file(s) if and when required. It therefore enables us to make changes to the content of a file, view it's change log and collaborate on a single piece of work with a team of people. -As the quote from the famous blog post 'Version Control for masses' says - -"Version control is one of those weird, geeky things that never really gained - much ground in non-geek fields, despite the fact that it’s blindingly useful." - -Over the course of these 3 spoken tutorials, we are going to see a handful of -such things, which are widely used in the programmer world, but not so much in -the scientific computing world, even when if they would be very useful. .. L4 -*{{{Show the slide 'Home-brewed'}}}* +{{{Show the slide 'Home-brewed'}}} -.. R4 +.. R5 -Let's look at an example of home-brewed Version Control system +Let's look at an example of home-brew Version Control system -Version control is a way of backing up files, before making changes. Most -people would have cooked up their own version control system, without -realizing, there were tools built by others, that performs the task in a more -organized and systematic way. +Version control is a way of backing up files, before making changes. Most people would have cooked up their own version control system, without realizing, there were tools built by others, that performs the task in a more organized and systematic way. .. L5 -*{{{Show the slide 'Problems'}}}* - -.. R5 +{{{Show the slide 'Problems'}}} Let's look at the various problems associated with this set-up. - 1. Name and changes made are not related or linked. - #. Can't track sequence of changes made to a file - #. Does not scale - -.. L6 +.. R6 -*{{{Show the slide 'The need for Version Control'}}}* +Now, let's move to identifying the needs for a 'Version Control System'. -.. R6 +.. L6 -Having seen the problems of a home brewed setup, let's now move onto -identifying the needs for a 'Version Control System'. +{{{Show the slide 'The need for Version Control'}}} - 1. To err is Human . . . - #. Tracking the history and evolution of a project - #. To collaborate effectively on a project - #. To efficiently track down bugs and pin-point the - #. changes that caused it +.. R7 -.. L7 +We have seen that one of the main motivations to use a Version Control system is the ability to go back to a working version of a file, when something goes wrong. Below are a few more advantages of using an automated version control system. -*{{{Show the slide 'The need for Version Control'}}}* +1. By tracking the history of a project, any person may see the evolution of a project. -.. R7 +#. Allows for effective collaboration on a project, as everything is shared. -We have seen that one of the main motivations to use a Version Control system -is the ability to go back to a working version of a file, when something goes -wrong. Below are a few more advantages of using an automated version control -system. +#. Helps to identify which additions have broken down a project and thus aids in efficient tracking down of the bugs. -1. By tracking the history of a project, any person may see the evolution of a p -2. Allows for effective collaboration on a project, as everything is shared. -3. Helps to identify which additions have broken down a project and thus aids in -4. It is good for a one man show as it is for a big group of people working on a +#. It is good for a one man show as it is for a big group of people working on a project. -Keeping your stuff version controlled will help avoid accidental deletion of -individual files etc. Hosting it on a remote server will protect your sanity -from a hard disk crash. -.. L8 +.. L7 -*{{{Show the slide 'How does it work? - Analogy}}}* +{{{Show the slide 'How does it work? - Analogy}}} .. R8 -It is, in some ways, similar to playing a video game. We generally play games -in stages. While playing, we save the game at some instances as per our choice. -We continue playing, but we could, if necessary, choose to go back to one of -the saved states and start over. In this manner, we could change the course of -the game. +It is, in some ways, similar to playing a video game. We generally play games in stages. While playing, we save the game at some instances as per our choice. We continue playing, but we could, if necessary, choose to go back to one of the saved states and start over. In this manner, we could change the state of the game. -.. L9 +.. L8 -*{{{Show the slide 'Mercurial or hg'}}}* +{{{Show the slide 'Mercurial or hg'}}} .. R9 Some of the Version Control tools available and used widely are: - 1. cvs(Concurrent Version Systems) - #. svn(subversion) - #. hg(mercurial) - #. git +1. cvs(Concurrent Version Systems) + +#. svn(subversion) +#. hg(mercurial) -Each of these tools have their own merits and demerits. In this tutorial we -shall learn how to use mercurial or hg which is easy to learn and use and -comparatively light weight. Once you learn how to use hg, you can easily try -other tools and switch to one that you feel most comfortable with. +#. git -Let's now get into Installation. For Linux distributions, Ubuntu and Debian -type the following in command line terminal - -.. L10 +.. R10 -``sudo apt-get install mercurial`` +Each of these tools have their own merits and demerits. In this tutorial we shall learn how to use mercurial or hg. -.. R10 +Let's now get into Installation -For Windows, +.. L8 -.. L11 +sudo apt-get install mercurial -``http://mercurial.selenic.com/downloads/`` +.. R11 -``http://hgbook.red-bean.com/read/a-tour-of-mercurial-the-basics.html`` +For Windows, -.. R 11 +.. L9 -For any other Operating system, please refer the hg book for installation -instruction - +http://mercurial.selenic.com/downloads/ Type 'hg' which lists out all the commands -.. L12 +.. L10 -``$hg`` +$hg .. R12 and 'hg version' which gives the version number. -.. L13 +.. L11 -``$hg version`` +$hg version +.. R13 -*{{{Show the 'summary' slide'}}}* +Now, what exactly is a repo? A repo/repository is a folder with contains all the files and information on all the changes that were made to it. To save disk space, hg doesn't save all files, but only saves only a series of changes made to the files. -.. R13 +.. L13 -This brings us to the end of the tutorial. In this tutorial, we have -seen, +{{{Show the slide for 'We need a repo!'}}} -1. the motivation to use version control -#. an analogy of version control with playing a video game -#. how to check if mercurial is installed, and it's version using hg version +.. R14 + +Let's now see how to initialize a repo. .. L14 -*{{{Show self assessment questions slide}}}* +cd working-directory/ -.. R14 +$hg init -Here are some self assessment questions for you to solve +ls -a + +.. R15 - 1. Is Mercurial a Centralized VCS or Distributed VCS? Justify your reasoning. - #. How can you verify whether Mercurial has been installed properly? - #. What is the command for accessing built-in help system of Mercurial? +The .hg directory indicates that our book directory is now a hg repository. Mercurial keeps all the history of the changes made and a few other config files etc. in this directory. -.. L15 +.. L13 -*{{{Show the solutions slide to self assessment questions }}}* +$hg status .. R15 -And the answers, +Gives the status of our repo. As a beginner, use it often. + +.. L14 + +$hg help 'status' + +.. R16 + +You can use 'hg help commandname' which gives the details about the command. For example. + +.. L15 + +hg help status + +{{{Show the slides for 'Status Codes'}}} - 1. Mercurial is a Centralized Version Control system. To read more go here, htt - #. $hg version - #. $hg help command +.. R17 +Have a look at what various status codes, associated with the files mean. By looking at the codes, it is clear that our files are not being tracked by hg yet. Now let's move onto 'Adding Files'. .. L16 -*{{{Show the thank you slide}}}* +$hg status -.. R16 +.. R18 -Hope you have enjoyed this tutorial and found it useful. Feel free to play -around with Mercurial and read the documentation given by hg help command. When -you are ready to move on, please proceed to the second tutorial on 'Version -Control using Hg' +This shows that none of the files in the folder have been added yet. -Thank you +.. L17 + +$hg add + +.. R19 + +This simply adds all the files in the (working) directory, to the repository. As expected, the status command shows an 'A' has been appended to the filenames. We could also specify files individually, for example + +.. L18 + +$ hg add filename + +.. R20 + +We have added a set of files to the repository, but we haven't told mercurial to remember these changes. Now let's take a snapshot of this working directory. This can be done by using commit command. + +.. L19 + +$hg commit -u "username <user@domain.com>" -m "Commit message." + +.. R20 + +The -u parameter allows to specify the user details. The parameter -m is used to attach a commit message which gives a description of the changes committed to the repository. Check the status of repository by typing + +.. L20 + +$ hg st + +.. R21 + +To see the history of changes made to our repository, we use hg log. We can view the change that we just made to our repository. + +.. L21 + +{{{Show the slide 'Thumbnail views'}}} + +.. R21 + +hg log gives the log of the changes made in the form of changesets. A changeset is a set of changes made to the repository between two consecutive commits. It also shows the date at which the commit was made. + + +.. R22 + +User information is set in the hgrc file. It can be either set globally or locally to the project. + +For linux systems +.. L23 + +cat ~/.hgrc +[ui] +username = username <user@domain.com> +editor = vim + + +.. R23 + +We have now set the user-name details for mercurial to use. + +.. L24 + +{{{Show the slide 'Advice: commits, messages'}}} + +.. R24 + +1. Atomic changes; one change with one commit + +#. Single line summary — 60 to 65 characters long + +#. Followed by paragraphs of detailed description + - Why the change? + - What does it effect? + - Known bugs/issues? + - etc. + +.. L25 + +{{{Show the 'summary' slide'}}} + +.. R25 + +This brings us to the end of the tutorial. In this tutorial, we have +learnt to, + +.. L26 + +{{{Show self assessment questions slide}}} + +.. R26 + +Here are some self assessment questions for you to solve + +.. L27 + +{{{Show the solutions slide to self assessment questions }}} + +.. R27 + +And the answers, + + +.. L27 + +{{{Show the thank you slide}}} + +.. R28 + +Hope you have enjoyed this tutorial and found it useful. +Thank you |