Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 663036 - dev-cpp/sourcetrail: cross-platform source explorer for C/C++ and Java
Summary: dev-cpp/sourcetrail: cross-platform source explorer for C/C++ and Java
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: New packages (show other bugs)
Hardware: AMD64 Linux
: Normal normal
Assignee: Default Assignee for New Packages
URL: http://www.sourcetrail.com
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2018-08-07 19:14 UTC by David Hallas
Modified: 2018-09-13 17:19 UTC (History)
2 users (show)

See Also:
Package list:
Runtime testing required: ---


Attachments
ebuild (sourcetrail-2018.3.13.ebuild,1.51 KB, text/plain)
2018-08-07 19:14 UTC, David Hallas
Details
Ebuild v2 (sourcetrail-2018.3.13.ebuild,1.49 KB, text/plain)
2018-08-08 08:35 UTC, David Hallas
Details
Ebuild v3 (sourcetrail-2018.3.13.ebuild,1.47 KB, text/plain)
2018-08-08 12:27 UTC, David Hallas
Details
License text from the application (Sourcetrail,12.19 KB, text/plain)
2018-08-08 12:27 UTC, David Hallas
Details

Note You need to log in before you can comment on or make changes to this bug.
Description David Hallas 2018-08-07 19:14:12 UTC
Created attachment 542712 [details]
ebuild

Sourcetrail is a cross-platform source explorer for C/C++ and Java. It is a binary package but is free for non-commercial use.

I have added my first take at a ebuild for this.

I would like to maintain this package if possible.
Comment 1 Tomáš Mózes 2018-08-08 07:11:16 UTC
- Copyright 1999-2018
- EAPI 7?
- please reorder the global variables (for example RESTRICT after KEYWORDS) according to /usr/portage/skel.ebuild
- please leave a comment why the RESTRICT line is introduced
- sed || die
Comment 2 Tomáš Mózes 2018-08-08 07:14:34 UTC
Just a personal preference, but I'd consider using lower case package directories (sourcetrail instead of Sourcetrail).
Comment 3 David Hallas 2018-08-08 08:35:01 UTC
Hi Tomas,

thanks for the review comments :)

I have implemented most of them in the updated ebuild, I have a few comments though.

I can't use EAPI=7 since the xdg-utils eclass doesn't support EAPI=7 yet.
Also I didn't add a comment for the RESTRICT line, but I instead reduced it to RESTRICT="mirror" since I guess this package is not mirrored (yet?).

I have another question, this package is a binary package with a custom Sourcetrail license, how would I specify that in the ebuild? Currently I have set LICENSE="mit" but that is wrong.
Comment 4 David Hallas 2018-08-08 08:35:30 UTC
Created attachment 542752 [details]
Ebuild v2
Comment 5 Tomáš Mózes 2018-08-08 11:00:36 UTC
(In reply to David Hallas from comment #3)
> I can't use EAPI=7 since the xdg-utils eclass doesn't support EAPI=7 yet.

Ok, than it's fine to leave at 6, good.

> Also I didn't add a comment for the RESTRICT line, but I instead reduced it
> to RESTRICT="mirror" since I guess this package is not mirrored (yet?).
https://devmanual.gentoo.org/general-concepts/mirrors/index.html The 

RESTRICT="mirror" setting should be used if we cannot legally mirror certain files; files will still be downloaded from the original locations. 

If it's not the case, then you can remove it too :)

> I have another question, this package is a binary package with a custom
> Sourcetrail license, how would I specify that in the ebuild? Currently I
> have set LICENSE="mit" but that is wrong.

We need to place it into the licenses directory and replace mit with it, that's all.
Comment 6 David Hallas 2018-08-08 12:26:52 UTC
(In reply to Tomáš Mózes from comment #5)
> (In reply to David Hallas from comment #3)
> > I can't use EAPI=7 since the xdg-utils eclass doesn't support EAPI=7 yet.
> 
> Ok, than it's fine to leave at 6, good.
> 
> > Also I didn't add a comment for the RESTRICT line, but I instead reduced it
> > to RESTRICT="mirror" since I guess this package is not mirrored (yet?).
> https://devmanual.gentoo.org/general-concepts/mirrors/index.html The 
> 
> RESTRICT="mirror" setting should be used if we cannot legally mirror certain
> files; files will still be downloaded from the original locations. 
> 
> If it's not the case, then you can remove it too :)
> 
> > I have another question, this package is a binary package with a custom
> > Sourcetrail license, how would I specify that in the ebuild? Currently I
> > have set LICENSE="mit" but that is wrong.
> 
> We need to place it into the licenses directory and replace mit with it,
> that's all.

I don't think there is any legal restrictions on mirroring the package, so I have removed the RESTRICT line :)

Attached is an updated ebuild.

I have also attached the license from the application, as I can't place files in the licenses directory, I haven't changed this in the ebuild.

What is the process for becoming the maintainer of this package?
Comment 7 David Hallas 2018-08-08 12:27:20 UTC
Created attachment 542768 [details]
Ebuild v3
Comment 8 David Hallas 2018-08-08 12:27:38 UTC
Created attachment 542770 [details]
License text from the application
Comment 9 Tomáš Mózes 2018-08-08 12:33:22 UTC
(In reply to David Hallas from comment #6)
> What is the process for becoming the maintainer of this package?

https://wiki.gentoo.org/wiki/Project:Proxy_Maintainers

I strongly recommend joining the irc and maybe opening a github PR.
Comment 10 Tomáš Mózes 2018-08-08 12:36:51 UTC
(In reply to David Hallas from comment #7)
> Created attachment 542768 [details]
> Ebuild v3

Are you sure you need to reference ${S} in src_install()? You should be in that directory already.
Comment 11 David Hallas 2018-08-08 19:35:45 UTC
(In reply to Tomáš Mózes from comment #10)
> (In reply to David Hallas from comment #7)
> > Created attachment 542768 [details]
> > Ebuild v3
> 
> Are you sure you need to reference ${S} in src_install()? You should be in
> that directory already.

This wasn't needed and has been removed, thanks for noticing :)

I have created a pull request with the updated ebuild and the license addition:

https://github.com/gentoo/gentoo/pull/9513
Comment 12 Larry the Git Cow gentoo-dev 2018-09-13 17:19:02 UTC
The bug has been closed via the following commit(s):

https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=c6880019d5b32d439391bbd26120141a30a7aa59

commit c6880019d5b32d439391bbd26120141a30a7aa59
Author:     David Hallas <david@davidhallas.dk>
AuthorDate: 2018-08-08 19:32:49 +0000
Commit:     Michał Górny <mgorny@gentoo.org>
CommitDate: 2018-09-13 17:18:57 +0000

    dev-cpp/sourcetrail: New package
    
    Sourcetrail is a cross-platform source explorer for C/C++ and Java code.
    It makes it easy to navigate a codebase in an intuitive way.
    
    Closes: https://bugs.gentoo.org/663036
    Package-Manager: Portage-2.3.40, Repoman-2.3.9
    Closes: https://github.com/gentoo/gentoo/pull/9513

 dev-cpp/sourcetrail/Manifest                     |  1 +
 dev-cpp/sourcetrail/metadata.xml                 | 15 ++++
 dev-cpp/sourcetrail/sourcetrail-2018.3.55.ebuild | 89 ++++++++++++++++++++++++
 3 files changed, 105 insertions(+)