[elpa] --exclude-vcs for multi-file archives?

[elpa] --exclude-vcs for multi-file archives?

[Mario Lang]

Hi.

While integrating chess.el into ELPA, I noticed that the .git
subdirectory of packages/<external-name> is placed in the tarballs.  I have manually
added ".git" to .elpaignore in packages/chess for now, but I wonder if a
more generic solution is in order.  Adding --exclude-vcs to the tar call
in GNUMakefile seems like the right thing to do.  If I try, about all
the archive shrinks about 300k, so we definitely ship stuff which (IMHO)
shouldn't be shipped in a tarball.

Am I fine to commit this change, or can anyone see an actual reason why
a left-over .git directory in the release tarball might actually be needed?

diff --git a/GNUmakefile b/GNUmakefile
index 03a25f2..7d88843 100644
--- a/GNUmakefile
+++ b/GNUmakefile
@@ -54,7 +54,7 @@ process-archive:
 	      fi;						\
 	      if [ -d $$pt ]; then				\
 		  echo "Creating tarball $${pt}.tar" &&		\
-		  tar -cf $${pt}.tar $$pt -X "$$ignore";	\
+		  tar -cf $${pt}.tar $$pt --exclude-vcs -X "$$ignore";	\
 		  rm -rf $${pt}; 				\
 	      fi;						\
 	  done

-- 
CYa,
  ⡍⠁⠗⠊⠕
  

Re: [elpa] --exclude-vcs for multi-file archives?

[Stefan Monnier]

> While integrating chess.el into ELPA, I noticed that the .git
> subdirectory of packages/<external-name> is placed in the tarballs.  I have manually
> added ".git" to .elpaignore in packages/chess for now, but I wonder if a
> more generic solution is in order.

I saw your commit and thought the exact same thing.
But I don't understand why you need to do that: .git is already skipped
in update-archive.sh:

rsync -av --delete \
      --exclude=ChangeLog \
      --exclude=.git \
      --exclude='*.elc' \
      --exclude='*~' \
      --exclude='*-autoloads.el' \
      ../elpa/packages ./

So I wonder: are you using update-archive.sh, or what are you using?


        Stefan

Re: [elpa] --exclude-vcs for multi-file archives?

[Mario Lang]

Stefan Monnier <monnier@IRO.UMontreal.CA> writes:

>> While integrating chess.el into ELPA, I noticed that the .git
>> subdirectory of packages/<external-name> is placed in the tarballs.  I have manually
>> added ".git" to .elpaignore in packages/chess for now, but I wonder if a
>> more generic solution is in order.
>
> I saw your commit and thought the exact same thing.
> But I don't understand why you need to do that: .git is already skipped
> in update-archive.sh:
>
> rsync -av --delete \
>       --exclude=ChangeLog \
>       --exclude=.git \
>       --exclude='*.elc' \
>       --exclude='*~' \
>       --exclude='*-autoloads.el' \
>       ../elpa/packages ./
>
> So I wonder: are you using update-archive.sh, or what are you using?

Oh, it's a workflow issue?  I actually went the most simple way and did:
$ make externals
$ make archive

archives/packages/<external>-*.tar now contains .git dirs.

-- 
CYa,
  ⡍⠁⠗⠊⠕

Re: [elpa] --exclude-vcs for multi-file archives?

[Stefan Monnier]

> $ make archive

Where did you find a reference to this?
It's an old deprecated way to build an archive.


        Stefan

Re: [elpa] --exclude-vcs for multi-file archives?

[Mario Lang]

Stefan Monnier <monnier@iro.umontreal.ca> writes:

>> $ make archive
>
> Where did you find a reference to this?
> It's an old deprecated way to build an archive.

OK, was not aware that this method (albeit rather simple) is
deprecated.  I actually found it by skimming the GNUMakefile.

-- 
CYa,
  ⡍⠁⠗⠊⠕

Re: [elpa] --exclude-vcs for multi-file archives?

[David Kastrup]

Mario Lang <mlang@delysid.org> writes:

> Stefan Monnier <monnier@iro.umontreal.ca> writes:
>
>>> $ make archive
>>
>> Where did you find a reference to this?
>> It's an old deprecated way to build an archive.
>
> OK, was not aware that this method (albeit rather simple) is
> deprecated.  I actually found it by skimming the GNUMakefile.

If it isn't supported, it should be removed, right?  Exactly because
people will use it upon discovering it.

-- 
David Kastrup

Re: [elpa] --exclude-vcs for multi-file archives?

[Mario Lang]

David Kastrup <dak@gnu.org> writes:

> Mario Lang <mlang@delysid.org> writes:
>
>> Stefan Monnier <monnier@iro.umontreal.ca> writes:
>>
>>>> $ make archive
>>>
>>> Where did you find a reference to this?
>>> It's an old deprecated way to build an archive.
>>
>> OK, was not aware that this method (albeit rather simple) is
>> deprecated.  I actually found it by skimming the GNUMakefile.
>
> If it isn't supported, it should be removed, right?  Exactly because
> people will use it upon discovering it.

"make archive-full", which is a variant of "make archive" is called from
admin/update-archive.sh.  My error was to "ignore" the preparation steps
done within that script, and manually call the make target which is
called from within that script after preparation.  Calling "make
archive" actually does a useful job for me, except for the missing
implicit extra excludes done by the update-archive.sh.

I guess I will keep things as they are, since "make archive" is
apparently not ment to be called directly.  That's not surprising, a
make target is not automatically public interface :-)

Thanks Stefan, for explaining the situation.  And sorry for the noise.

-- 
CYa,
  ⡍⠁⠗⠊⠕

Re: [elpa] --exclude-vcs for multi-file archives?

[Stefan Monnier]

> If it isn't supported, it should be removed, right?

The alternative (based on update-archive.sh) requires a more complex
setup, which is why I didn't remove "make archive" altogether.
But yes, it should be removed since it doesn't faithfully produce the
packages that the scripts in elpa.gnu.org will produce.


        Stefan