makefile: Cleanup description of commit-id generation scripts

This commit is contained in:
Mark Pizzolato 2016-09-21 11:55:14 -07:00
parent e370b9e78e
commit 3e4b0af18f

View file

@ -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.