From 3e4b0af18f63ab05a96b425b59ddfc1c64dd3b3c Mon Sep 17 00:00:00 2001 From: Mark Pizzolato Date: Wed, 21 Sep 2016 11:55:14 -0700 Subject: [PATCH] makefile: Cleanup description of commit-id generation scripts --- .../git-hooks/0ReadMe_git-hooks.txt | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/Visual Studio Projects/git-hooks/0ReadMe_git-hooks.txt b/Visual Studio Projects/git-hooks/0ReadMe_git-hooks.txt index d9126d78..3240f0e2 100644 --- a/Visual Studio Projects/git-hooks/0ReadMe_git-hooks.txt +++ b/Visual Studio Projects/git-hooks/0ReadMe_git-hooks.txt @@ -5,10 +5,10 @@ building simulators to uniquely identify the inputs to that build. It is ONLY useful for folks who clone this as a repository and build in the working directory of that repository. -Folks who download zip archives of the repository do not currently -have the ability to get the commit id which the archive is a snapshot -of. Work is being done to solve this issue for uses of the archive -snapshots as well. +Folks who download zip or tarball archives of the repository have the +git commit-id automatically inserted into the sim_rev.h file when the +archive is created due to a substitution performed via this repository's +.gitattributes. To use these scripts automatically, copy these files to the .git/hooks directory of the current repository. This can be done with the @@ -18,11 +18,6 @@ following commands: $ chmod +x post* $ cp post* ../../.git/hooks/ - - -Note: You ONLY need to copy these hook scripts once for a particular - clone of the repository. Once these are installed they will - survive as you pull subsequent revisions from the github repo. - - If you clone the repository to another platform, then you'll - need to copy the hooks to the .git/hooks directory again. +Note: The makefile AND the Visual Studio Projects automatically + will install these git hooks in the ../../.git/hooks/ directory + if they're not already there and execute them as needed.