Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Write from Stylus Labs #24555

Closed
wants to merge 8 commits into from
Closed

Add Write from Stylus Labs #24555

wants to merge 8 commits into from

Conversation

cat-marin
Copy link

Starting college and thought it might be easier to set up new systems with Write in void-packages.

@fosslinux
Copy link
Contributor

Should install to /usr.

@cat-marin
Copy link
Author

Should install to /usr.

It does install to /usr. Or are you talking about $package_location?

@fosslinux
Copy link
Contributor

Yeah $package_location, everything is being copied to /opt, packages should not touch /opt; everything should be installed directly to /usr only.

@cat-marin
Copy link
Author

Yeah $package_location, everything is being copied to /opt, packages should not touch /opt; everything should be installed directly to /usr only.

I've moved it to /usr/lib/$pkgname. I can't imagine this would be an issue as the discord package does the same thing, am I correct in assuming this?

Copy link
Contributor

@fosslinux fosslinux left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for that change.

Take a look here, there's a few outstanding issues, https://travis-ci.org/github/void-linux/void-packages/jobs/722610669.

Look at how discord does the EULA download. You should do something similar here with a vlicense; generally this is required with 99% of these types of programs and is good practice anyway.

Oh, and also squash all your commits under New package: write-styluslabs-3.0.0..

@@ -0,0 +1,32 @@
# Template file for 'Write'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be identical to the pkgname.

archs="x86_64"
wrksrc="Write"
depends="SDL2"
short_desc="A word processor for handwriting"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove A, see xlint error

Update Write.desktop to reflect proper binary location

Install to /usr instead of /opt

Remove A, change template comment
@cat-marin
Copy link
Author

My bad on the last one, I'm not well versed in git. Working on the squash, heh. Also, I cannot find any kind of license on their site. They have a github for other libraries used in the program but there is no kind of EULA that I can find on the project website.

Update Write.desktop to reflect proper binary location

Install to /usr instead of /opt

Remove A, change template comment
@fosslinux
Copy link
Contributor

Hm, seems to be the case... not 100% sure what to do here. git rebase -i HEAD~20 (or ~however-many-commits-back) should help you.

@cat-marin
Copy link
Author

Have I not done it already? I did git rebase. Or should it also change the PR name?

@fosslinux
Copy link
Contributor

No, it has nothing to do with the PR name. git rebase on its own will do nothing. Look here, https://github.com/void-linux/void-packages/pull/24555/commits there are still 8 commits in this PR.

@ahesford
Copy link
Member

ahesford commented Sep 2, 2020

What you need to do is, assuming the void-linux/void-packages remote is called upstream in your repo,

git pull --rebase upstream master
git rebase -i upstream/master

If you are working from your fork alone, you should first do

git remote add upstream https://github.com/void-linux/void-packages

Then, in the editor that git rebase -i opens up, change the pick on the first line to r for reword, and change the pick on every subsequent line to f for fixup. When you save and quit your editor, it will open a new editor and allow you to set a message for the first commit; give this the expected "new package" message. Every other commit in your branch will be folded into the first one, so you will reduce this PR to a single commit with the correct message.

Copy link
Member

@ahesford ahesford left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As xlint reports, indent function bodies with a tab rather than several spaces.

The unversioned distfiles link militates against inclusion of this template in its current form, and the unknown license militates strongly against inclusion of this template in its current form. Also, the Write tarball includes an executable, two fonts, a desktop shortcut and an icon. I have a suspicion that this executable runs just as well from a local subdirectory of $HOME as it does from /usr/lib/write-styluslabs. This package appears to fall short of the quality requirements.

If you disagree, please make a case for why an exception should be made.

maintainer="Cat Marin <me@jmarin.xyz>"
license="custom:Proprietary"
homepage="http://www.styluslabs.com/"
distfiles="http://www.styluslabs.com/write/write-latest.tar.gz"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The distfiles URL is problematic because there is no fixed versioning. Whenever Stylus Labs releases a new version, that link will break the package, so things like package revbumps or local building become impossible. I suggest you try to find a versioned download, or else reach out to Stylus Labs about providing versioned downloads.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as I can tell that's how they release packages. I actually tried doing it with a variable and xbps-src doesn't accept version=latest. Until they provide versioned downloads, I'm not sure how else to proceed.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They provides versioned tarball, they just don't show you, here is the link for 3.0.0 http://www.styluslabs.com/write/write300.tar.gz

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They provides versioned tarball, they just don't show you, here is the link for 3.0.0 http://www.styluslabs.com/write/write300.tar.gz

Yep! Saw that in their response to me email. However they still don't have a license available, which as I understand is necessary in order to proceed. In any case, judging by how many changes I needed to make (and quality concerns of my template) I'm in no way ready to take on maintaining a package. I'll look more into the documentation and other package templates before I do anything else.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nah, packages in void aren't that hard. TBH, it's really just that you chose a slightly problematic package to start on :)

depends="SDL2"
short_desc="Word processor for handwriting"
maintainer="Cat Marin <me@jmarin.xyz>"
license="custom:Proprietary"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As the xlint CI test shows, a proprietary license declaration requires use of vlicense in do_install or post_install to copy the license text into the package. As it stands, I see no license terms attached to this software. You should identify the license terms and be able to fetch the license text from somewhere so we know what terms govern the software.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm currently in the process of contacting Stylus Labs on how they'd like me to proceed here, I'll update my PR when I know.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If they don't make versioned releases. it's unlikely to be accepted as a package here.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure how well it fits under quality requirements either.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If they don't make versioned releases. it's unlikely to be accepted as a package here.

I've sent them an email regarding the issues on their end (including the license), I'll be closing my pull request until they respond/provide versioned downloads and a license.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cat-marin
Copy link
Author

Closing

@cat-marin cat-marin closed this Sep 3, 2020
@sgn
Copy link
Member

sgn commented Sep 5, 2020 via email

@cat-marin
Copy link
Author

On 2020-09-04 13:39:43-0700, cat-marin notifications@github.com wrote:

@cat-marin commented on this pull request.

@@ -0,0 +1,32 @@
+# Template file for 'write-styluslabs'
+pkgname=write-styluslabs
+version=3.0.0
+revision=1
+archs="x86_64"
+wrksrc="Write"
+depends="SDL2"
+short_desc="Word processor for handwriting"
+maintainer="Cat Marin me@jmarin.xyz"
+license="custom:Proprietary"
+homepage="http://www.styluslabs.com/"
+distfiles="http://www.styluslabs.com/write/write-latest.tar.gz"

They provides versioned tarball, they just don't show you, here is
the link for 3.0.0 http://www.styluslabs.com/write/write300.tar.gz

Yep! Saw that in their response to me email. However they still
don't have a license available, which as I understand is necessary
in order to proceed.

The EULA is available at http://www.styluslabs.com/write/eula.docx
Either ship the docx file, or use docx2txt to convert to plain text
file

Interesting, was this added after I just emailed asking them to add it? Because when they responded they just said there wasn't really a license.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 27, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants