PlantUML is a really awesome way to create diagrams by writing code instead of drawing and dragging visual elements. Markdown is a really nice documentation tool.
Here's how I combine the two, to create docs with embedded diagrams.
Get the command-line PlantUML from the download page or your relevant package manager.
If you want to get the difference between two branches, say master and branch-name, use the following command:
git diff master..branch-name
If you want that same diff in a patch, because patches are handy, just add the output redirect:
git diff master..branch-name > branch-name.patch
If you need to import that patch into something like Crucible then you'll need to get rid of the a and b prefixes that git adds:
git diff --no-prefix master..branch-name > branch-name.patch
| #################################################################################### | |
| ## ## | |
| ## gittyup() - Easily keep master in sync with upstream. ## | |
| ## ## | |
| ## Author: Evan Coury, http://blog.evan.pro/ ## | |
| ## URL: https://gist.github.com/1506822 ## | |
| ## ## | |
| ## This bash function is a simple shortcut for keeping your local (and public ## | |
| ## fork / origin remote) master branch up to date and in sync with the upstream ## | |
| ## master. To use gittyup(), simply drop this in your ~/.bashrc. ## |
