GNU bug report logs - #48126
[PATCH] Add package for vim-solarized

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 48126 in the body.
You can then email your comments to 48126 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Tissevert <tissevert+guix <at> marvid.fr>
To: guix-patches <at> gnu.org
Subject: [PATCH] Add package for vim-solarized
Date: Fri, 30 Apr 2021 19:42:35 +0200

[Message part 1 (text/plain, inline)]

Hi Guix !

I here's my first attempt at packaging something, I noticed that vim-solarized
was missing so I tried to write a package for it.

The only warning I got was from the guix lint which told me it couldn't find
upstream releases. I believe this is due to vim-solarized particular structure:
it's a light «clone» of the main repository
https://github.com/altercation/solarized containing only the vim-files. It
doesn't have any tags/releases but the full repository does. I used the latest
commit on the master branch in git-reference for guix to retrieve it and the
corresponding version on the full repository as package version. Does that seem
right ? I found another copy in project vim-scripts
(https://github.com/vim-scripts/Solarized) which has made a tag (the same
version name that I chose) so we could be using either the full repository
(more unneeded data retrieved during the build) or this second copy (they do
provide a tag but isn't it better to remain as close as possible to the
original source ?).

I hope my patch is correct and thank you everyone for being such a welcoming
community and having made my experience with Guix so far absolutely great !

Tissevert

[0001-Add-package-for-vim-solarized.patch (text/x-patch, attachment)]

Message #8 received at 48126 <at> debbugs.gnu.org (full text, mbox):

From: Tissevert <tissevert+guix <at> marvid.fr>
To: 48126 <at> debbugs.gnu.org
Subject: [PATCH] Add package for vim-solarized
Date: Fri, 30 Apr 2021 22:44:18 +0200

Hello again,

I'm sorry I've just noticed that I set the wrong license in my package, I
hadn't checked it at the time when I first wrote it and forgot to edit it today
when I cleaned and sent it. Trouble is, I have no idea what the actual license is:

From Ethan Schoonover's original repository[1] it seems to be the MIT license but

- I can't find it in guix/license.scm, is that even an admissible free license ?
- The existing emacs-solarized-theme[2] package shipped with guix is distributed
  under a gpl3 license ?! (how is that possible ? can one redistribute software
  under a different license than its original one ? I assume it's because
  solarized-emacs is builds on solarized but adds something more ?) Then, I see
  that the main solarized repository imported an emacs theme[3] (a different one
  it seems) and put it under the MIT license as well…

Can we distribute vim-solarized ? If yes, under what license ? If not, do I
have to build a separate independant vim color theme for solarized and version
it under a free license like bbatsov did ?

[1]: https://github.com/altercation/solarized
[2]: https://github.com/bbatsov/solarized-emacs
[3]: https://github.com/altercation/solarized/tree/master/emacs-colors-solarized

Tissevert

Message #11 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Tobias Geerinckx-Rice <me <at> tobias.gr>
To: Tissevert <tissevert+guix <at> marvid.fr>
Cc: guix-patches <at> gnu.org, 48126 <at> debbugs.gnu.org
Subject: Re: [bug#48126] [PATCH] Add package for vim-solarized
Date: Sat, 01 May 2021 00:06:06 +0200

[Message part 1 (text/plain, inline)]

Hullo greensleeves,

Don't worry; the package is free.

Tissevert 写道：
> From Ethan Schoonover's original repository[1] it seems to be 
> the MIT license but
>
> - I can't find it in guix/license.scm, is that even an 
> admissible free license ?

Yes.  It's available as ‘expat’.  See the third paragraph of [0].

> - The existing emacs-solarized-theme[2] package shipped with 
> guix is distributed
>   under a gpl3 license ?! (how is that possible ? can one 
>   redistribute software
>   under a different license than its original one ?

Yes, you can combine (say) MIT/Expat-licenced software with (say) 
GPL-3 software and redistribute the combination as (say) GPL-3. 
You can also add your own or others' GPL-3 code to existing Expat 
software.  The modified result is GPL-3.

In both cases, the original Expat software doesn't go away, but at 
least people can't use the GPL-3 portions to restrict others' 
freedom.

Kind regards,

T G-R

[0]: 
https://en.wikipedia.org/wiki/MIT_License#Minor_ambiguity_and_variants

[signature.asc (application/pgp-signature, inline)]

Message #17 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Tobias Geerinckx-Rice <me <at> tobias.gr>
To: Tissevert <tissevert+guix <at> marvid.fr>
Cc: guix-patches <at> gnu.org, 48126 <at> debbugs.gnu.org
Subject: Re: [bug#48126] [PATCH] Add package for vim-solarized
Date: Sat, 01 May 2021 01:20:30 +0200

[Message part 1 (text/plain, inline)]

Tissevert 写道：
> I here's my first attempt at packaging something, I noticed that 
> vim-solarized
> was missing so I tried to write a package for it.

Thank you!

>
> The only warning I got was from the guix lint which told me it 
> couldn't find
> upstream releases. I believe this is due to vim-solarized 
> particular structure:
> it's a light «clone» of the main repository
> https://github.com/altercation/solarized containing only the 
> vim-files.

Hmm.  Could we install from this authoritative(?) source instead, 
even if the download's bigger?

> (https://github.com/vim-scripts/Solarized) which has made a tag 
> (the same
> version name that I chose) so we could be using either the full 
> repository
> (more unneeded data retrieved during the build) or this second 
> copy (they do
> provide a tag but isn't it better to remain as close as possible 
> to the
> original source ?).

Oh, I think we agree.  :-)

/tmp λ git clone --depth=1 
https://github.com/vim-scripts/Solarized
Cloning into 'Solarized' [...]
/tmp λ git clone --depth=1 
https://github.com/altercation/solarized
Cloning into 'solarized' [...]
/tmp λ du -hs [Ss]olarized
196K	Solarized
30M	solarized

The relative difference is huge but I think 30M is worth it.

Could you make this change, test, and send a V2?  I'm no adherent 
of the Vim.

> I hope my patch is correct and thank you everyone for being such 
> a welcoming
> community and having made my experience with Guix so far 
> absolutely great !

Thank you!  We try to do our best...

Your patch is great.  I'd make the following tweaks before 
committing.  You can incorporate them into your V2 if you want.

The description should explain what the package is to someone 
who's never heard of it.  We actually recommend ~10 lines (more is 
fine), although many existing packages don't meet that bar.  The 
synopsis should do the same in one line.

Don't be afraid to temper fawning upstream marketing-speak and 
empty taglines like this one.  That doesn't mean it can't be 
positive (like mine -- I hate Solarized).

C-M-q reindented the source field according to the same rules as 
etc/indent-code.el.  Better to do so before committing it, so 
future committers can just run C-M-q on the entire expression 
without creating unrelated whitespace noise.

diff --git a/gnu/packages/vim.scm b/gnu/packages/vim.scm
index 477c15b9aa..ad95724c41 100644
--- a/gnu/packages/vim.scm
+++ b/gnu/packages/vim.scm
@@ -585,24 +585,33 @@ are detected, the user is notified.")
    (name "vim-solarized")
    (version "v1.0.0beta1")
    (source
-      (origin
-        (method git-fetch)
-        (uri (git-reference
-               (url 
               "https://github.com/altercation/vim-colors-solarized")
-               (commit 
               "528a59f26d12278698bb946f8fb82a63711eec21")))
-        (file-name (git-file-name name version))
-        (sha256
-         (base32
- 
          "05d3lmd1shyagvr3jygqghxd3k8a4vp32723fvxdm57fdrlyzcm1"))))
+     (origin
+       (method git-fetch)
+       (uri (git-reference
+             (url 
"https://github.com/altercation/vim-colors-solarized")
+             (commit 
"528a59f26d12278698bb946f8fb82a63711eec21")))
+       (file-name (git-file-name name version))
+       (sha256
+        (base32 
"05d3lmd1shyagvr3jygqghxd3k8a4vp32723fvxdm57fdrlyzcm1"))))
    (build-system copy-build-system)
    (arguments
     '(#:install-plan
       '(("colors" "share/vim/vimfiles/")
         ("doc" "share/vim/vimfiles/"))))
    (home-page 
    "https://github.com/altercation/vim-colors-solarized")
-    (synopsis "Solarized Colorscheme for Vim")
-    (description "Precision colors for machines and people")
-    (license license:bsd-3)))
+    (synopsis "Solarized color scheme for Vim")
+    (description
+     "Solarized is a sixteen-color palette of eight monotones and 
eight accent
+colors.  It was designed for use with both terminal and GUI 
applications.
+
+Black text on white from a computer display is akin to reading a 
book in direct
+sunlight and can tire the eye.  Solarized reduces brightness 
contrast but,
+unlike many low-contrast color schemes, retains contrasting hues 
based on
+color wheel relations for syntax highlighting readability.
+
+Solarized retains the same selective contrast relationships and 
overall feel
+when switching between the light and dark background modes.")
+    (license license:expat)))

Kind regards,

T G-R

[signature.asc (application/pgp-signature, inline)]

Message #23 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Tobias Geerinckx-Rice <me <at> tobias.gr>
To: Tissevert <tissevert+guix <at> marvid.fr>
Cc: guix-patches <at> gnu.org, 48126 <at> debbugs.gnu.org
Subject: Re: [bug#48126] [PATCH] Add package for vim-solarized
Date: Sat, 01 May 2021 01:27:19 +0200

[Message part 1 (text/plain, inline)]

Well that diff got börked to hell.  Here it is again.

Kind regards,

T G-R

[d (application/octet-stream, attachment)]

[signature.asc (application/pgp-signature, inline)]

Message #29 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Tissevert <tissevert+guix <at> marvid.fr>
To: Tobias Geerinckx-Rice <me <at> tobias.gr>
Cc: guix-patches <at> gnu.org, 48126 <at> debbugs.gnu.org
Subject: Re: [bug#48126] [PATCH] Add package for vim-solarized
Date: Tue, 4 May 2021 22:56:27 +0200

[Message part 1 (text/plain, inline)]

Hello !

Thanks a lot for all your feedback.

It took me a little while but I think I've improved my first patch proposal. I
had tried to indent the code automatically like mentioned in the video tutorial
using etc/indent-code.el but obviously this had failed. Maybe I overwrote the
changes with vim ? Anyway, I tried doing it again but there are many other
badly indented blocks in the rest of the file so it is hard to do and retain
only what is in my new package. So I've done it twice during the process, but
it could still be a little weird.

I changed the source to use the main «heavy» repos, and since it has a release
tag but the actual commit corresponding to this tag is a little behind the
current state (I checked the diff, it has changes to the vim files, not just
the documentation) so I used the latest commit as target to be sure the most
recent changes were included in the package even though I still call it by the
name of the most recent tag.

So here goes.

Kind regards,

Tissevert


Le Sat, May 01, 2021 at 01:27:19AM +0200, Tobias Geerinckx-Rice a écrit :
> Well that diff got börked to hell.  Here it is again.
> 
> Kind regards,
> 
> T G-R
> 

[0001-Update-version-indentation-and-description.patch (text/plain, attachment)]

Message #35 received at 48126 <at> debbugs.gnu.org (full text, mbox):

From: Tissevert <tissevert+guix <at> marvid.fr>
To: 48126 <at> debbugs.gnu.org
Cc: Tobias Geerinckx-Rice <me <at> tobias.gr>
Subject: Re: [bug#48126] [PATCH] Add package for vim-solarized
Date: Fri, 14 May 2021 19:10:28 +0200

[Message part 1 (text/plain, inline)]

Hey,

This time I think the 2nd version of the patch has the right format. Actually
it's kind of a 3rd version because there was still an indentation problem (tabs
had creeped undected as far as my package's description) and a repetition in
the text.

And I have no idea why using etc/indent-code.el had broken the whole file last
time, it's worked fine and has modified only my region this time. So, it was
still useful practice for me : ) And I really hope it's good this time : )

Kind regards,

Tissevert

Le Tue, May 04, 2021 at 10:56:27PM +0200, Tissevert a écrit :
> Hello !
> 
> Thanks a lot for all your feedback.
> 
> It took me a little while but I think I've improved my first patch proposal. I
> had tried to indent the code automatically like mentioned in the video tutorial
> using etc/indent-code.el but obviously this had failed. Maybe I overwrote the
> changes with vim ? Anyway, I tried doing it again but there are many other
> badly indented blocks in the rest of the file so it is hard to do and retain
> only what is in my new package. So I've done it twice during the process, but
> it could still be a little weird.
> 
> I changed the source to use the main «heavy» repos, and since it has a release
> tag but the actual commit corresponding to this tag is a little behind the
> current state (I checked the diff, it has changes to the vim files, not just
> the documentation) so I used the latest commit as target to be sure the most
> recent changes were included in the package even though I still call it by the
> name of the most recent tag.
> 
> So here goes.
> 
> Kind regards,
> 
> Tissevert
> 
> 

[0001-Add-package-for-vim-solarized.patch (text/plain, attachment)]

Message #38 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Thiago Jung Bauermann <bauermann <at> kolabnow.com>
To: 48126 <at> debbugs.gnu.org, guix-patches <at> gnu.org
Cc: Tobias Geerinckx-Rice <me <at> tobias.gr>, Tissevert <tissevert+guix <at> marvid.fr>
Subject: Re: [bug#48126] [PATCH] Add package for vim-solarized
Date: Fri, 14 May 2021 15:25:44 -0300

Hello Tissevert,

Em sexta-feira, 14 de maio de 2021, às 14:10:28 -03, Tissevert escreveu:
> Hey,
> 
> This time I think the 2nd version of the patch has the right format.
> Actually it's kind of a 3rd version because there was still an
> indentation problem (tabs had creeped undected as far as my package's
> description) and a repetition in the text.
> 
> And I have no idea why using etc/indent-code.el had broken the whole file
> last time, it's worked fine and has modified only my region this time.
> So, it was still useful practice for me : ) And I really hope it's good
> this time : )

I can't comment on the package itself, but I hope you don't mind me 
pointing out a minor nit:

> +       "Solarized is a 16-color palette comprising 8 monotones and 8
> accent +colors.  It was designed for use with both terminal and GUI
> applicatins, and +has a dark and a light mode.

Typo: applications

-- 
Thanks,
Thiago

Message #44 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Tissevert <tissevert+guix <at> marvid.fr>
To: 48126 <at> debbugs.gnu.org, guix-patches <at> gnu.org
Cc: Tobias Geerinckx-Rice <me <at> tobias.gr>,
 Thiago Jung Bauermann <bauermann <at> kolabnow.com>
Subject: Re: [bug#48126] [PATCH] Add package for vim-solarized
Date: Fri, 14 May 2021 22:33:39 +0200

[Message part 1 (text/plain, inline)]

Hi !!

Le Fri, May 14, 2021 at 03:25:44PM -0300, Thiago Jung Bauermann a écrit :
> Hello Tissevert,
> 
> 
> I can't comment on the package itself, but I hope you don't mind me 
> pointing out a minor nit:
> 
> > +       "Solarized is a 16-color palette comprising 8 monotones and 8
> > accent +colors.  It was designed for use with both terminal and GUI
> > applicatins, and +has a dark and a light mode.
> 
> Typo: applications
> 

minor, but embarassing !! Thank you so much for spotting it !

Cheers,

Tissevert

[0001-Add-package-for-vim-solarized.patch (text/plain, attachment)]

Message #52 received at 48126-done <at> debbugs.gnu.org (full text, mbox):

From: Tobias Geerinckx-Rice <me <at> tobias.gr>
To: 48126-done <at> debbugs.gnu.org
Subject: Re: [PATCH] Add package for vim-solarized
Date: Sat, 15 May 2021 15:04:11 +0200

[Message part 1 (text/plain, inline)]

Tissevert,

I

- added a commit message following our particular flavour of the 
 ‘GNU ChangeLog format’,
- changed the URL to /solarized (the commit already referred to 
 that repository),
- explained that this package installs only the Vim files from 
 there,

and pushed the thing as 992aa56e7c5d10e7d8d260fe3b2d0ce15b00c17b.

Phew!  And thanks,

T G-R

[signature.asc (application/pgp-signature, inline)]

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.