Bug 183763 - devel/py-yaml: Confusing OPTIONS
Summary: devel/py-yaml: Confusing OPTIONS
Status: Closed FIXED
Alias: None
Product: Ports & Packages
Classification: Unclassified
Component: Individual Port(s) (show other bugs)
Version: Latest
Hardware: Any Any
: Normal Affects Only Me
Assignee: Josh Paetzel
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2013-11-07 21:30 UTC by Michael Gmelin
Modified: 2013-11-09 21:20 UTC (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Michael Gmelin 2013-11-07 21:30:00 UTC
The purpose of this port is providing YAML support to python, yet it defines

OPTIONS_DEFINE= YAML

which is not enabled by default and shown to the user as

[ ] YAML    YAML format or parser support
 
As far as I can tell this option enables the libyaml plugin in PyYAML.
LibYAML is written in C and as a result PyYAML is supposed to run
faster/nicer etc. Unfortunately the current option name doesn't make
this clear.

I would suggest to use a new option called LIBYAML, e.g.

OPTIONS_DEFINE= LIBYAML
LIBYAML_DESC= Use textproc/libyaml for faster parsing

and change

.if ${PORT_OPTIONS:MYAML}

to

.if ${PORT_OPTIONS:MLIBYAML}


Since I think that the general option YAML is about supporting yaml (and might be set globally by users) this might be a cleaner solution (alternatives would be overriding the description locally or change the default option description in /usr/ports/Mk/bsd.options.desc.mk to say "use libyaml", which most likely will lead to other problems)


And change the
Comment 1 Edwin Groothuis freebsd_committer freebsd_triage 2013-11-07 21:30:07 UTC
Responsible Changed
From-To: freebsd-ports-bugs->jpaetzel

Over to maintainer (via the GNATS Auto Assign Tool)
Comment 2 dfilter service freebsd_committer freebsd_triage 2013-11-09 21:14:04 UTC
Author: jpaetzel
Date: Sat Nov  9 21:13:57 2013
New Revision: 333337
URL: http://svnweb.freebsd.org/changeset/ports/333337

Log:
  Make port option less confusing.
  
  In the context of this port, turning on yaml support
  doesn't enable the optional yaml support like it does
  for other ports.  It compiles the yaml support against
  textproc/libyaml, which provides for yaml parsing with
  the speed of C in the ease of use of a scripting language.
  
  PR:	ports/183763
  Submitted by:	Michael Gmelin <freebsd@grem.de>

Modified:
  head/devel/py-yaml/Makefile
  head/devel/py-yaml/pkg-plist

Modified: head/devel/py-yaml/Makefile
==============================================================================
--- head/devel/py-yaml/Makefile	Sat Nov  9 20:53:16 2013	(r333336)
+++ head/devel/py-yaml/Makefile	Sat Nov  9 21:13:57 2013	(r333337)
@@ -11,7 +11,8 @@ DISTNAME=	PyYAML-${PORTVERSION}
 MAINTAINER=	jpaetzel@FreeBSD.org
 COMMENT=	Python YAML parser
 
-OPTIONS_DEFINE=	YAML
+OPTIONS_DEFINE=	LIBYAML
+LIBYAML_DESC=	Use textproc/libyaml for faster parsing
 
 USE_PYTHON=	yes
 USE_PYDISTUTILS=	yes
@@ -36,7 +37,7 @@ post-install:
 .include "${PORTSDIR}/devel/py-virtualenv/files/py3k-fix-pkg-plist.inc"
 .endif
 
-.if ${PORT_OPTIONS:MYAML}
+.if ${PORT_OPTIONS:MLIBYAML}
 PYSETUP=	setup.py --with-libyaml
 PYDISTUTILS_BUILD_TARGET=	build_ext
 PYDISTUTILS_BUILDARGS+=	--include-dirs=${LOCALBASE}/include \
@@ -44,11 +45,11 @@ PYDISTUTILS_BUILDARGS+=	--include-dirs=$
 
 LIB_DEPENDS+=		yaml-0.2:${PORTSDIR}/textproc/libyaml
 
-PLIST_SUB+=	YAML=""
+PLIST_SUB+=	LIBYAML=""
 .else
 PYSETUP=	setup.py --without-libyaml
 
-PLIST_SUB+=	YAML="@comment "
+PLIST_SUB+=	LIBYAML="@comment "
 .endif
 
 .include <bsd.port.post.mk>

Modified: head/devel/py-yaml/pkg-plist
==============================================================================
--- head/devel/py-yaml/pkg-plist	Sat Nov  9 20:53:16 2013	(r333336)
+++ head/devel/py-yaml/pkg-plist	Sat Nov  9 21:13:57 2013	(r333337)
@@ -1,4 +1,4 @@
-%%YAML%%%%PYTHON_SITELIBDIR%%/_yaml.so
+%%LIBYAML%%%%PYTHON_SITELIBDIR%%/_yaml.so
 %%PYTHON_SITELIBDIR%%/yaml/__init__.py
 %%PYTHON_SITELIBDIR%%/yaml/__init__.pyc
 %%PYTHON_SITELIBDIR%%/yaml/__init__.pyo
_______________________________________________
svn-ports-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-ports-all
To unsubscribe, send any mail to "svn-ports-all-unsubscribe@freebsd.org"
Comment 3 Josh Paetzel freebsd_committer freebsd_triage 2013-11-09 21:14:33 UTC
State Changed
From-To: open->closed

Great suggestion, committed!