Bug 210613 - [patch] lang/rust: add support for DOCS
Summary: [patch] lang/rust: add support for DOCS
Status: Closed FIXED
Alias: None
Product: Ports & Packages
Classification: Unclassified
Component: Individual Port(s) (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: Thomas Zander
URL: https://reviews.freebsd.org/D7050
Keywords: patch
Depends on:
Blocks:
 
Reported: 2016-06-27 07:59 UTC by Timothy Beyer
Modified: 2016-07-04 05:22 UTC (History)
2 users (show)

See Also:
riggs: maintainer-feedback+


Attachments
add DOCS and SRCS options (104.74 KB, application/x-bzip)
2016-06-27 08:01 UTC, Timothy Beyer
riggs: maintainer-approval-
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Timothy Beyer 2016-06-27 07:59:28 UTC
The patch adds the following features to the lang/rust port:

  *  Adds support for DOCS option
  *  Adds a SRCS option, since compiler sources are needed at runtime for some rust applications, such as the rust racer debugger

Consequently, I will submit a port for devel/racer shortly.

Tim
Comment 1 Timothy Beyer 2016-06-27 08:01:45 UTC
Created attachment 171856 [details]
add DOCS and SRCS options

Compressed as tar.bz2 to fit in space usage requirement of less than 1 mb.
Comment 2 Timothy Beyer 2016-06-27 08:02:53 UTC
My apologies, I meant, bz2, not tarball.
Comment 3 Timothy Beyer 2016-06-27 08:11:21 UTC
I just submitted a port for autocomplete utility devel/racer, which is dependent on this patch, see https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=210614 for more details.

This submission is in fact a patch inside the bz2 file, just that the OPTIONS implemented by this patch make the pkg-plist rather large, although I do not believe it will make it much harder to maintain.

Let me know if there is some way that I can address any concerns with the submission if it does not follow conventions closely.
Comment 4 Timothy Beyer 2016-06-27 16:30:40 UTC
Should I Cc: the port maintainer, or is the maintainer-feedback flag sufficient notification?
Comment 5 Thomas Zander freebsd_committer freebsd_triage 2016-06-27 17:18:47 UTC
Looking into it as soon as I can
Comment 6 Thomas Zander freebsd_committer freebsd_triage 2016-07-01 10:53:33 UTC
(In reply to Timothy Beyer from comment #3)

Including DOCS into the rust port is a good idea, but I think it might be better to bundle the sources in a separate port. That way, any dependent port can specify if it needs only the runtime components (probably the majority of cases) or if it needs the sources as well.

Let me know if I miss something critical with this idea.
Comment 7 Thomas Zander freebsd_committer freebsd_triage 2016-07-01 21:39:34 UTC
New proposed patch via https://reviews.freebsd.org/D7050

Now waiting for verification / identification of breaking changes in lang/rust-nightly or DragonFlyBSD.
Comment 8 Timothy Beyer 2016-07-02 02:05:37 UTC
I agree that a separate port makes more sense for installing the sources, and I can understand any hesitation to that option, since it could potentially make the port harder to maintain in the future, especially given that rust changes so rapidly.  The only thing that worries me about a separate port is that could potentially suffer from one of two problems, depending on which way it is implemented:

  1.  If it is completely separate, then the hypothetical lang/rust-sources port might install sources for a different version than the lang/rust port, which is unintuitive
  2.  If it is a metaport, then any updates to the lang/rust port will break the hypothetical lang/rust-sources port due to incorrect pkg-plist (if someone knows a good way to do this without breakage when the main port changes, then I would support it)

There might be a better way to do this, but right now, I'm leaning more towards the first method, to ease maintenance burden, as I'm not good at maintaining ports that change often.

Regards,
Tim
Comment 9 commit-hook freebsd_committer freebsd_triage 2016-07-02 19:06:53 UTC
A commit references this bug:

Author: riggs
Date: Sat Jul  2 19:06:35 UTC 2016
New revision: 417938
URL: https://svnweb.freebsd.org/changeset/ports/417938

Log:
  Add DOCS OPTION for html docs, bump PORTREVISION

  PR:		210613
  Reported by:	beyert@cs.ucr.edu
  Reviewed by:	riggs, marino, jbeich
  Differential Revision:	https://reviews.freebsd.org/D7050

Changes:
  head/lang/rust/Makefile
  head/lang/rust/pkg-plist
Comment 10 Thomas Zander freebsd_committer freebsd_triage 2016-07-04 05:21:30 UTC
Comment on attachment 171856 [details]
add DOCS and SRCS options

DOCS OPTION is now included. SRCS will be handled in different PR.
Comment 11 Thomas Zander freebsd_committer freebsd_triage 2016-07-04 05:22:43 UTC
Handling of SRCS installation will be handled in a different PR. Closing this one for now.