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

go_md2man: new recipe #2079

Merged
merged 7 commits into from
Feb 15, 2018
Merged

go_md2man: new recipe #2079

merged 7 commits into from
Feb 15, 2018

Conversation

sfanxiang
Copy link
Contributor

This recipe is a dependency of #2078.

Copy link
Contributor

@alaviss alaviss left a comment

Choose a reason for hiding this comment

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

As they vendored blackfriday, this port is subjected to said project licenses and copyright

SUMMARY="Uses blackfriday to process markdown into man pages"
DESCRIPTION="go-md2man uses blackfriday to process markdown into man pages"
HOMEPAGE="https://github.com/cpuguy83/go-md2man"
COPYRIGHT="2017 Brian Goff"
Copy link
Contributor

Choose a reason for hiding this comment

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

-COPYRIGHT="2017 Brian Goff"
+COPYRIGHT="2017 Brian Goff
+	2017 Russ Ross"

DESCRIPTION="go-md2man uses blackfriday to process markdown into man pages"
HOMEPAGE="https://github.com/cpuguy83/go-md2man"
COPYRIGHT="2017 Brian Goff"
LICENSE="MIT"
Copy link
Contributor

Choose a reason for hiding this comment

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

-LICENSE="MIT"
+LICENSE="MIT
+	BSD (2-clause)"

@@ -0,0 +1,60 @@
SUMMARY="Uses blackfriday to process markdown into man pages"
Copy link
Contributor

Choose a reason for hiding this comment

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

Here's a better SUMMARY for you

-SUMMARY="Uses blackfriday to process markdown into man pages"
+SUMMARY="A utility to convert markdown to man pages"

@@ -0,0 +1,60 @@
SUMMARY="Uses blackfriday to process markdown into man pages"
DESCRIPTION="go-md2man uses blackfriday to process markdown into man pages"
Copy link
Contributor

Choose a reason for hiding this comment

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

And here's a better DESCRIPTION as well (from go-md2man.1)

go-md2man converts standard markdown formatted documents into manpages. It is written purely in Go so as to reduce dependencies on 3rd party libs.

@sfanxiang
Copy link
Contributor Author

@alaviss

As they vendored blackfriday, this port is subjected to said project licenses and copyright

Thanks. I didn't notice this, and this recipe needs to be updated.

But I don't think putting two licenses there is a good idea, because people will think the project is dual-licensed, and that's probably not cpuguy83's intention.

@alaviss
Copy link
Contributor

alaviss commented Jan 7, 2018

@sfanxiang

But I don't think putting two licenses there is a good idea, because people will think the project is dual-licensed, and that's probably not cpuguy83's intention.

It's not the matter of good or bad, it's for legal purposes. The license explictly requires the copyright notice, and the license text (which we currently don't do but instead refer to them with LICENSE, see haikuports/haikuporter#156) to be included with the distribution.

@sfanxiang
Copy link
Contributor Author

@alaviss
You're right. I forgot about the static linkage here.

BUILD_REQUIRES="
haiku_devel
"

Copy link
Contributor

Choose a reason for hiding this comment

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

Please remove this blank line as required by our Guidelines

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can't find where it says "no blank line in BUILD_REQUIRES". Could you point it out?

Copy link
Contributor

Choose a reason for hiding this comment

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

From the Guidelines

The correct ordering and spacing of the variables inside the recipe is as follows:

BUILD_REQUIRES
BUILD_PREREQUIRES

Copy link
Contributor

@alaviss alaviss left a comment

Choose a reason for hiding this comment

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

LGTM, great work!

However, as your recipe is one of the first go-based ports, we would need inputs from maintainers who are knowledgeable about go ecosystem.

@korli korli merged commit 33ea049 into haikuports:master Feb 15, 2018
@sfanxiang sfanxiang deleted the go-md2man branch February 16, 2018 12:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants