emacs packaging (emacs-popup)

emacs packaging (emacs-popup)

[Nils Gillmann]

I'm packaging emacs-popup.

Currently the output builds with
niasterisk@khazad-dum ~/projects/guix_project/guix$ ls -al /gnu/store/knpjk9vflja0i6yhnz4ai57k29jpgm4p-emacs-popup-0.5.3/share/emacs/site-lisp/guix.d/popup-0.5.3/
total 180
dr-xr-xr-x 4 root guixbuild  4096 Jan  1  1970 ./
dr-xr-xr-x 3 root guixbuild  4096 Jan  1  1970 ../
-r--r--r-- 2 root guixbuild    90 Jan  1  1970 Cask
dr-xr-xr-x 3 root guixbuild  4096 Jan  1  1970 etc/
-r--r--r-- 2 root guixbuild    14 Jan  1  1970 .gitignore
-r--r--r-- 2 root guixbuild   626 Jan  1  1970 Makefile
-r--r--r-- 2 root guixbuild   334 Jan  1  1970 popup-autoloads.el
-r--r--r-- 2 root guixbuild 54848 Jan  1  1970 popup.el
-r--r--r-- 2 root guixbuild 75474 Jan  1  1970 popup.elc
-r--r--r-- 2 root guixbuild 10187 Jan  1  1970 README.md
dr-xr-xr-x 2 root guixbuild  4096 Jan  1  1970 tests/
-r--r--r-- 2 root guixbuild   569 Jan  1  1970 .travis.yml

Can this be improved, ie remove some of the files to clean it up,
or is it all good?
-- 
ng

Re: emacs packaging (emacs-popup)

[Federico Beffa]

Nils Gillmann <niasterisk@grrlz.net> writes:

> I'm packaging emacs-popup.
>
> Currently the output builds with
> niasterisk@khazad-dum ~/projects/guix_project/guix$ ls -al
> /gnu/store/knpjk9vflja0i6yhnz4ai57k29jpgm4p-emacs-popup-0.5.3/share/emacs/site-lisp/guix.d/popup-0.5.3/
> total 180
> dr-xr-xr-x 4 root guixbuild  4096 Jan  1  1970 ./
> dr-xr-xr-x 3 root guixbuild  4096 Jan  1  1970 ../
> -r--r--r-- 2 root guixbuild    90 Jan  1  1970 Cask
> dr-xr-xr-x 3 root guixbuild  4096 Jan  1  1970 etc/
> -r--r--r-- 2 root guixbuild    14 Jan  1  1970 .gitignore
> -r--r--r-- 2 root guixbuild   626 Jan  1  1970 Makefile
> -r--r--r-- 2 root guixbuild   334 Jan  1  1970 popup-autoloads.el
> -r--r--r-- 2 root guixbuild 54848 Jan  1  1970 popup.el
> -r--r--r-- 2 root guixbuild 75474 Jan  1  1970 popup.elc
> -r--r--r-- 2 root guixbuild 10187 Jan  1  1970 README.md
> dr-xr-xr-x 2 root guixbuild  4096 Jan  1  1970 tests/
> -r--r--r-- 2 root guixbuild   569 Jan  1  1970 .travis.yml
>
> Can this be improved, ie remove some of the files to clean it up,
> or is it all good?

I would suggest to move the README.md (and in general documentation
related files) to $datadir/doc/package-name-version/. Info files to
$datadir/info/package-name-version/. Take a look at 'emacs-slime'.

Remove unused files like .gitignore, ...

Regards,
Fede

Re: emacs packaging (emacs-popup)

[Alex Kost]

Federico Beffa (2016-02-15 15:12 +0300) wrote:

> Nils Gillmann <niasterisk@grrlz.net> writes:
>
>> I'm packaging emacs-popup.
>>
>> Currently the output builds with
>> niasterisk@khazad-dum ~/projects/guix_project/guix$ ls -al
>> /gnu/store/knpjk9vflja0i6yhnz4ai57k29jpgm4p-emacs-popup-0.5.3/share/emacs/site-lisp/guix.d/popup-0.5.3/
>> total 180
>> dr-xr-xr-x 4 root guixbuild  4096 Jan  1  1970 ./
>> dr-xr-xr-x 3 root guixbuild  4096 Jan  1  1970 ../
>> -r--r--r-- 2 root guixbuild    90 Jan  1  1970 Cask
>> dr-xr-xr-x 3 root guixbuild  4096 Jan  1  1970 etc/
>> -r--r--r-- 2 root guixbuild    14 Jan  1  1970 .gitignore
>> -r--r--r-- 2 root guixbuild   626 Jan  1  1970 Makefile
>> -r--r--r-- 2 root guixbuild   334 Jan  1  1970 popup-autoloads.el
>> -r--r--r-- 2 root guixbuild 54848 Jan  1  1970 popup.el
>> -r--r--r-- 2 root guixbuild 75474 Jan  1  1970 popup.elc
>> -r--r--r-- 2 root guixbuild 10187 Jan  1  1970 README.md
>> dr-xr-xr-x 2 root guixbuild  4096 Jan  1  1970 tests/
>> -r--r--r-- 2 root guixbuild   569 Jan  1  1970 .travis.yml
>>
>> Can this be improved, ie remove some of the files to clean it up,
>> or is it all good?
>
> I would suggest to move the README.md (and in general documentation
> related files) to $datadir/doc/package-name-version/. Info files to
> $datadir/info/package-name-version/. Take a look at 'emacs-slime'.
>
> Remove unused files like .gitignore, ...

I don't agree.  This is not done for any other emacs package.  I think
".gitignore" and other files should not be removed in a package recipe.
This is a job for emacs-build-system, and I thought it was agreed¹.  So
I think this "emacs-popup" package can be left as it is now, and once
our emacs-build-system will be improved (to remove useless file, to move
README into share/doc, etc.), it will be fixed automatically.

¹ http://lists.gnu.org/archive/html/guix-devel/2015-07/msg00416.html

-- 
Alex

Re: emacs packaging (emacs-popup)

[Nils Gillmann]

Alex Kost <alezost@gmail.com> writes:

> Federico Beffa (2016-02-15 15:12 +0300) wrote:
>
>> Nils Gillmann <niasterisk@grrlz.net> writes:
>>
>>> I'm packaging emacs-popup.
>>>
>>> Currently the output builds with
>>> niasterisk@khazad-dum ~/projects/guix_project/guix$ ls -al
>>> /gnu/store/knpjk9vflja0i6yhnz4ai57k29jpgm4p-emacs-popup-0.5.3/share/emacs/site-lisp/guix.d/popup-0.5.3/
>>> total 180
>>> dr-xr-xr-x 4 root guixbuild  4096 Jan  1  1970 ./
>>> dr-xr-xr-x 3 root guixbuild  4096 Jan  1  1970 ../
>>> -r--r--r-- 2 root guixbuild    90 Jan  1  1970 Cask
>>> dr-xr-xr-x 3 root guixbuild  4096 Jan  1  1970 etc/
>>> -r--r--r-- 2 root guixbuild    14 Jan  1  1970 .gitignore
>>> -r--r--r-- 2 root guixbuild   626 Jan  1  1970 Makefile
>>> -r--r--r-- 2 root guixbuild   334 Jan  1  1970 popup-autoloads.el
>>> -r--r--r-- 2 root guixbuild 54848 Jan  1  1970 popup.el
>>> -r--r--r-- 2 root guixbuild 75474 Jan  1  1970 popup.elc
>>> -r--r--r-- 2 root guixbuild 10187 Jan  1  1970 README.md
>>> dr-xr-xr-x 2 root guixbuild  4096 Jan  1  1970 tests/
>>> -r--r--r-- 2 root guixbuild   569 Jan  1  1970 .travis.yml
>>>
>>> Can this be improved, ie remove some of the files to clean it up,
>>> or is it all good?
>>
>> I would suggest to move the README.md (and in general documentation
>> related files) to $datadir/doc/package-name-version/. Info files to
>> $datadir/info/package-name-version/. Take a look at 'emacs-slime'.
>>
>> Remove unused files like .gitignore, ...
>
> I don't agree.  This is not done for any other emacs package.  I think
> ".gitignore" and other files should not be removed in a package recipe.
> This is a job for emacs-build-system, and I thought it was agreed¹.  So
> I think this "emacs-popup" package can be left as it is now, and once
> our emacs-build-system will be improved (to remove useless file, to move
> README into share/doc, etc.), it will be fixed automatically.
>
> ¹ http://lists.gnu.org/archive/html/guix-devel/2015-07/msg00416.html

Oh!
Thanks for the input and further reading. Then I'll look into
last changes and get a patch ready.

thanks,
-- 
ng

Re: emacs packaging (emacs-popup)

[Federico Beffa]

On Mon, Feb 15, 2016 at 5:46 PM, Alex Kost <alezost@gmail.com> wrote:
> Federico Beffa (2016-02-15 15:12 +0300) wrote:
>
>> Nils Gillmann <niasterisk@grrlz.net> writes:
>>
>>> I'm packaging emacs-popup.
>>>
>>> Currently the output builds with
>>> niasterisk@khazad-dum ~/projects/guix_project/guix$ ls -al
>>> /gnu/store/knpjk9vflja0i6yhnz4ai57k29jpgm4p-emacs-popup-0.5.3/share/emacs/site-lisp/guix.d/popup-0.5.3/
>>> total 180
>>> dr-xr-xr-x 4 root guixbuild  4096 Jan  1  1970 ./
>>> dr-xr-xr-x 3 root guixbuild  4096 Jan  1  1970 ../
>>> -r--r--r-- 2 root guixbuild    90 Jan  1  1970 Cask
>>> dr-xr-xr-x 3 root guixbuild  4096 Jan  1  1970 etc/
>>> -r--r--r-- 2 root guixbuild    14 Jan  1  1970 .gitignore
>>> -r--r--r-- 2 root guixbuild   626 Jan  1  1970 Makefile
>>> -r--r--r-- 2 root guixbuild   334 Jan  1  1970 popup-autoloads.el
>>> -r--r--r-- 2 root guixbuild 54848 Jan  1  1970 popup.el
>>> -r--r--r-- 2 root guixbuild 75474 Jan  1  1970 popup.elc
>>> -r--r--r-- 2 root guixbuild 10187 Jan  1  1970 README.md
>>> dr-xr-xr-x 2 root guixbuild  4096 Jan  1  1970 tests/
>>> -r--r--r-- 2 root guixbuild   569 Jan  1  1970 .travis.yml
>>>
>>> Can this be improved, ie remove some of the files to clean it up,
>>> or is it all good?
>>
>> I would suggest to move the README.md (and in general documentation
>> related files) to $datadir/doc/package-name-version/. Info files to
>> $datadir/info/package-name-version/. Take a look at 'emacs-slime'.
>>
>> Remove unused files like .gitignore, ...
>
> I don't agree.  This is not done for any other emacs package.  I think
> ".gitignore" and other files should not be removed in a package recipe.
> This is a job for emacs-build-system, and I thought it was agreed¹.  So
> I think this "emacs-popup" package can be left as it is now, and once
> our emacs-build-system will be improved (to remove useless file, to move
> README into share/doc, etc.), it will be fixed automatically.
>
> ¹ http://lists.gnu.org/archive/html/guix-devel/2015-07/msg00416.html

Doing so will break some packages. One example is 'emacs-slime' which
includes .lisp and .asd files, other ones are 'emacs-auctex' and
'emacs-ob-ipython', ...

While we could add a phase to remove some pretty common and useless
files such as .gitignore, in general things are not standardized and
more complex. Unless upstream fixes this situation it will be
impossible to make a perfect 'emacs-build-system'.

Checking the code to remind myself of the details, the only thing
about non .el files that it does, is to move info files to the
appropriate directory.

Regards,
Fede

Re: emacs packaging (emacs-popup)

[Alex Kost]

Federico Beffa (2016-02-16 10:58 +0300) wrote:

> On Mon, Feb 15, 2016 at 5:46 PM, Alex Kost <alezost@gmail.com> wrote:
>> Federico Beffa (2016-02-15 15:12 +0300) wrote:
[...]
>>> I would suggest to move the README.md (and in general documentation
>>> related files) to $datadir/doc/package-name-version/. Info files to
>>> $datadir/info/package-name-version/. Take a look at 'emacs-slime'.
>>>
>>> Remove unused files like .gitignore, ...
>>
>> I don't agree.  This is not done for any other emacs package.  I think
>> ".gitignore" and other files should not be removed in a package recipe.
>> This is a job for emacs-build-system, and I thought it was agreed¹.  So
>> I think this "emacs-popup" package can be left as it is now, and once
>> our emacs-build-system will be improved (to remove useless file, to move
>> README into share/doc, etc.), it will be fixed automatically.
>>
>> ¹ http://lists.gnu.org/archive/html/guix-devel/2015-07/msg00416.html
>
> Doing so will break some packages. One example is 'emacs-slime' which
> includes .lisp and .asd files, other ones are 'emacs-auctex' and
> 'emacs-ob-ipython', ...

For such packages, a potential "cleanup" phase may be removed in a
package recipe.  Also I don't think that .lisp, .asd and other files
should be placed in ".../share/emacs/site-lisp/" directory.  My
understanding is that this directory (and it's subdirs) should be used
only for elisp files.

> While we could add a phase to remove some pretty common and useless
> files such as .gitignore, in general things are not standardized and
> more complex. Unless upstream fixes this situation it will be
> impossible to make a perfect 'emacs-build-system'.

I think that most packages are simple and very similar, and "cleanup"
phase can just remove everything except *.el[c].  For the complex
packages, this phases can be removed, besides it's likely that the
manual intervention in a package recipe will be required anyway.

Anyway, I'm just talking.  Someday (I hope) I will propose patches for
improving emacs-build-system (as I see it).

-- 
Alex

Re: emacs packaging (emacs-popup)

[Federico Beffa]

On Wed, Feb 17, 2016 at 10:52 AM, Alex Kost <alezost@gmail.com> wrote:
> Also I don't think that .lisp, .asd and other files
> should be placed in ".../share/emacs/site-lisp/" directory.  My
> understanding is that this directory (and it's subdirs) should be used
> only for elisp files.

Just to be clear, Guix's 'emacs-build-system' is meant to be used with
Emacs packages and just reproduces what Emacs does with its very own
packages.  The only difference is that Guix installs files into
$profile/share/emacs/site-lisp/guix.d instead of $HOME/.emacs.d/$repo
and moves .info files into the standard location.  I've not invented
any new installation scheme here. Any change that will require manual
intervention for any package to work will simply be a regression.

Fede