From 7f239a38aa406a2328a237f5af7dc03f45fc8751 Mon Sep 17 00:00:00 2001 From: Gernot Schulz Date: Thu, 17 Nov 2011 14:07:22 +0100 Subject: [PATCH] Merge EXAMPLES into README, restructure, some corrections --- EXAMPLES.md | 167 ------------------------------------- README.md | 234 +++++++++++++++++++++++++++++++++++++++++++++++----- 2 files changed, 212 insertions(+), 189 deletions(-) delete mode 100644 EXAMPLES.md diff --git a/EXAMPLES.md b/EXAMPLES.md deleted file mode 100644 index 16db617..0000000 --- a/EXAMPLES.md +++ /dev/null @@ -1,167 +0,0 @@ -# Getting started with vcsh # - -Below, you will find a few different methods for setting up vcsh: - -1. The template way -2. The steal-from-template way -3. The manual way -4. Using vcsh without mr - -# 1. The template way # - -## 1.1 Prerequisites ## - -Make sure none of the following files/diretories exist for your test (user). If -they do, move them away for now: - -* ~/.gitignore -* ~/.mrconfig -* ~/.config/mr/available.d/mr.vcsh -* ~/.config/mr/available.d/zsh.vcsh -* ~/.config/mr/config.d/mr.vcsh -* ~/.config/vcsh/repo.d/mr.git/ - -All of the files are part of the template repository, the directory is where -the template will be stored. - - apt-get install mr # this is optional, but highly recommended - -## 1.2 Clone the template ## - - mkdir -p ~/work/git - cd !$ - git clone git://github.com/RichiH/vcsh.git vcsh - cd vcsh - ln -s vcsh /usr/local/bin # or add it to your PATH - cd - vcsh clone git://github.com/RichiH/vcsh_mr_template.git mr.vcsh - -## 1.3 Enable your test repository ## - - mv ~/.zsh ~/zsh.bak - mv ~/.zshrc ~/zshrc.bak - cd ~/.config/mr/config.d/ - ln -s ../available.d/zsh.vcsh . # link, and thereby enable, the zsh repository - cd - mr up - -## 1.4 Set up your own repositories ## - -Now, it's time to edit the template config and fill it with your own remotes: - - vim .config/mr/available.d/mr.vcsh - vim .config/mr/available.d/zsh.vcsh - -And then create your own stuff: - - vcsh init foo - vcsh run foo git add -f bar baz quux - vcsh run foo git remote add origin git://quuux - vcsh run foo git commit - vcsh run foo git push - - cp .config/mr/available.d/mr.vcsh .config/mr/available.d/foo.vcsh - vim .config/mr/available.d/foo.vcsh # add your own repo - -Done! - -## 1.5 Daily use ## - -### 1.5.1 Keeping repositories up-to-date ### - -This is the beauty of it all. Once you are set up, just run: - - mr up - mr push - -Neat. - -### 1.5.2 Making changes ### - -After you have made some changes, for which you would normally use `git add` -and `git commit`, use the vcsh wrapper (like above): - - vcsh run foo git add -f bar baz quux - vcsh run foo git commit - vcsh run foo git push - -By the way, you'll have to use -f/--force flag with git-add because all files -will be ignored by default. This is to show you only useful output when running -git-status. A fix for this problem is being worked on. - - -# 2. The steal-from-template way # - -You're welcome to clone the example repository: - - git clone git://github.com/RichiH/vcsh_mr_template.git - -Look around in the clone. It should be reasonably simple to understand. If not, -poke me, RichiH, on Freenode (query) or OFTC (#vcs-home). - - -# 3. The manual way # - -This is how my old setup procedure looked like. Adapt it to your own style or -copy mine verbatim, either is fine. - - # Create workspace - mkdir -p ~/work/git - cd !$ - - # Clone vcsh and make it available - git clone git://github.com/RichiH/vcsh.git vcsh - sudo ln -s ~/work/git/vcsh/vcsh /usr/bin/local - hash -r - -Grab my mr config. see below for details on how I set this up - - vcsh clone ssh:///mr.git - cd ~/.config/mr/config.d/ - ln -s ../available.d/* . - - -mr is used to actually retrieve configs, etc - - ~ % cat ~/.mrconfig - [DEFAULT] - include = cat ~/.config/mr/config.d/* - ~ % echo $XDG_CONFIG_HOME - /home/richih/.config - ~ % ls $XDG_CONFIG_HOME/mr/available.d # random selection of my repos - git-annex gitk.vcsh git.vcsh ikiwiki mr.vcsh reportbug.vcsh snippets.git wget.vcsh zsh.vcsh - ~ % - # then simply ln -s whatever you want on your local machine from - # $XDG_CONFIG_HOME/mr/available.d to $XDG_CONFIG_HOME/mr/config.d - ~ % cd - ~ % mr -j 5 up - -# 4. Using vcsh without mr # - -vcsh encourages you to use mr. It helps you manage a large number of -repositories by running the necessary vcsh commands for you. You may choose not -to use mr, in which case you will have to run those commands manually or by -other means. - -## 4.1 A few examples ## - -To initialize a new repository: `vcsh init zsh` - -To clone a repository: `vcsh clone ssh:///zsh.git` - -To interact with a repository, use the regular Git commands, but prepend them -with `vcsh run $repository_name`. For example: - - vcsh run zsh git status - vcsh run zsh git add -f .zshrc - vcsh run zsh git commit - -Obviously, without mr keeping repositories up-to-date, it will have to be done -manually. Alternatively, you could try something like this: - - for repo in `vcsh list`; do - vcsh run $repo git pull; - done - ----------- -Questions? RichiH@{Freenode,OFTC,IRCnet} diff --git a/README.md b/README.md index a02ba66..6c59618 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,31 @@ vcsh - manage and sync config files via git -# Introduction # +# Index # + +1. Introduction +2. Overview +3. Getting Started +4. Usage + +# 1 Introduction # vcsh allows you to have several git repositories, all maintaining their working trees in $HOME without clobbering each other. That, in turn, means you can have one repository per config set (zsh, vim, ssh, etc), picking and choosing which configs you want to use on which machine. -vcsh was designed with mr [1] in mind so you might want to install that, as +vcsh was designed with [mr] [1] in mind so you might want to install that, as well. Read INSTALL.md for detailed setup instructions. -Questions? RichiH@{Freenode,OFTC,IRCnet} +The following overview will try to give you an idea of the use cases and +advantages of vcsh. See sections 3 and 4 for detailed instructions and +examples. + +# 2 Overview -## Comparison to Other Solutions ## +## 2.1 Comparison to Other Solutions ## Most people who decide to put their dotfiles under version control start with a **single repository in $HOME**, adding all their dotfiles (and possibly more) @@ -33,11 +44,11 @@ you try to manage more than two hosts. to ~/.dotfiles). However, it does not create symbolic links in $HOME; it puts the **actual files right into $HOME**. -Furthermore, by making use of mr [1], it makes it very easy to enable/disable -and clone a large number of repositories. The use of mr is technically -optional, but it will be an integral part of the proposed system that follows. +Furthermore, by making use of [mr] [1], it makes it very easy to enable/disable +and clone a large number of repositories. The use of mr is technically optional +(see 3.4), but it will be an integral part of the proposed system that follows. -## Default Directory Layout ## +## 2.2 Default Directory Layout ## To illustrate, this is what a possible directory structure looks like. @@ -55,10 +66,10 @@ To illustrate, this is what a possible directory structure looks like. | | | |-- vimperator.vcsh | | | `-- snippets.git | | `-- config.d - | | |-- zsh.mrconfig -> ../available.d/zsh.mrconfig - | | |-- gitconfigs.mrconfig -> ../available.d/gitconfigs.mrconfig - | | |-- tmux.mrconfig -> ../available.d/tmux.mrconfig - | | `-- vim.mrconfig -> ../available.d/vim.mrconfig + | | |-- zsh.vcsh -> ../available.d/zsh.vcsh + | | |-- gitconfigs.vcsh -> ../available.d/gitconfigs.vcsh + | | |-- tmux.vcsh -> ../available.d/tmux.vcsh + | | `-- vim.vcsh -> ../available.d/vim.vcsh | `-- vcsh | `-- repo.d | |-- zsh.git -----------+ @@ -71,11 +82,7 @@ To illustrate, this is what a possible directory structure looks like. |-- .mrconfig `-- .mrtrust -In this setup, ~/.mrconfig looks like: - - [DEFAULT] - jobs = 5 - include = cat ~/.config/mr/config.d/* +### available.d ### The files you see in ~/.config/mr/available.d are mr configuration files that contain the commands to manage (checkout, update etc.) a single repository. @@ -86,9 +93,12 @@ not work. [$HOME/.config/vcsh/repo.d/zsh.git] checkout = vcsh clone 'git://github.com/RichiH/zshrc.git' - update = vcsh run bash git pull - push = vcsh run bash git push - status = vcsh run bash git status + update = vcsh run bash git pull + push = vcsh run bash git push + status = vcsh run bash git status + gc = vcsh run bash git gc + +### config.d ### ~/.config/mr/available.d contains *all available* repositories. Only files/links present in mr/config.d, however, will be used by mr. That means @@ -96,17 +106,30 @@ that in this example, only the zsh, gitconfigs, tmux and vim repositories will be checked out. A simple `mr update` run in $HOME will clone or update those four repositories listed in config.d. +### repo.d ### + ~/.config/vcsh/repo.d is the directory into which vcsh clones the git repositories. Since their working trees are configured to be in $HOME, the files contained in those repositories will be put in $HOME directly (see .zshrc above). +### ~/.mrconfig ### + +Finally, ~/.mrconfig will tie together all those single files which will allow +you to conveniently run `mr up` etc. to manage all repositories. It looks like +this: + + [DEFAULT] + jobs = 5 + include = cat ~/.config/mr/config.d/* + + vcsh will check if any file it would want to create exists. If it exists, vcsh will throw a warning and exit. Move away your old config and try again. Optionally, merge your local and your global configs afterwards and push with `vcsh run foo git push`. -## Moving into a New Host ## +## 2.3 Moving into a New Host ## To illustrate further, the following steps could move your desired configuration to a new host. @@ -124,6 +147,173 @@ Hopefully the above could help explain how this approach saves time by (thanks to mr) and 2. making it unnecessary to create symbolic links in $HOME (thanks to vcsh). +If you want to give vcsh a try, follow the instructions below. + +# 3 Getting Started # + +Below, you will find a few different methods for setting up vcsh: + +1. The Template Way +2. The Steal-from-Template Way +3. The Manual Way + +### 3.1 The Template Way ### + +#### 3.1.1 Prerequisites #### + +Make sure none of the following files and directories exist for your test +(user). If they do, move them away for now: + +* ~/.gitignore +* ~/.mrconfig +* ~/.config/mr/available.d/mr.vcsh +* ~/.config/mr/available.d/zsh.vcsh +* ~/.config/mr/config.d/mr.vcsh +* ~/.config/vcsh/repo.d/mr.git/ + +All of the files are part of the template repository, the directory is where +the template will be stored. + + apt-get install mr # this is optional, but highly recommended + +#### 3.1.2 Clone the Template #### + + mkdir -p ~/work/git + cd !$ + git clone git://github.com/RichiH/vcsh.git vcsh + cd vcsh + ln -s vcsh /usr/local/bin # or add it to your PATH + cd + vcsh clone git://github.com/RichiH/vcsh_mr_template.git mr.vcsh + +#### 3.1.3 Enable Your Test Repository #### + + mv ~/.zsh ~/zsh.bak + mv ~/.zshrc ~/zshrc.bak + cd ~/.config/mr/config.d/ + ln -s ../available.d/zsh.vcsh . # link, and thereby enable, the zsh repository + cd + mr up + +#### 3.1.4 Set Up Your Own Repositories #### + +Now, it's time to edit the template config and fill it with your own remotes: + + vim .config/mr/available.d/mr.vcsh + vim .config/mr/available.d/zsh.vcsh + +And then create your own stuff: + + vcsh init foo + vcsh run foo git add -f bar baz quux + vcsh run foo git remote add origin git://quuux + vcsh run foo git commit + vcsh run foo git push + + cp .config/mr/available.d/mr.vcsh .config/mr/available.d/foo.vcsh + vim .config/mr/available.d/foo.vcsh # add your own repo + +Done! + +### 3.2 The Steal-from-Template Way ### + +You're welcome to clone the example repository: + + git clone git://github.com/RichiH/vcsh_mr_template.git + +Look around in the clone. It should be reasonably simple to understand. If not, +poke me, RichiH, on Freenode (query) or OFTC (#vcs-home). + + +### 3.3 The Manual Way ### + +This is how my old setup procedure looked like. Adapt it to your own style or +copy mine verbatim, either is fine. + + # Create workspace + mkdir -p ~/work/git + cd !$ + + # Clone vcsh and make it available + git clone git://github.com/RichiH/vcsh.git vcsh + sudo ln -s ~/work/git/vcsh/vcsh /usr/bin/local + hash -r + +Grab my mr config. see below for details on how I set this up + + vcsh clone ssh:///mr.git + cd ~/.config/mr/config.d/ + ln -s ../available.d/* . + + +mr is used to actually retrieve configs, etc + + ~ % cat ~/.mrconfig + [DEFAULT] + include = cat ~/.config/mr/config.d/* + ~ % echo $XDG_CONFIG_HOME + /home/richih/.config + ~ % ls $XDG_CONFIG_HOME/mr/available.d # random selection of my repos + git-annex gitk.vcsh git.vcsh ikiwiki mr.vcsh reportbug.vcsh snippets.git wget.vcsh zsh.vcsh + ~ % + # then simply ln -s whatever you want on your local machine from + # $XDG_CONFIG_HOME/mr/available.d to $XDG_CONFIG_HOME/mr/config.d + ~ % cd + ~ % mr -j 5 up + +# 4 Usage # + +### 4.1 Keeping repositories Up-to-Date ### + +This is the beauty of it all. Once you are set up, just run: + + mr up + mr push + +Neat. + +### 4.1 Making Changes ### + +After you have made some changes, for which you would normally use `git add` +and `git commit`, use the vcsh wrapper (like above): + + vcsh run foo git add -f bar baz quux + vcsh run foo git commit + vcsh run foo git push + +By the way, you'll have to use -f/--force flag with git-add because all files +will be ignored by default. This is to show you only useful output when running +git-status. A fix for this problem is being worked on. + +### 4.3 Using vcsh without mr ### + +vcsh encourages you to use mr. It helps you manage a large number of +repositories by running the necessary vcsh commands for you. You may choose not +to use mr, in which case you will have to run those commands manually or by +other means. + +#### A Few Examples #### + +To initialize a new repository: `vcsh init zsh` + +To clone a repository: `vcsh clone ssh:///zsh.git` + +To interact with a repository, use the regular Git commands, but prepend them +with `vcsh run $repository_name`. For example: + + vcsh run zsh git status + vcsh run zsh git add -f .zshrc + vcsh run zsh git commit + +Obviously, without mr keeping repositories up-to-date, it will have to be done +manually. Alternatively, you could try something like this: + + for repo in `vcsh list`; do + vcsh run $repo git pull; + done + ---------- -[1] http://kitenet.net/~joey/code/mr/ +mr can be found at: [http://kitenet.net/~joey/code/mr/][1] + +[1]: http://kitenet.net/~joey/code/mr/ (http://kitenet.net/~joey/code/mr/) -- 2.39.2