On Thu, 30 Nov 2006 10:44:48 -0800 (PST), Linus Torvalds wrote:
>
> But that only exists for a couple of man-pages, and mostly for the simple
> ones at that. And a lot of the real examples would need "real data" to
> work on, so it can't easily be done as a trivial example in a man-page, it
> really needs a tutorial to "build up" to the situation where you can then
> explain with an example what to do.
Here's a crazy idea. How about a "git tutorial" builtin or "git
example" or something that would create a repository into some useful
state for demonstrating something.
I know that I'm regularly putting stuff into emails like:
mkdir gittest
cd gittest
git init-db
echo hello > hello
git add hello
git commit -m "add hello"
git checkout -b other
echo other > other
git add other
git commit -m "add other"
git checkout master
# OK, that was just setup, here's what I want to demonstrate
git pull . other
...
So maybe if there was a command to setup a standard example
repository, ("git boilerplate", "git sandbox", "git playground" ?),
then the documentation could use that to have full-fledged examples
without having to duplicate similar setup each time.
And then there could be a way for this command to also spit out the
commands it is using to reach some state so it could even serve as a
sort of self-documenting tutorial of some sort.
Anyone interested in exploring something like that?
-Carl
Attachment:
pgpXHn6ZJNx5I.pgp
Description: PGP signature