Page MenuHomeFreeBSD

[phb] Document USES=ruby
ClosedPublic

Authored by fernape on Jan 19 2023, 4:57 PM.
Tags
None
Referenced Files
F109338926: D38121.diff
Mon, Feb 3, 6:48 PM
Unknown Object (File)
Fri, Jan 31, 5:53 PM
Unknown Object (File)
Sun, Jan 19, 1:40 PM
Unknown Object (File)
Sun, Jan 12, 7:51 AM
Unknown Object (File)
Nov 28 2024, 6:39 PM
Unknown Object (File)
Nov 23 2024, 1:43 AM
Unknown Object (File)
Nov 12 2024, 10:49 PM
Unknown Object (File)
Nov 12 2024, 6:09 PM
Subscribers
None

Details

Reviewers
bofh
Group Reviewers
Ruby
Commits
R9:407dbb9254e7: [phb] Document USES=ruby
Summary

Following changes in the ports framework in:

https://cgit.freebsd.org/ports/commit/?id=18c6e18276691edf5274406bf82a3b06792ff9ae

  • Remove USE_RUBY and related information.
  • Mention that USES=gem implies USES=ruby.
  • Document exported and user available variables.
Test Plan

Apply patch and run make documentation from the documentation's root
directory.

Here is a rendered page with the result.

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
No Lint Coverage
Unit
No Test Coverage
Build Status
Buildable 49314
Build 46204: arc lint + arc unit

Event Timeline

fernape created this revision.
fernape added reviewers: Ruby, bofh.

Looks good only except I think I have missed some things in the actual Mk/Uses/ruby.mk. We have both <none> and none that is no arguments and none as an argument. I will add these in an upcoming commit after you wordsmith what I have tried to describe here.

However I have added the relevant lines inline. Can you just make sure the wordings are correct?

documentation/content/en/books/porters-handbook/uses/_index.adoc
1720

We have to add none as an argument too. As it's used.

1722

(none) states that only RUN_DEPENDS is added for the ports and relevant variables are loaded.

1725

I think we should also mention that this is the default.

1727

none states that no dependencies are added to the port but loads the required variables. This is required for the package:lang/ruby[] ports itself only.

In D38121#869097, @bofh wrote:

Looks good only except I think I have missed some things in the actual Mk/Uses/ruby.mk. We have both <none> and none that is no arguments and none as an argument. I will add these in an upcoming commit after you wordsmith what I have tried to describe here.

Excellent, thanks for the review.

If we are not too late it could be nice to change none (as parameter) for something else. I can't come up with a name right now, but nodep might be one, or maybe noselfdep.

However I have added the relevant lines inline. Can you just make sure the wordings are correct?

documentation/content/en/books/porters-handbook/uses/_index.adoc
1727

I omitted the part for the variables since it is assumed that every other option (run, build, etc) will load the necessary variables if needed too.

In D38121#869097, @bofh wrote:

Looks good only except I think I have missed some things in the actual Mk/Uses/ruby.mk. We have both <none> and none that is no arguments and none as an argument. I will add these in an upcoming commit after you wordsmith what I have tried to describe here.

Excellent, thanks for the review.

If we are not too late it could be nice to change none (as parameter) for something else. I can't come up with a name right now, but nodep might be one, or maybe noselfdep.

I had a discussion with the portmgr@ and based on our discussion and further searching for needles in the haystack please do not mention none as an argument here. Currently there is no consumer which is using USES=ruby:none so we will get rid of this in my next commit.

Other than that it's perfectly fine to ship it.

However I have added the relevant lines inline. Can you just make sure the wordings are correct?

In D38121#869988, @bofh wrote:
In D38121#869097, @bofh wrote:

Looks good only except I think I have missed some things in the actual Mk/Uses/ruby.mk. We have both <none> and none that is no arguments and none as an argument. I will add these in an upcoming commit after you wordsmith what I have tried to describe here.

Excellent, thanks for the review.

If we are not too late it could be nice to change none (as parameter) for something else. I can't come up with a name right now, but nodep might be one, or maybe noselfdep.

I had a discussion with the portmgr@ and based on our discussion and further searching for needles in the haystack please do not mention none as an argument here. Currently there is no consumer which is using USES=ruby:none so we will get rid of this in my next commit.

Other than that it's perfectly fine to ship it.

OK, I'll remove the mention to none as argument and commit it.

Thanks!

However I have added the relevant lines inline. Can you just make sure the wordings are correct?

This revision was not accepted when it landed; it landed in state Needs Review.Jan 31 2023, 11:36 AM
This revision was automatically updated to reflect the committed changes.