Re: Python port module documentation question
I was not too sure how to summarize what you guys mentioned about those variables. Would it be possible to get assistance clearing up the wording in the man page? I get reading the module itself but the man page was my first stop. Wondering if this is clear to others, since I am still new to OpenBSD and porting. -- Sent from my mobile device. Please excuse my brevity and formatting issues. On June 4, 2018 1:25:37 AM UTC, Stuart Henderson wrote: >On 2018/06/03 17:16, Edward Lopez-Acosta wrote: >> Thanks Landry and Stuart, >> >> With that information I tried to add a little bit of clarity to the >man page >> using my understanding of those options. Never written a man page >before so >> it was an interesting experience. >> >> If this looks good would it be possible to get this merged for future >> releases? >> >> --- port-modules.5.orig Sun Jun 3 16:12:15 2018 >> +++ port-modules.5 Sun Jun 3 17:07:11 2018 >> @@ -1339,19 +1339,29 @@ >> .Ev MODPY_RUN_DEPENDS , >> .Ev MODPY_BUILD_DEPENDS >> and >> -.Ev MODPY_ADJ_FILES . >> -Appends to >> +.Ev MODPY_ADJ_FILES. > >that space should be there, and the other .Ev you've added with >punctuation immediately >at the end should have spaces added > >> +.Ev MODPY_RUN_DEPENDS, >> +and >> +.Ev MODPY_BUILD_DEPENDS >> +append to >> .Ev RUN_DEPENDS >> -unless >> -.Ev MODPY_RUNDEP >> -is set to No. >> -Appends to >> +and >> .Ev BUILD_DEPENDS >> unless >> +.Ev MODPY_RUNDEP >> +or >> .Ev MODPY_BUILDDEP >> is set to No or >> .Ev NO_BUILD >> -is set to Yes. >> +is set to Yes. The depends options are primarily >> +used with port submodules, otherwise >> +.Ev RUN_DEPENDS >> +or >> +.Ev BUILD_DEPENDS >> +should be used. > >new sentence -> new line > >there's no such thing as "port submodules" > >what you've added is pretty unclear, it makes it sound like the user >should >add something to MODPY_RUN_DEPENDS. it's not for that at all, it >provides >a string which can be added to "RUN_DEPENDS-subpackage". > >> +.Ev MODPY_RUN_DEPENDS, >> +is set automatically to the required versions of Python and >> +py-setuptools as applicable. >> .Ev MODPY_VERSION >> is the default version used by all python modules. >> Ports which use the setuptools module should set > >I don't think this really adds anything. Really I feel if you're using >a port module you should read the .mk file in conjunction with >port-modules(5), the latter can talk about things which need a bit >of extra explanation, but the problems you're running into can better >be sorted out with reference to a few existing python ports..
Re: Python port module documentation question
On 2018/06/03 17:16, Edward Lopez-Acosta wrote: > Thanks Landry and Stuart, > > With that information I tried to add a little bit of clarity to the man page > using my understanding of those options. Never written a man page before so > it was an interesting experience. > > If this looks good would it be possible to get this merged for future > releases? > > --- port-modules.5.orig Sun Jun 3 16:12:15 2018 > +++ port-modules.5Sun Jun 3 17:07:11 2018 > @@ -1339,19 +1339,29 @@ > .Ev MODPY_RUN_DEPENDS , > .Ev MODPY_BUILD_DEPENDS > and > -.Ev MODPY_ADJ_FILES . > -Appends to > +.Ev MODPY_ADJ_FILES. that space should be there, and the other .Ev you've added with punctuation immediately at the end should have spaces added > +.Ev MODPY_RUN_DEPENDS, > +and > +.Ev MODPY_BUILD_DEPENDS > +append to > .Ev RUN_DEPENDS > -unless > -.Ev MODPY_RUNDEP > -is set to No. > -Appends to > +and > .Ev BUILD_DEPENDS > unless > +.Ev MODPY_RUNDEP > +or > .Ev MODPY_BUILDDEP > is set to No or > .Ev NO_BUILD > -is set to Yes. > +is set to Yes. The depends options are primarily > +used with port submodules, otherwise > +.Ev RUN_DEPENDS > +or > +.Ev BUILD_DEPENDS > +should be used. new sentence -> new line there's no such thing as "port submodules" what you've added is pretty unclear, it makes it sound like the user should add something to MODPY_RUN_DEPENDS. it's not for that at all, it provides a string which can be added to "RUN_DEPENDS-subpackage". > +.Ev MODPY_RUN_DEPENDS, > +is set automatically to the required versions of Python and > +py-setuptools as applicable. > .Ev MODPY_VERSION > is the default version used by all python modules. > Ports which use the setuptools module should set I don't think this really adds anything. Really I feel if you're using a port module you should read the .mk file in conjunction with port-modules(5), the latter can talk about things which need a bit of extra explanation, but the problems you're running into can better be sorted out with reference to a few existing python ports..
Re: Python port module documentation question
Thanks Landry and Stuart, With that information I tried to add a little bit of clarity to the man page using my understanding of those options. Never written a man page before so it was an interesting experience. If this looks good would it be possible to get this merged for future releases? --- port-modules.5.orig Sun Jun 3 16:12:15 2018 +++ port-modules.5 Sun Jun 3 17:07:11 2018 @@ -1339,19 +1339,29 @@ .Ev MODPY_RUN_DEPENDS , .Ev MODPY_BUILD_DEPENDS and -.Ev MODPY_ADJ_FILES . -Appends to +.Ev MODPY_ADJ_FILES. +.Ev MODPY_RUN_DEPENDS, +and +.Ev MODPY_BUILD_DEPENDS +append to .Ev RUN_DEPENDS -unless -.Ev MODPY_RUNDEP -is set to No. -Appends to +and .Ev BUILD_DEPENDS unless +.Ev MODPY_RUNDEP +or .Ev MODPY_BUILDDEP is set to No or .Ev NO_BUILD -is set to Yes. +is set to Yes. The depends options are primarily +used with port submodules, otherwise +.Ev RUN_DEPENDS +or +.Ev BUILD_DEPENDS +should be used. +.Ev MODPY_RUN_DEPENDS, +is set automatically to the required versions of Python and +py-setuptools as applicable. .Ev MODPY_VERSION is the default version used by all python modules. Ports which use the setuptools module should set On 2018-06-03 01:27, Landry Breuil wrote: On Sun, Jun 03, 2018 at 01:28:26AM +0100, Stuart Henderson wrote: On 2018/06/02 17:38, Edward Lopez-Acosta wrote: Would anyone be able to clarify what MODPY_RUN_DEPENDS does? Per the documentation (man port-modules) it says it should append to RUN_DEPENDS. When I have tested this though I have found it to not be the case. I submitted a couple ports to this list previously which use MODPY_RUN_DEPENDS for dependency modules. But the built package does not actually get said dependencies added to it. Can anyone clarify this within the documentation and possibly update the man page for clarity? Or am I totally missing what this option is for? I did also try adding MODPY_RUNDEP=Yes but that did not seem to help. Thank you in advance. MODPY_RUN_DEPENDS is populated with the string that you would need to add to RUN_DEPENDS to depend on python itself, plus an additional one for py-setuptools if needed. It's automatically appended to RUN_DEPENDS unless MODPY_RUNDEP=No. (MODPY_RUNDEP=Yes is the default). I'll add to that 'Iff the lang/python MODULE is used' :)
Re: Python port module documentation question
On Sun, Jun 03, 2018 at 01:28:26AM +0100, Stuart Henderson wrote: > On 2018/06/02 17:38, Edward Lopez-Acosta wrote: > > Would anyone be able to clarify what MODPY_RUN_DEPENDS does? Per the > > documentation (man port-modules) it says it should append to RUN_DEPENDS. > > When I have tested this though I have found it to not be the case. > > > > I submitted a couple ports to this list previously which use > > MODPY_RUN_DEPENDS for dependency modules. But the built package does not > > actually get said dependencies added to it. > > > > Can anyone clarify this within the documentation and possibly update the man > > page for clarity? Or am I totally missing what this option is for? I did > > also try adding MODPY_RUNDEP=Yes but that did not seem to help. > > > > Thank you in advance. > > > > MODPY_RUN_DEPENDS is populated with the string that you would need to > add to RUN_DEPENDS to depend on python itself, plus an additional one > for py-setuptools if needed. > > It's automatically appended to RUN_DEPENDS unless MODPY_RUNDEP=No. > (MODPY_RUNDEP=Yes is the default). I'll add to that 'Iff the lang/python MODULE is used' :)
Re: Python port module documentation question
On 2018/06/02 17:38, Edward Lopez-Acosta wrote: > Would anyone be able to clarify what MODPY_RUN_DEPENDS does? Per the > documentation (man port-modules) it says it should append to RUN_DEPENDS. > When I have tested this though I have found it to not be the case. > > I submitted a couple ports to this list previously which use > MODPY_RUN_DEPENDS for dependency modules. But the built package does not > actually get said dependencies added to it. > > Can anyone clarify this within the documentation and possibly update the man > page for clarity? Or am I totally missing what this option is for? I did > also try adding MODPY_RUNDEP=Yes but that did not seem to help. > > Thank you in advance. > MODPY_RUN_DEPENDS is populated with the string that you would need to add to RUN_DEPENDS to depend on python itself, plus an additional one for py-setuptools if needed. It's automatically appended to RUN_DEPENDS unless MODPY_RUNDEP=No. (MODPY_RUNDEP=Yes is the default). It isn't something you set yourself, it's something you might use if you have a multi-package port (i.e. one where you set MULTI_PACKAGES to split a single port build into multiple packages) when you need to add the python dependency to some subpackages but not others.
