]>
git.madduck.net Git - code/vcsh.git/blobdiff - README.md
madduck's git repository
Every one of the projects in this repository is available at the canonical
URL git://git.madduck.net/madduck/pub/<projectpath> — see
each project's metadata for the exact URL.
All patches and comments are welcome. Please squash your changes to logical
commits before using git-format-patch and git-send-email to
patches@ git. madduck. net .
If you'd read over the Git project's submission guidelines and adhered to them,
I'd be especially grateful.
SSH access, as well as push access can be individually
arranged .
If you use my repositories frequently, consider adding the following
snippet to ~/.gitconfig and using the third clone URL listed for each
project:
[url "git://git.madduck.net/madduck/"]
insteadOf = madduck:
To illustrate, this is what a possible directory structure looks like.
$HOME
To illustrate, this is what a possible directory structure looks like.
$HOME
+ |-- $XDG_CONFIG_HOME (defaults to $HOME/.config)
| |-- mr
| | |-- available.d
| | | |-- zsh.vcsh
| |-- mr
| | |-- available.d
| | | |-- zsh.vcsh
-The files you see in ~/.config /mr/available.d are mr configuration files that
+The files you see in $XDG_CONFIG_HOME /mr/available.d are mr configuration files that
contain the commands to manage (checkout, update etc.) a single repository.
vcsh repo configs end in .vcsh, git configs end in .git, etc. This is optional
and your preference. For example, this is what a zsh.mrconfig with read-only
access to my zshrc repo looks likes. I.e. in this specific example, push can
not work.
contain the commands to manage (checkout, update etc.) a single repository.
vcsh repo configs end in .vcsh, git configs end in .git, etc. This is optional
and your preference. For example, this is what a zsh.mrconfig with read-only
access to my zshrc repo looks likes. I.e. in this specific example, push can
not work.
- [$HOME/.config /vcsh/repo.d/zsh.git]
- checkout = vcsh clone 'git://github.com/RichiH/zshrc.git'
- update = vcsh run ba sh git pull
- push = vcsh run ba sh git push
- status = vcsh run ba sh git status
- gc = vcsh run ba sh git gc
+ [$XDG_CONFIG_HOME /vcsh/repo.d/zsh.git]
+ checkout = vcsh clone 'git://github.com/RichiH/zshrc.git' zsh
+ update = vcsh run z sh git pull
+ push = vcsh run z sh git push
+ status = vcsh run z sh git status
+ gc = vcsh run z sh git gc
-~/.config /mr/available.d contains *all available* repositories. Only
+$XDG_CONFIG_HOME /mr/available.d contains *all available* repositories. Only
files/links present in mr/config.d, however, will be used by mr. That means
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.
files/links present in mr/config.d, however, will be used by mr. That means
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
### ~/.mrconfig ###
Finally, ~/.mrconfig will tie together all those single files which will allow
- include = cat ~/.config/mr/config.d/*
+ include = cat $XDG_CONFIG_HOME/mr/config.d/*
+
+### repo.d ###
+$XDG_CONFIG_HOME/vcsh/repo.d is the directory where all git repositories which
+are under vcsh's control are located. Since their working trees are configured
+to be in $HOME, the files contained in those repositories will be put in $HOME
+directly.
+Of course, [mr] [1] will work with this layout if configured according to this
+document (see above).
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.
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.
Below, you will find a few different methods for setting up 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
+3. 1. The Template Way
+3. 2. The Steal-from-Template Way
+3.3. The Manual Way
### 3.1 The Template Way ###
### 3.1 The Template Way ###
* ~/.gitignore
* ~/.mrconfig
* ~/.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/
+* $XDG_CONFIG_HOME /mr/available.d/mr.vcsh
+* $XDG_CONFIG_HOME /mr/available.d/zsh.vcsh
+* $XDG_CONFIG_HOME /mr/config.d/mr.vcsh
+* $XDG_CONFIG_HOME /vcsh/repo.d/mr.git/
All of the files are part of the template repository, the directory is where
the template will be stored.
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 ####
#### 3.1.2 Clone the Template ####
mv ~/.zsh ~/zsh.bak
mv ~/.zshrc ~/zshrc.bak
mv ~/.zsh ~/zsh.bak
mv ~/.zshrc ~/zshrc.bak
- cd ~/.config /mr/config.d/
+ cd $XDG_CONFIG_HOME /mr/config.d/
ln -s ../available.d/zsh.vcsh . # link, and thereby enable, the zsh repository
cd
mr up
ln -s ../available.d/zsh.vcsh . # link, and thereby enable, the zsh repository
cd
mr up
Now, it's time to edit the template config and fill it with your own remotes:
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
+ vim $XDG_CONFIG_HOME /mr/available.d/mr.vcsh
+ vim $XDG_CONFIG_HOME /mr/available.d/zsh.vcsh
And then create your own stuff:
And then create your own stuff:
vcsh run foo git commit
vcsh run foo git push
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
+ cp $XDG_CONFIG_HOME/mr/available.d/mr.vcsh $XDG_CONFIG_HOME /mr/available.d/foo.vcsh
+ vim $XDG_CONFIG_HOME /mr/available.d/foo.vcsh # add your own repo
Grab my mr config. see below for details on how I set this up
vcsh clone ssh://<remote>/mr.git
Grab my mr config. see below for details on how I set this up
vcsh clone ssh://<remote>/mr.git
- cd ~/.config /mr/config.d/
+ cd $XDG_CONFIG_HOME /mr/config.d/
~ % cat ~/.mrconfig
[DEFAULT]
~ % cat ~/.mrconfig
[DEFAULT]
- include = cat ~/.config /mr/config.d/*
+ include = cat $XDG_CONFIG_HOME /mr/config.d/*
~ % echo $XDG_CONFIG_HOME
/home/richih/.config
~ % ls $XDG_CONFIG_HOME/mr/available.d # random selection of my repos
~ % echo $XDG_CONFIG_HOME
/home/richih/.config
~ % ls $XDG_CONFIG_HOME/mr/available.d # random selection of my repos