summaryrefslogtreecommitdiff
path: root/contrib/examples/README
diff options
context:
space:
mode:
authorÆvar Arnfjörð Bjarmason <avarab@gmail.com>2018-03-25 20:46:53 (GMT)
committerJunio C Hamano <gitster@pobox.com>2018-03-26 20:48:50 (GMT)
commit49eb8d39c78f161231e63293df60f343d208f409 (patch)
tree877abb15a47d8f0185fffa0103f78a66382a02e9 /contrib/examples/README
parent90bbd502d54fe920356fa9278055dc9c9bfe9a56 (diff)
downloadgit-49eb8d39c78f161231e63293df60f343d208f409.zip
git-49eb8d39c78f161231e63293df60f343d208f409.tar.gz
git-49eb8d39c78f161231e63293df60f343d208f409.tar.bz2
Remove contrib/examples/*
There were some side discussions at Git Merge this year about how we should just update the README to tell users they can dig these up from the history if the need them, do that. Looking at the "git log" for this directory we get quite a bit more patch churn than we should here, mainly from things fixing various tree-wide issues. There's also confusion on the list occasionally about how these should be treated, "Re: [PATCH 1/4] stash: convert apply to builtin" (<CA+CzEk9QpmHK_TSBwQfEedNqrcVSBp3xY7bdv1YA_KxePiFeXw@mail.gmail.com>) being the latest example of that. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'contrib/examples/README')
-rw-r--r--contrib/examples/README23
1 files changed, 20 insertions, 3 deletions
diff --git a/contrib/examples/README b/contrib/examples/README
index 6946f3d..18bc60b 100644
--- a/contrib/examples/README
+++ b/contrib/examples/README
@@ -1,3 +1,20 @@
-These are original scripted implementations, kept primarily for their
-reference value to any aspiring plumbing users who want to learn how
-pieces can be fit together.
+This directory used to contain scripted implementations of builtins
+that have since been rewritten in C.
+
+They have now been removed, but can be retrieved from an older commit
+that removed them from this directory.
+
+They're interesting for their reference value to any aspiring plumbing
+users who want to learn how pieces can be fit together, but in many
+cases have drifted enough from the actual implementations Git uses to
+be instructive.
+
+Other things that can be useful:
+
+ * Some commands such as git-gc wrap other commands, and what they're
+ doing behind the scenes can be seen by running them under
+ GIT_TRACE=1
+
+ * Doing `git log` on paths matching '*--helper.c' will show
+ incremental effort in the direction of moving existing shell
+ scripts to C.