update_repo 0.9.5 → 0.9.6

data/lib/update_repo.rb

@@ -136,7 +136,7 @@ module UpdateRepo
     #   update_repo('/Repo/linux/stable')
     def update_repo(dirpath)
       # create the git instance and then perform the update
-      git = GitControl.new(dirpath, @log, @metrics)
+      git = GitControl.new(dirpath, @log, @metrics, @cmd)
       git.update
       @metrics[:processed] += 1
       # update the metrics

data/lib/update_repo/cmd_config.rb

@@ -104,17 +104,18 @@ module UpdateRepo
         version "update_repo version #{VERSION} (C)2016 G. Ramsay\n"
         banner <<-EOS
 
-Keep multiple local Git-Cloned Repositories up to date with one command.
+  Keep multiple local Git-Cloned Repositories up to date with one command.
 
-Usage:
-      update_repo [options]
+  Usage:
+        update_repo [options]
 
-Options are not required. If none are specified then the program will read from
-the standard configuration file (~/#{CONFIG_FILE}) and automatically update the
-specified Repositories.
+  Options are not required. If none are specified then the program will read from
+  the standard configuration file (~/#{CONFIG_FILE}) and automatically update the
+  specified Repositories.
 
-Options:
-EOS
+  Options:
+
+        EOS
         opt :color, 'Use colored output', default: true
         opt :dump, 'Dump a list of Directories and Git URL\'s to STDOUT in CSV format', default: false
         opt :prune, "Number of directory levels to remove from the --dump output.\nOnly valid when --dump or -d specified.", default: 0
@@ -125,6 +126,7 @@ EOS
         opt :dump_remote, 'Create a dump to screen or log, listing all the git remote URLS found in the specified directories.', default: false, short: 'r'
         opt :dump_tree, 'Create a dump to screen or log, listing all subdirectories found below the specified locations in tree format.', default: false, short: 'u'
         opt :verbose, 'Display each repository and the git output to screen', default: false, short: 'V'
+        opt :verbose_errors, 'List all the error output from a failing command in the summary, not just the first line', default: false, short: 'E'
         opt :quiet, 'Run completely silent, with no output to the terminal (except fatal errors).', default: false
       end
     end

data/lib/update_repo/console_output.rb

@@ -79,7 +79,7 @@ module UpdateRepo
       # print out any and all errors into a nice list
       @metrics[:failed_list].each do |failed|
         print_log "\n  [", 'x'.red, "] #{failed[:loc]}"
-        print_log "\n    -> ", "\"#{failed[:line].chomp}\"".red
+        print_log "\n    -> ", failed[:line].chomp.red
       end
     end
 
@@ -91,7 +91,7 @@ module UpdateRepo
       @metrics[:failed_list].uniq! { |error| error[:loc] }
     end
 
-    # Print a list of any defined expections that will not be updated.
+    # Print a list of any defined exceptions that will not be updated.
     # @return [void]
     # @param [none]
     def list_exceptions

data/lib/update_repo/git_control.rb

@@ -16,14 +16,16 @@ module UpdateRepo
     # @param dir [string] The directory location of this local repo.
     # @param logger [instance] pointer to the Logger class
     # @param metrics [instance] pointer to the Metrics class
+    # @param cmd [instance] pointer to the command options class
     # @return [void]
     # @example
     #   git = GitControl.new(repo_url, @logger, @metrics)
-    def initialize(dir, logger, metrics)
+    def initialize(dir, logger, metrics, cmd)
       @status = { updated: false, failed: false, unchanged: false }
       @dir = dir
       @log = logger
       @metrics = metrics
+      @cmd = cmd
     end
 
     # Update the git repo that was specified in the initializer.
@@ -48,18 +50,36 @@ module UpdateRepo
       `git -C #{@dir} config remote.origin.url`.chomp
     end
 
+    # adds a line to the fail matrix (with it's location) if it does not already
+    # exist, otherwise it will add the line to the end of the previous for that
+    # location
+    # @param lin [string] The string containing the Git output line
+    # @return [void]
+    def update_fail_matrix(line)
+      err_loc = "#{@dir} (#{repo_url})"
+      # see if this error already has some text (metric exists)
+      err = @metrics[:failed_list].find { |fail| fail[:loc] == err_loc }
+      # if so we append this new line to it otherwise create the metric
+      if err && @cmd[:verbose_errors]
+        err[:line] = err[:line] + ' ' * 7 + line
+      else
+        @metrics[:failed_list].push(loc: err_loc, line: line)
+      end
+    end
+
     # print a git output line and update the metrics if an update has occurred
     # @param line [string] The string containing the git output line
     # @return [void]
     # rubocop:disable Metrics/LineLength
     def handle_output(line)
-      if line.chomp =~ /^fatal:|^error:/
-        print_log '   ', line.red
-        @status[:failed] = true
-        err_loc = "#{@dir} (#{repo_url})"
-        @metrics[:failed_list].push(loc: err_loc, line: line)
+      @status[:failed] = true if line.chomp =~ /^fatal:|^error:/
+      # @status[:failed] will persist throughout this entire git call.
+      if @status[:failed]
+        print_log ' ' * 3, line.red
+        # add new or update the fail matrix with another line
+        update_fail_matrix(line)
       else
-        print_log '   ', line.cyan
+        print_log ' ' * 3, line.cyan
         @status[:updated] = true if line =~ /^Updating\s[0-9a-f]{7}\.\.[0-9a-f]{7}/
         @status[:unchanged] = true if line =~ /^Already up-to-date./
       end

data/lib/update_repo/logger.rb

@@ -87,7 +87,7 @@ module UpdateRepo
       # prefix if exists
       calling_fn = caller_locations[2].label.gsub(/block in /, '')
       # array with the functions we want to skip
-      repo_output = %w(do_update handle_output skip_repo update)
+      repo_output = %w[do_update handle_output skip_repo update]
       # return TRUE if DOES match, FALSE otherwise.
       repo_output.include?(calling_fn) ? true : false
     end

data/lib/update_repo/version.rb

@@ -1,4 +1,4 @@
 module UpdateRepo
   # constant, current version of this Gem
-  VERSION = '0.9.5'.freeze
+  VERSION = '0.9.6'.freeze
 end

data/update_repo.gemspec

@@ -1,6 +1,7 @@
 # coding: utf-8
 # rubocop:disable LineLength
 # rubocop:disable Metrics/BlockLength
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'update_repo/version'

data/vagrant-support/bootstrap-sudo.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+# add PPA for latest Git version...
+add-apt-repository ppa:git-core/ppa
+
+# update package lists and upgrade the system...
+apt-get update
+apt-get -y full-upgrade
+
+# install some required packages...
+apt-get -y install git
+# install Ruby compile dependencies...
+apt-get -y install autoconf bison build-essential libssl-dev libyaml-dev libreadline6-dev zlib1g-dev libncurses5-dev libffi-dev libgdbm3 libgdbm-dev
+

data/vagrant-support/bootstrap.sh

@@ -0,0 +1,37 @@
+#!/usr/bin/env bash
+# these will run as the default non-privileged user.
+
+# install rbenv ruby version manager
+export PATH="$HOME/.rbenv/bin:$PATH"
+curl -fsSL https://github.com/rbenv/rbenv-installer/raw/master/bin/rbenv-installer | bash
+# install dynamic bash extension
+cd ~/.rbenv && src/configure && make -C src
+# add the rbenv setup to our profile, only if it is not already there
+if ! grep -qc 'rbenv init' /home/ubuntu/.bashrc ; then
+  echo "## Adding rbenv to .bashrc ##"
+  echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc
+  echo 'eval "$(rbenv init -)"' >> ~/.bashrc
+fi
+# run the above command locally so we can get rbenv to work on this provisioning shell
+eval "$(rbenv init -)"
+# set up .gemrc to avoid installing documentation for each gem...
+echo "gem: --no-document" > ~/.gemrc
+# install the required ruby version and set as default
+rbenv install 2.4.0
+rbenv global 2.4.0
+gem update --system
+gem update
+gem install bundler
+
+# install nvm  Node Version Manager and good version of node...
+curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.1/install.sh | bash
+export NVM_DIR="$HOME/.nvm"
+[ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh" # This loads nvm
+nvm install 6.10.0
+nvm use 6.10.0
+npm install gulp -g
+
+# install the required deps for Ruby...
+cd /vagrant && bundle install
+# install required Node deps for the website...
+cd /vagrant/web && npm install 

data/web/.nvmrc

@@ -0,0 +1 @@
+6.10.0

data/web/.scss-lint.yml

@@ -0,0 +1,45 @@
+---
+scss_files: './sass/'
+
+linters:
+  BorderZero:
+    enabled: true
+  ColorKeyword:
+    enabled: true
+  ColorVariable:
+    enabled: true
+  Comment:
+    enabled: true
+  EmptyLineBetweenBlocks:
+    enabled: true
+  EmptyRule:
+    enabled: false
+  FinalNewline:
+    enabled: true
+  HexLength:
+    enabled: true
+  HexNotation:
+    enabled: true
+  IdSelector:
+    enabled: true
+  ImportantRule:
+    enabled: false
+  Indentation:
+    enabled: true
+  LeadingZero:
+    enabled: true
+  MergeableSelector:
+    enabled: true
+  PropertySortOrder:
+    enabled: true
+  Shorthand:
+    enabled: true
+  SingleLinePerSelector:
+    enabled: true
+  StringQuotes:
+    enabled: true
+  TrailingWhitespace:
+    enabled: true
+  VendorPrefix:
+    enabled: true
+

data/web/gulpfile.js

@@ -0,0 +1,133 @@
+var gulp = require('gulp')
+var sass = require('gulp-sass')
+var browserSync = require('browser-sync')
+// var reload = browserSync.reload;
+var autoprefixer = require('gulp-autoprefixer')
+var browserify = require('gulp-browserify')
+var clean = require('gulp-clean')
+var concat = require('gulp-concat')
+var merge = require('merge-stream')
+var newer = require('gulp-newer')
+var imagemin = require('gulp-imagemin')
+var injectPartials = require('gulp-inject-partials')
+var minify = require('gulp-minify')
+var cssmin = require('gulp-cssmin')
+var rename = require('gulp-rename')
+var htmlmin = require('gulp-htmlmin')
+var gutil = require('gulp-util')
+var htmlreplace = require('gulp-html-replace')
+var mustache = require('gulp-mustache')
+
+var SOURCEPATHS = {
+  sassSource: 'sass/*.scss',
+  sassPartials: 'sass/partials/*.scss',
+  htmlSource: '*.html',
+  htmlPartials: 'partials/*.html',
+  jsSource: 'js/**',
+  cssSource: 'css/**',
+  imgSource: 'img/**',
+  jsonSource: 'webdata.json'
+}
+
+var APPPATH = {
+  root: '../docs/',
+  css: '../docs/css',
+  js: '../docs/js',
+  fonts: '../docs/fonts',
+  img: '../docs/img'
+}
+
+// determine if we want production mode (minified js/css/html) or not
+var isProduction = false
+if (gutil.env.prod === true) {
+  isProduction = true
+}
+
+gulp.task('clean-all', function () {
+  return gulp.src([APPPATH.root + '/*.html', APPPATH.css + '/*.css', APPPATH.js + '/*.js'], {read: false, force: true})
+    .pipe(clean({force: true}))
+})
+
+// gulp.task('clean-css', function () {
+//   return gulp.src(APPPATH.css + '/*.css', {read: false, force: true})
+//     .pipe(clean({force: true}))
+// })
+
+// gulp.task('clean-scripts', function () {
+//   return gulp.src(APPPATH.js + '/*.js', {read: false, force: true})
+//     .pipe(clean({force: true}))
+// })
+
+gulp.task('sass', function () {
+  var bootstrapCSS = gulp.src('./node_modules/bootstrap/dist/css/bootstrap.css')
+  var sassFiles
+  var cssFiles = gulp.src([SOURCEPATHS.cssSource, './node_modules/font-awesome/css/font-awesome.css', './node_modules/prismjs/themes/prism.css'])
+
+  sassFiles = gulp.src(SOURCEPATHS.sassSource)
+    .pipe(sass({outputStyle: 'expanded'}).on('error', sass.logError))
+    .pipe(autoprefixer())
+  return merge(cssFiles, bootstrapCSS, sassFiles)
+    .pipe(concat('site.css'))
+    .pipe(isProduction ? cssmin({keepSpecialComments: 0}) : gutil.noop())
+    .pipe(isProduction ? rename({suffix: '.min'}) : gutil.noop())
+    .pipe(gulp.dest(APPPATH.css))
+})
+
+gulp.task('scripts', function () {
+  var prismJS = './node_modules/prismjs/prism.js'
+  var prismYAML = './node_modules/prismjs/components/prism-yaml.js'
+  var prismWS = './node_modules/prismjs/plugins/normalize-whitespace/prism-normalize-whitespace.js'
+
+  gulp.src([SOURCEPATHS.jsSource, prismJS, prismYAML, prismWS])
+    .pipe(concat('main.js'))
+    .pipe(browserify())
+    .pipe(isProduction ? minify({noSource: true}) : gutil.noop())
+    .pipe(gulp.dest(APPPATH.js))
+})
+
+gulp.task('html', function () {
+  return gulp.src(SOURCEPATHS.htmlSource)
+    .pipe(injectPartials({
+      removeTags: true
+    }))
+    .pipe(mustache(SOURCEPATHS.jsonSource))
+    .pipe(isProduction ? htmlreplace({'css': 'css/site.min.css', 'js': 'js/main-min.js'}) : gutil.noop())
+    .pipe(isProduction ? htmlmin({collapseWhitespace: true, removeComments: true}) : gutil.noop())
+    .pipe(gulp.dest(APPPATH.root))
+})
+
+gulp.task('images', function () {
+  return gulp.src(SOURCEPATHS.imgSource)
+    .pipe(newer(APPPATH.img))
+    .pipe(imagemin())
+    .pipe(gulp.dest(APPPATH.img))
+})
+
+gulp.task('moveFonts', function () {
+  gulp.src(['./node_modules/bootstrap/dist/fonts/**', './node_modules/font-awesome/fonts/**'])
+    .pipe(gulp.dest(APPPATH.fonts))
+})
+
+gulp.task('serve', ['sass', 'scripts'], function () {
+  browserSync.init([APPPATH.css + '/*.css', APPPATH.root + '/*.html', APPPATH.js + '/*.js'], {
+    server: {
+      baseDir: APPPATH.root
+    },
+    open: false
+  })
+})
+
+gulp.task('output-env', function () {
+  return isProduction ? gutil.log(gutil.colors.red.bold.underline('Running PRODUCTION environment')) : gutil.log(gutil.colors.green.bold.underline('Running DEVELOPMENT environment'))
+})
+
+gulp.task('watch', ['output-env', 'serve', 'clean-all', 'moveFonts', 'images', 'html'], function () {
+  gulp.watch([SOURCEPATHS.sassSource, SOURCEPATHS.sassPartials, SOURCEPATHS.cssSource], ['sass'])
+  gulp.watch([SOURCEPATHS.jsSource], ['scripts'])
+  gulp.watch([SOURCEPATHS.imgSource], ['images'])
+  gulp.watch([SOURCEPATHS.htmlSource, SOURCEPATHS.htmlPartials, SOURCEPATHS.jsonSource], ['html'])
+})
+
+gulp.task('default', ['watch'])
+
+gulp.task('build', ['output-env', 'sass', 'scripts', 'clean-all', 'moveFonts', 'images', 'html'])

data/web/index.html

@@ -0,0 +1,260 @@
+<!-- partial:partials/_header.html -->
+<!-- partial -->
+
+<!-- partial:partials/_navbar.html -->
+<!-- partial -->
+
+    <!-- ABOUT -->
+    <section class="about" id='about'>
+      <div class="container">
+        <div class="row row-header">
+          <div class="col-lg-12 col-md-12">
+            <h1 class="icon fa-info-circle">About</h1>
+          </div>
+        </div><!-- row -->
+        <div class="row row-body">
+          <div class="col-lg-12 col-md-12">
+            <p>A Simple Gem to keep multiple locally-cloned Git Repositories up to date.</p>
+            <p>The script will simply run <span class="console-output">git pull</span> on every local clone of a git repository that it finds under the specified directory or directories.</p>
+            <p class="important-note">Note: Versions prior to 0.9.4 had a serious bug where the script would crash on startup unless there was an <span class="yaml-tag">exception:</span> defined in the configuration file. This has been fixed from version 0.9.4 onwards.</p>
+            <div class="text-center">
+              <a href="https://badge.fury.io/rb/update_repo"><img src="https://badge.fury.io/rb/update_repo.svg" alt="Gem Version" height="18"></a>
+              <a href="https://travis-ci.org/seapagan/update_repo"><img src="https://travis-ci.org/seapagan/update_repo.svg?branch=master"></a>
+            </div>
+          </div>
+        </div><!-- row -->
+      </div><!-- container -->
+    </section>
+    <!-- ABOUT END -->
+
+    <!-- INSTALLATION -->
+    <section class="installation" id="installation">
+      <div class="container">
+        <div class="row row-header">
+          <div class="col-lg-12 col-md-12">
+            <h1 class="icon fa-download">Installation</h1>
+          </div>
+        </div><!-- row -->
+        <div class="row row-body">
+          <div class="col-lg-12 col-md-12">
+            <p>A working copy of both <a href="http://www.ruby-lang.org" target="_blank" class="icon fa-external-link">Ruby</a> and <a href="http://git-scm.com" target="_blank" class="icon fa-external-link">Git</a> need to be installed on your machine. <b>Git version 1.8.5 or greater is required</b>, the script will not run with an older version or indeed without Git installed. Ruby version 1.9.3 and newer are supported.</p>
+            <p>Currently the script has only been tested under Linux, not Windows however Windows testing is next in the grand plan!</p>
+            <p>Simply install from the command prompt as you would any other gem. Note that you may require <b>'sudo'</b> depending how Ruby is installed on your system.</p>
+            <pre><code>gem install update_repo</code></pre>
+          </div>
+        </div><!-- row -->
+      </div><!-- container -->
+    </section>
+    <!-- INSTALLATION END -->
+
+    <!-- USAGE -->
+    <section class="usage" id="usage">
+      <div class="container">
+        <div class="row row-header">
+          <div class="col-lg-12 col-md-12">
+            <h1 class="icon fa-check-square-o">Usage</h1>
+          </div>
+        </div><!-- row -->
+        <div class="row row-body">
+          <div class="col-lg-12 col-md-12">
+            <h2>Quick Start</h2>
+            <p>Create a <a class="icon fa-external-link" target="_blank" href="http://yaml.org/">YAML</a>-formatted configuration file called <span class="filename">.updaterepo</span> (note the 'dot' at the start!) in your home directory that contains at least a <span class="yaml-tag">location:</span> tag pointing to the directory containing the git repositories you wish to have updated :</p>
+              <pre>
+                <code class="language-yaml">
+                  ---
+                  location:
+                  - /media/myuser/git-repos
+                  - /data/RepoDir
+                </code>
+              </pre>
+            <p>The directory or directories specified (there can be 1 root directory or as many as you wish) must already exist, and can be nested as deep as you wish with many repositories in many subdirectories.</p>
+            <p>This is the most basic example of a configuration file and there are other options that can be added to fine-tune the operation - see the description of configuration options below.</p>
+            <p>Now, run the script from anywhere :</p>
+            <pre><code>update_repo</code></pre>
+            <p><b>Note:</b> From version 0.9.0 onwards, the default mode of operation is <b>non-verbose</b>. If you wish the same output as previous versions then specify <span class="cmdline">--verbose</span> on the command line or <span class="yaml-tag">verbose: true</span> in the configuration file.</p>
+          </div>
+        </div><!-- row -->
+      </div><!-- container -->
+    </section>
+    <!-- USAGE END -->
+
+    <!-- CONFIGURATION -->
+    <section class="configuration" id="configuration">
+      <div class="container">
+        <div class="row row-header">
+          <div class="col-lg-12 col-md-12">
+            <h1 class="icon fa-cog">Configuration</h1>
+          </div>
+        </div><!-- row -->
+        <div class="row row-body">
+          <div class="col-lg-12 col-md-12">
+            <h2>Configuration file</h2>
+            <p>The configuration file defaults to <span class="filename">~/.updaterepo</span> and is a standard <a href="http://yaml.org/" class="icon  fa-external-link">YAML</a> formatted text file. If this configuration file is not found, the script will terminate with an error.</p>
+            <p>The first line <b>must</b> contain only the YAML frontmatter of 3 dashes (<span class="yaml-tag">---</span>). After that, the following sections can follow in any order. Only the <span class="yaml-tag">location:</span> section is compulsory, and that must contain at least one entry.</p>
+          </div><!-- col -->
+
+          <div class="col-lg-12 col-md-12">
+            <p><span class="yaml-tag">location:</span> - at least one directory which contains the locally cloned repository(s) to update. There is no limit on how many directories can be listed :</p>
+            <pre>
+              <code class="language-yaml">
+                ---
+                location:
+                - /media/myuser/git-repos
+                - /data/RepoDir
+              </code>
+            </pre>
+          </div><!-- col -->
+
+          <div class="col-lg-12 col-md-12">
+            <p><span class="yaml-tag">exceptions:</span> - an (optional) list of repositories that will NOT be updated automatically. Use this for repositories that need special handling, or should only be manually updated. Note that the name specified is that of the <b>directory</b> holding the repository (has the <span class="filename">.git</span> directory inside) :</p>
+            <pre>
+              <code class="language-yaml">
+                exceptions:
+                - ubuntu-trusty
+                - update_repo
+              </code>
+            </pre>
+          </div><!-- col -->
+
+          <div class="col-lg-12 col-md-12">
+            <p><span class="yaml-tag">log:</span> - Log all output to the file <span class="filename">updaterepo.log</span> in the user's Home directory, defaults to <b>FALSE</b> (optional). This file would be overwritten on next run unless you also specify the <span class="yaml-tag">timestamp:</span> option. Equivalent to <span class="cmdline">--log</span> and <span class="cmdline">--no-log</span> on the command line.</p>
+            <pre>
+              <code class="language-yaml">
+                log: true
+              </code>
+            </pre>
+          </div><!-- col -->
+
+          <div class="col-lg-12 col-md-12">
+            <p><span class="yaml-tag">log_local:</span> - Store the logfile (if this is enabled) in the current working directory instead of the Users' Home directory. Defaults to <b>FALSE</b> (optional). Equivalent to <span class="cmdline">--log-local</span> on the command line.</p>
+            <pre>
+              <code class="language-yaml">
+                log: true
+              </code>
+            </pre>
+          </div><!-- col -->
+
+          <div class="col-lg-12 col-md-12">
+            <p><span class="yaml-tag">timestamp:</span> - timestamp the output files instead of overwriting them, defaults to FALSE (optional). Equivalent to <span class="cmdline">--timestamp</span> and <span class="cmdline">--no-timestamp</span> on the command line.</p>
+            <pre>
+              <code class="language-yaml">
+                timestamp: true
+              </code>
+            </pre>
+          </div><!-- col -->
+
+          <div class="col-lg-12 col-md-12">
+            <p><span class="yaml-tag">color:</span> - Enable or disable coloured output, defaults to TRUE (optional). Equivalent to <span class="cmdline">--color</span> and <span class="cmdline">--no-color</span> on the command line.</p>
+            <pre>
+              <code class="language-yaml">
+                color: false
+              </code>
+            </pre>
+          </div><!-- col -->
+
+          <div class="col-lg-12 col-md-12">
+            <p><span class="yaml-tag">verbose:</span> - Enable or disable Verbose mode, defaults to FALSE (optional). In this mode all the output of the git processes will be displayed to screen as will the local location and remote URL. Equivalent to <span class="cmdline">--verbose</span> and <span class="cmdline">--no-verbose</span> on the command line.</p>
+            <pre>
+              <code class="language-yaml">
+                verbose: true
+              </code>
+            </pre>
+          </div><!-- col -->
+
+          <div class="col-lg-12 col-md-12">
+            <p><span class="yaml-tag">verbose_errors:</span> - Enable or disable Verbose error reporting in the summary, defaults to FALSE (optional). If this is set to TRUE, the end-of-job summary will list all the error output lines from any failing Git processes, not just the first line. Equivalent to <span class="cmdline">--verbose-errors</span> and <span class="cmdline">--no-verbose-errors</span> on the command line.</p>
+            <pre>
+              <code class="language-yaml">
+                verbose_errors: true
+              </code>
+            </pre>
+          </div><!-- col -->
+
+          <div class="col-lg-12 col-md-12">
+            <p><span class="yaml-tag">quiet:</span> - Enable or disable Quiet mode, defaults to FALSE (optional). If this is specified then there will be nothing printed to the terminal except for fatal errors. Overrules the <span class="cmdline">--verbose</span> mode if also specified. Equivalent to <span class="cmdline">--quiet</span> and <span class="cmdline">--no-quiet</span> on the command line.</p>
+            <pre>
+              <code class="language-yaml">
+                quiet: true
+              </code>
+            </pre>
+          </div><!-- col -->
+
+          <div class="col-lg-12 col-md-12">
+            <p>Putting these together, below is an example <span class="filename">.updaterepo</span> file :</p>
+            <pre>
+              <code class="language-yaml">
+                ---
+                location:
+                - /media/myuser/git-repos
+                - /data/RepoDir
+                exceptions:
+                - ubuntu-trusty
+                - update_repo
+                log: true
+                timestamp: true
+                color: false
+                verbose: true
+                verbose_errors: true
+                quiet: false
+              </code>
+            </pre>
+          </div><!-- col -->
+
+          <div class="col-lg-12 col-md-12">
+            <h2>Command line switches</h2>
+            <p>Command line switches are not compulsory. If none are specified then the program will read from the standard configuration file <span class="filename">~/.updaterepo</span> and automatically update the specified Repositories. However, if specified then they will take precedence over options from the configuration file.</p>
+            <p>Enter <code class="language-markup">update_repo --help</code> at the command prompt to get a list of available options :</p>
+            <pre>
+              <code class="language-markup">
+                Options:
+                  -c, --color, --no-color    Use colored output (default: true)
+                  -d, --dump                 Dump a list of Directories and Git URL's to STDOUT in CSV format
+                  -p, --prune=&lt;i&gt;            Number of directory levels to remove from the --dump output. Only valid when --dump or -d specified (Default: 0)
+                  -l, --log                  Create a logfile of all program output to './update_repo.log'. Any older logs will be overwritten.
+                  -t, --timestamp            Timestamp the logfile instead of overwriting. Does nothing unless the --log option is also specified.
+                  -g, --log-local            Create the logfile in the current directory instead of in the users home directory
+                  -r, --dump-remote          Create a dump to screen or log listing all the git remote URLS found in the specified directories.
+                  -V, --verbose              Display each repository and the git output to screen
+                  -E, --verbose-errors       List all the error output from a failing command in the summary, not just the first line
+                  -q, --quiet                Run completely silent, with no output to the terminal (except fatal errors).
+                  -v, --version              Print version and exit
+                  -h, --help                 Show this message
+              </code>
+            </pre>
+          </div><!-- col -->
+
+          {{#switches}}
+          <div class="col-lg-12 col-md-12">
+            <div class="cmd-header row-header">
+              <p>{{title}}</p>
+            </div>
+            <div class="cmd-body row-body">
+              <p class="cmd-text">{{text}}</p>
+              <p class="cmd-text">{{#equivalent}}Equivalent to the <span class="yaml-tag">{{equivalent}}</span> YAML configuration file tag.{{/equivalent}}{{^equivalent}}No equivalent in the YAML Configuration file.{{/equivalent}}
+              </p>
+              <ul class="opt-list">
+                <li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">{{long-form}}</span></li>
+                <li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">{{short-form}}</span></li>
+                <li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">{{negative}}{{^negative}}None.{{/negative}}</span></li>
+                <li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">{{default}}</span></li>
+              </ul>
+            </div>
+          </div>
+          {{/switches}}
+        </div><!-- row -->
+      </div><!-- container -->
+    </section>
+    <!-- CONFIGURATION END -->
+
+    <section class="contribute" id="contribute">
+      <!-- partial:partials/_contribute.html -->
+      <!-- partial -->
+    </section>
+
+    <section class="license" id="license">
+      <!-- partial:partials/_license.html -->
+      <!-- partial -->
+    </section>
+
+<!-- partial:partials/_footer.html -->
+<!-- partial -->