Skip to content

Make xcframework output path argument explicit and required#19088

Merged
alalek merged 3 commits intoopencv:masterfrom
Rightpoint:task/colejd/make-xcframework-output-path-explicit
Dec 12, 2020
Merged

Make xcframework output path argument explicit and required#19088
alalek merged 3 commits intoopencv:masterfrom
Rightpoint:task/colejd/make-xcframework-output-path-explicit

Conversation

@colejd
Copy link
Copy Markdown
Contributor

@colejd colejd commented Dec 11, 2020

This PR forces users to supply an output path with an explicit argument when using build_xcframework.py.

  • Before: python3 build_xcframework.py outputpath
  • After: python3 build_xcframework.py --out outputpath

This reduces the possibility for argument parsing to go wrong, as in #19086 which prompted this PR. To reduce the likelihood of similar issues in the future, I've also improved the documentation here.

Pull Request Readiness Checklist

See details at https://github.com/opencv/opencv/wiki/How_to_contribute#making-a-good-pull-request

  • I agree to contribute to the project under Apache 2 License.
  • To the best of my knowledge, the proposed patch is not based on a code under GPL or other license that is incompatible with OpenCV
  • The PR is proposed to proper branch
  • There is reference to original bug report and related work
  • There is accuracy test, performance test and test data in opencv_extra repository, if applicable
    Patch to opencv_extra has the same branch name.
  • The feature is well documented and sample code can be built with the project CMake

@colejd colejd changed the title Task/colejd/make xcframework output path explicit Make xcframework output path explicit Dec 11, 2020
@colejd colejd changed the title Make xcframework output path explicit Make xcframework output path argument explicit and required Dec 11, 2020
@colejd
Copy link
Copy Markdown
Contributor Author

colejd commented Dec 11, 2020

When we can make breaking changes, we should do the same for the ios/osx build_framework.py scripts. I've left this as TODOs in the respective scripts.

Copy link
Copy Markdown
Member

@alalek alalek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@alalek alalek merged commit 743f181 into opencv:master Dec 12, 2020
@colejd colejd deleted the task/colejd/make-xcframework-output-path-explicit branch December 14, 2020 19:14
@alalek alalek mentioned this pull request Apr 9, 2021
a-sajjad72 pushed a commit to a-sajjad72/opencv that referenced this pull request Mar 30, 2023
…amework-output-path-explicit

Make xcframework output path argument explicit and required

* Make output path argument explicit and required

* Improve xcframework documentation

* Add TODOs for future breaking changes on build_framework.py scripts
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Error while building XCFramework

2 participants