git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 3/3] Makefile: optionally symlink libexec/git-core binaries to bin/git

From
Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date
Mar 14, 2018, 10:14 UTC
Message-ID
<87y3ivdkvp.fsf@evledraar.gmail.com>
In-Reply-To
<1cabf9c0-674e-c2b3-9977-9c74b929a86d@kdbg.org>
On Wed, Mar 14 2018, Johannes Sixt jotted:
Show 16 quoted lines
> Am 13.03.2018 um 21:39 schrieb Ævar Arnfjörð Bjarmason:
>> Add a INSTALL_SYMLINKS option which if enabled, changes the default
>> hardlink installation method to one where the relevant binaries in
>> libexec/git-core are symlinked back to ../../bin, instead of being
>> hardlinked.
>>
>> This new option also overrides the behavior of the existing
>> NO_*_HARDLINKS variables which in some cases would produce symlinks
>> within to libexec/, e.g. "git-add" symlinked to "git" which would be
>> copy of the "git" found in bin/, now "git-add" in libexec/ is always
>> going to be symlinked to the "git" found in the bin/ directory.
>
> It is important to leave the default at hard-linking the binaries,
> because on Windows symbolic links are second class citizens (they
> require special privileges and there is a distinction between link
> targets being files or directories). Hard links work well.

Yeah makes sense. I just want to add this as an option, and think if it's proven to be un-buggy we could probably turn it on by default on the *nix's if people prefer that, but yeah, we'll definitely need the uname detection.

Show 53 quoted lines
>>
>> This option is being added because:
>>
>>   1) I think it makes what we're doing a lot more obvious. E.g. I'd
>>      never noticed that the libexec binaries were really just hardlinks
>>      since e.g. ls(1) won't show that in any obvious way. You need to
>>      start stat(1)-ing things and look at the inodes to see what's
>>      going on.
>>
>>   2) Some tools have very crappy support for hardlinks, e.g. the Git
>>      shipped with GitLab is much bigger than it should be because
>>      they're using a chef module that doesn't know about hardlinks, see
>>      https://github.com/chef/omnibus/issues/827
>>
>>      I've also ran into other related issues that I think are explained
>
> s/ran/run/
>
>>      by this, e.g. compiling git with debugging and rpm refusing to
>>      install a ~200MB git package with 2GB left on the FS, I think that
>>      was because it doesn't consider hardlinks, just the sum of the
>>      byte size of everything in the package.
>>
>> As for the implementation, the "../../bin" noted above will vary given
>> some given some values of "../.." and "bin" depending on the depth of
>
> s/given some//
>
>> the gitexecdir relative to the destdir, and the "bindir" target,
>> e.g. setting "bindir=/tmp/git/binaries gitexecdir=foo/bar/baz" will do
>> the right thing and produce this result:
>>
>>      $ file /tmp/git/foo/bar/baz/git-add
>>      /tmp/git/foo/bar/baz/git-add: symbolic link to ../../../binaries/git
>>
>> Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
>> ---
>>   Makefile | 46 +++++++++++++++++++++++++++++++---------------
>>   1 file changed, 31 insertions(+), 15 deletions(-)
>>
>> diff --git a/Makefile b/Makefile
>> index ee0b6c8940..ac7616422d 100644
>> --- a/Makefile
>> +++ b/Makefile
>> @@ -329,6 +329,13 @@ all::
>>   # when hardlinking a file to another name and unlinking the original file right
>>   # away (some NTFS drivers seem to zero the contents in that scenario).
>>   #
>> +# Define INSTALL_SYMLINKS if you prefer to have everything that can be
>> +# symlinked between bin/ and libexec/ to use relative symlinks between
>> +# the two. This option overrides NO_CROSS_DIRECTORY_HARDLINKS and
>
> s/ between the two//
Thanks. Will fix the above in a subsequent submission.
Show 6 quoted lines
>> +# NO_INSTALL_HARDLINKS which will also use symlinking by indirection
>> +# within the same directory in some cases, INSTALL_SYMLINKS will
>> +# always symlink to the final target directly.
>
> "the final target"? Do you mean "the git executable installed in
> $bindir" or something like this?

I'm not explaining this well, but what I mean is that right now if you supply NO_INSTALL_HARDLINKS you end up with this:

    bin/git
    libexec/git
    libexec/git-add -> git

I.e. we make two copies of the "git" binary, and then just symlink within the libexec dir, whereas with this change:

    bin/git
    libexec/git -> ../bin/git
    libexec/git-add -> ../bin/git

I.e. we'll only install one "git" and never copy it, and to the extent that we need symlinking we're always going to symlink directly to the binary, i.e. not:

    bin/git
    libexec/git -> ../bin/git
    libexec/git-add -> git
Even though that would also work, I just don't think it makes sense.
Show 36 quoted lines
>> +#
>>   # Define NO_CROSS_DIRECTORY_HARDLINKS if you plan to distribute the installed
>>   # programs as a tar, where bin/ and libexec/ might be on different file systems.
>>   #
>> @@ -2594,35 +2601,44 @@ endif
>>     	bindir=$$(cd '$(DESTDIR_SQ)$(bindir_SQ)' && pwd) && \
>>   	execdir=$$(cd '$(DESTDIR_SQ)$(gitexec_instdir_SQ)' && pwd) && \
>> +	destdir_from_execdir_SQ=$$(echo '$(gitexecdir_relative_SQ)' | sed -e 's|[^/][^/]*|..|g') && \
>>   	{ test "$$bindir/" = "$$execdir/" || \
>>   	  for p in git$X $(filter $(install_bindir_programs),$(ALL_PROGRAMS)); do \
>>   		$(RM) "$$execdir/$$p" && \
>> -		test -z "$(NO_INSTALL_HARDLINKS)$(NO_CROSS_DIRECTORY_HARDLINKS)" && \
>> -		ln "$$bindir/$$p" "$$execdir/$$p" 2>/dev/null || \
>> -		cp "$$bindir/$$p" "$$execdir/$$p" || exit; \
>> +		test -n "$(INSTALL_SYMLINKS)" && \
>> +		ln -s "$$destdir_from_execdir_SQ/$(bindir_relative_SQ)/$$p" "$$execdir/$$p" || \
>> +		{ test -z "$(NO_INSTALL_HARDLINKS)$(NO_CROSS_DIRECTORY_HARDLINKS)" && \
>> +		  ln "$$bindir/$$p" "$$execdir/$$p" 2>/dev/null || \
>> +		  cp "$$bindir/$$p" "$$execdir/$$p" || exit; } \
>
> I think that it is unnecessary to place the later options in {}
> brackets because && and || have equal precedence in shell
> scripts. That is:
>
> 	want symlinks? &&
> 	make symlinks ||
> 	want hard links? &&
> 	make hard links ||
> 	make copies ||
> 	exit
>
> Of course, it means that when symlinking fails, it falls back to hard
> links (if permitted) or copies, whichever works. But that also happens
> with your version.
>
> (Ditto in the rest of the hunk, which I don't repeat here.)

Yes. This is shitty, I'll change it. I'm going to inject a patch series earlier in this series so we'll do:

 	want symlinks? &&
 	make symlinks ||
 	want hard links? &&
 	make hard links ||
 	want copy fallback? &&
 	make copies ||
 	exit

And then turn on the copy fallback by default. Right now we'll silently hide errors during "make install", which isn't nice. I'll leave the fallback on by default (for now), but I'd like to declare that I want to install symlinks, and if that fails I should get an error, not a silent fallback to copy.

Previous: Johannes SixtNext: Linus Torvalds
Message 12 of 53 in “What's cooking in git.git (Mar 2018, #02; Tue, 6)”
  1. Junio C HamanoMar 6, 2018
  2. Johannes SchindelinMar 7, 2018
  3. Ævar Arnfjörð BjarmasonMar 8, 2018
  4. Daniel JacquesMar 8, 2018
  5. Why don't we symlink libexec/git-core/* to bin/git?Ævar Arnfjörð Bjarmason, Mar 13, 2018
  6. Junio C HamanoMar 13, 2018
  7. Randall S. BeckerMar 13, 2018
  8. 0/3 Makefile: add a INSTALL_SYMLINKS optionÆvar Arnfjörð Bjarmason, Mar 13, 2018
  9. 1/3 Makefile: fix broken bindir_relative variableÆvar Arnfjörð Bjarmason, Mar 13, 2018
  10. 3/3 Makefile: optionally symlink libexec/git-core binaries to bin/gitÆvar Arnfjörð Bjarmason, Mar 13, 2018
  11. Johannes SixtMar 14, 2018
  12. Ævar Arnfjörð BjarmasonMar 14, 2018
  13. Linus TorvaldsMar 14, 2018
  14. Johannes SchindelinMar 15, 2018
  15. Linus TorvaldsMar 15, 2018
  16. Johannes SchindelinMar 16, 2018
  17. Ævar Arnfjörð BjarmasonMar 16, 2018
  18. Johannes SchindelinMar 19, 2018
  19. Linus TorvaldsMar 19, 2018
  20. 0/5 stop installing old libexec aliases like "git-init"Ævar Arnfjörð Bjarmason, Nov 2, 2018
  21. Junio C HamanoNov 3, 2018
  22. Ævar Arnfjörð BjarmasonNov 5, 2018
  23. Johannes SchindelinNov 12, 2018
  24. Ævar Arnfjörð BjarmasonNov 16, 2018
  25. Michael HaggertyNov 16, 2018
  26. Ævar Arnfjörð BjarmasonNov 16, 2018
  27. Jeff KingNov 17, 2018
  28. Johannes SchindelinNov 22, 2018
  29. Jeff KingNov 22, 2018
  30. Johannes SchindelinNov 23, 2018
  31. 1/5 Makefile: move long inline shell loops in "install" into helperÆvar Arnfjörð Bjarmason, Nov 2, 2018
  32. Eric SunshineNov 4, 2018
  33. Johannes SchindelinNov 12, 2018
  34. Ævar Arnfjörð BjarmasonNov 12, 2018
  35. Johannes SchindelinNov 12, 2018
  36. Ævar Arnfjörð BjarmasonNov 16, 2018
  37. 2/5 Makefile: conform some of the code to our coding standardsÆvar Arnfjörð Bjarmason, Nov 2, 2018
  38. 3/5 Makefile: stop hiding failures during "install"Ævar Arnfjörð Bjarmason, Nov 2, 2018
  39. 4/5 Makefile: add NO_INSTALL_SYMLINKS_FALLBACK switchÆvar Arnfjörð Bjarmason, Nov 2, 2018
  40. Eric SunshineNov 4, 2018
  41. 5/5 Makefile: Add a NO_INSTALL_BUILTIN_EXECDIR_ALIASES flagÆvar Arnfjörð Bjarmason, Nov 2, 2018
  42. Eric SunshineNov 4, 2018
  43. Johannes SchindelinNov 12, 2018
  44. Johannes SchindelinMar 15, 2018
  45. 2/3 Makefile: add a gitexecdir_relative variableÆvar Arnfjörð Bjarmason, Mar 13, 2018
  46. Ævar Arnfjörð BjarmasonMar 14, 2018
  47. Junio C HamanoMar 14, 2018
  48. Johannes SchindelinMar 15, 2018
  49. Duy NguyenMar 16, 2018
  50. Johannes SchindelinMar 30, 2018
  51. Martin ÅgrenMar 9, 2018
  52. Duy NguyenMar 9, 2018
  53. Junio C HamanoMar 9, 2018

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.