Write: init at 2.0.9 from Styluslabs #42574

oyren · 2018-06-25T15:31:18Z

Motivation for this change

I want to add Write from styluslabs.com as a package. This is my first commit, so please tell me if i am doing something wrong ;).

Things done

Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
Built on platform(s)
- NixOS
- macOS
- other Linux distributions
Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
Tested compilation of all pkgs that depend on this change using nix-shell -p nox --run "nox-review wip"
Tested execution of all binary files (usually in ./result/bin/)
Determined the impact on package closure size (by running nix path-info -S before and after)
Fits CONTRIBUTING.md.

Write from Styluslabs (new package)

symphorien · 2018-06-27T19:39:19Z

pkgs/applications/graphics/write_stylus/default.nix

+    homepage = http://www.styluslabs.com/;
+    description = "Write is a word processor for handwriting.";
+    platforms = platforms.linux;
+    maintainers = [ "m.scheuren@oyra.eu" ];


I think the current policy is that you should add a full entry for yourself in https://github.com/NixOS/nixpkgs/blob/master/maintainers/maintainer-list.nix and use the attr here.

symphorien · 2018-06-27T19:39:25Z

pkgs/applications/graphics/write_stylus/default.nix

+      $out/Write/Write
+  '';
+
+  meta = with stdenv.lib; {


Please mention the license, since Write is unfree.

I'm not sure here, would it be right to add "license = stdenv.lib.licenses.unfreeRedistributable;"?
@symphorien

The license does not look like redistributable:

The LICENSEE may not reproduce or distribute the SOFTWARE PRODUCT.

so just unfree, I guess.

" stdenv.lib.licenses.unfree, "unfree"
Unfree package that cannot be redistributed. You can build it yourself, but you cannot redistribute the output of the derivation. Thus it cannot be included in the Nixpkgs channel. "

So I can close the pull request?

You should read "it won't be build by hydra, but compiled locally". There are dozens of unfree derivations in nixpkgs: https://search.nix.gsc.io/?q=unfree&i=nope&files=pkgs&repos=
The formulation is arguably misleading, maybe the docs need to be made clearer.

symphorien · 2018-06-27T19:39:37Z

pkgs/applications/graphics/write_stylus/default.nix

+  };
+
+  src = fetchurl {
+    url = "http://www.styluslabs.com/download/write-tgz";


Correct me if I am wrong, but the file pointed to by this url will probably change on the next update of Write, and will break the hash. If so, please replace it with an immutable url.

symphorien · 2018-06-27T19:41:54Z

pkgs/applications/graphics/write_stylus/default.nix

@@ -0,0 +1,53 @@
+{ stdenv, lib, qt5, makeWrapper, fetchurl, makeDesktopItem }:
+stdenv.mkDerivation rec {
+  name = "write_stylus";


The name should follow the pattern "name-version".

symphorien · 2018-06-28T19:30:40Z

pkgs/applications/graphics/write_stylus/default.nix

+    homepage = http://www.styluslabs.com/;
+    description = "Write is a word processor for handwriting.";
+    platforms = platforms.linux;
+    maintainers = [ oyren ];


stdenv.lib.maintainers.oyren, see the OfBorg error:

while evaluating the attribute 'maintainers' at /var/lib/ofborg/checkout/repo/38dca4e3aa6bca43ea96d2fcc04e8229/mr-est/eval-0-gleber.ewr1.nix.ci/pkgs/applications/graphics/write_stylus/default.nix:52:5: undefined variable 'oyren' at /var/lib/ofborg/checkout/repo/38dca4e3aa6bca43ea96d2fcc04e8229/mr-est/eval-0-gleber.ewr1.nix.ci/pkgs/applications/graphics/write_stylus/default.nix:52:21

symphorien · 2018-06-28T19:32:46Z

pkgs/applications/graphics/write_stylus/default.nix

+  sourceRoot = ".";
+  unpackCmd = ''
+    tar xfz "$src"
+    '';


sourceRoot and unpackCmd are probably unnecessary now that the url ends with .tar.gz

couldn't build it without sourceRoot. So i just removed unpackCmd.

symphorien · 2018-06-28T19:38:24Z

pkgs/applications/graphics/write_stylus/default.nix

@@ -0,0 +1,54 @@
+{ stdenv, lib, qt5, makeWrapper, fetchurl, makeDesktopItem }:


you should not add qt5 as an argument: see https://nixos.org/nixpkgs/manual/#ssec-qt-applications

I just followed this guide https://nixos.wiki/wiki/Packaging/Binaries

If i remove qt5, the package don't build, tried to fix it with "qt5.callPackage" but than i get undefined variable qt5 or undefined variable qtbase.

edited: copy paste error

this is a specificity of qt: if you use libsForQt5.callPackage instead of callPackage, you can add qtbase and other attributes of qt5 directly as an argument. See as an example https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/misc/digitalbitbox/default.nix#L13-L16 and https://github.com/NixOS/nixpkgs/blob/release-18.03/pkgs/top-level/all-packages.nix#L124

merge

ryantm · 2018-07-03T02:31:17Z

Thanks for the contribution; please squash this into one commit and use a commit message that is consistent with https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md for example write_stylus: init at 209

ryantm · 2018-07-03T02:34:08Z

pkgs/applications/graphics/write_stylus/default.nix

+  };
+  sourceRoot = ".";
+
+  buildPhase = ":";   # nothing to build


You can probably use dontBuild = true; here.

oyren · 2018-07-03T17:50:25Z

@ryantm I'm sorry, but I'm not that familiar with git. How can I squash this into one commit? I tried it with git rebase, without success.

ryantm · 2018-07-03T18:17:38Z

@oyren No problem, I'll try to help!

Your main problem is you merged master into your development branch.

Here's a rough script for how to fix it:

# Start back before you merged master
git checkout -b fixup-write 8fa0c34
# now make your change for dontBuild again and commit it...

#rebase onto origin/master
git rebase -i origin/master
# use "reword" for " Write from Styluslabs (new package)"
# use "squash" for every other commit
# exit rebasing
# use "write_stylus: init at 209" for the reworded commit message
# push with -force to oyren:master (since that is where you based this PR on)

Please let me know if you get stuck!

oyren · 2018-07-04T17:34:05Z

@ryantm
'Your main problem is you merged master into your development branch.'
This will never happen again, next time I will create a branch and thanks for your help.

But I got stucked :(.
As you said I did a git checkout whiteout problems.
If I do git rebase -i origin/master, vim open's the file 'git-rebase-todo' whit noop in it.
So I wrote the following into the file:

reword a6a21c4
squash aa3ed30
squash 3d9305d
squash 2f8d63e
squash fa660f5
squash 0f0bc74
squash e97ca5a
squash af8bebe
squash ccfaf49
squash 9936a44
squash 4348cb0
squash ba5500d
squash 8fa0c34
squash deff906
squash 4d18183

Saved and closed the file and get the following error's:
error: commit aa3ed30 is a merge but no -m option was given.
error: could not rename '.git/rebase-merge/message-squash' to '.git/rebase-merge/message'

Maybe I should Close this PR and do a new one?

ryantm · 2018-07-04T18:37:32Z

@oyren Sure, there's no reason you can't just copy the files onto a fresh checkout of NixOS/master and make a new PR.

oyren · 2018-07-04T20:25:20Z

There is the new PR #43044

oyren added 3 commits June 25, 2018 17:21

Write from Styluslabs (new package)

a6a21c4

Merge pull request #1 from oyren/write_styluslabs

aa3ed30

Write from Styluslabs (new package)

Write from Styluslabs (new package)

3d9305d

oyren changed the title ~~Write from Styluslabs (new package)~~ Write: init at 2.0.9 from Styluslabs Jun 26, 2018

symphorien reviewed Jun 27, 2018

View reviewed changes

oyren added 6 commits June 27, 2018 22:46

replace it with an immutable url

2f8d63e

version added

fa660f5

add oyren as maintainer

0f0bc74

changed maintainer to oyren

e97ca5a

fix path

af8bebe

fix trailing slash

ccfaf49

symphorien reviewed Jun 28, 2018

View reviewed changes

oyren added 5 commits June 30, 2018 15:47

fix maintainer issue

9936a44

removed qt5 as an argument

4348cb0

removed unpackCmd

ba5500d

license added

8fa0c34

Merge pull request #2 from NixOS/master

deff906

merge

GrahamcOfBorg added 8.has: package (new) 10.rebuild-darwin: 0 10.rebuild-linux: 1-10 labels Jun 30, 2018

ryantm requested changes Jul 3, 2018

View reviewed changes

moved to dontBuild

4d18183

oyren closed this Jul 4, 2018

Janik-Haag added the 12. first-time contribution label Jun 12, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Write: init at 2.0.9 from Styluslabs #42574

Write: init at 2.0.9 from Styluslabs #42574

oyren commented Jun 25, 2018 •

edited

symphorien Jun 27, 2018

symphorien Jun 27, 2018

oyren Jun 27, 2018 •

edited

symphorien Jun 28, 2018

oyren Jun 28, 2018 •

edited

symphorien Jun 28, 2018

symphorien Jun 27, 2018

symphorien Jun 27, 2018

symphorien Jun 28, 2018

symphorien Jun 28, 2018

oyren Jun 30, 2018

symphorien Jun 28, 2018

oyren Jun 28, 2018 •

edited

symphorien Jun 29, 2018

ryantm commented Jul 3, 2018

ryantm Jul 3, 2018

oyren commented Jul 3, 2018

ryantm commented Jul 3, 2018 •

edited

oyren commented Jul 4, 2018

ryantm commented Jul 4, 2018

oyren commented Jul 4, 2018

		@@ -0,0 +1,54 @@
		{ stdenv, lib, qt5, makeWrapper, fetchurl, makeDesktopItem }:

Write: init at 2.0.9 from Styluslabs #42574

Write: init at 2.0.9 from Styluslabs #42574

Conversation

oyren commented Jun 25, 2018 • edited

Motivation for this change

Things done

Choose a reason for hiding this comment

Choose a reason for hiding this comment

oyren Jun 27, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

oyren Jun 28, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

oyren Jun 28, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ryantm commented Jul 3, 2018

Choose a reason for hiding this comment

oyren commented Jul 3, 2018

ryantm commented Jul 3, 2018 • edited

oyren commented Jul 4, 2018

ryantm commented Jul 4, 2018

oyren commented Jul 4, 2018

oyren commented Jun 25, 2018 •

edited

oyren Jun 27, 2018 •

edited

oyren Jun 28, 2018 •

edited

oyren Jun 28, 2018 •

edited

ryantm commented Jul 3, 2018 •

edited