Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Building OSL on Windows OS #1326

Merged

Conversation

madoodia
Copy link
Contributor

@madoodia madoodia commented Jan 15, 2021

Description

This PR will add a method of building OSL on Windows OS.

The whole process is explained in an md file in doc/build_install/windows directory

Tests

I've tested the whole process on Windows 10 and OSL is installed successfully

Checklist:

  • I have read the contribution guidelines.
  • I have previously submitted a Contributor License Agreement.
  • I have updated the documentation, if applicable.
  • I have ensured that the change is tested somewhere in the testsuite (adding new test cases if necessary).
  • My code follows the prevailing code style of this project.

@madoodia madoodia changed the title Reza - building OSL on windows Building OSL on Windows OS Jan 15, 2021
@mprater
Copy link
Contributor

mprater commented Jan 15, 2021

Thanks Reza. I wonder if you could convert the .odt file to .md or .rst? We'll want documentation to use either of those formats in the future.

I used .odt as a quicky container for content I grabbed from elsewhere.

@madoodia
Copy link
Contributor Author

Thanks Reza. I wonder if you could convert the .odt file to .md or .rst? We'll want documentation to use either of those formats in the future.

I used .odt as a quicky container for content I grabbed from elsewhere.

Sure, I'll do that
Sorry

@mprater
Copy link
Contributor

mprater commented Jan 15, 2021

It appears that many of these files contain copyright notices in their comments. Those ought to be removed; or replaced with:

Copyright Contributors to the Open Shading Language project.

@madoodia
Copy link
Contributor Author

Copyright Contributors to the Open Shading Language project.

I see
so errors are because of them
I'll remove them
thanks for letting me know

Copy link
Contributor

@mprater mprater left a comment

Choose a reason for hiding this comment

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

I have no way to test any of this, but what's here looks okay to me. Thanks Reza!


This document is prepared for those who have problem in building OSL in Windows OS, this is completely custom setup. And it is developing to make it compatible with all situations.

(`Disclaimer: This Process is completely Experimental and it worked on my system, maybe you get error with changing some configs, during this process). At a first glance it seems to be complicated, but it is very easy to do, bare with me :)
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think you have an opening single quote here, that does not have a corresponding closing quote.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I fixed this one

#
# Copyright Contributors to the Open Shading Language project.
#
# Based on USD build_scripts by Pixar Animation Studio
Copy link
Collaborator

Choose a reason for hiding this comment

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

If this contains any code copied from USD, we need to reproduce their copyright and license information here to be in compliance with that project's Apache 2.0 license.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've added copyright notice to all files
just I'm not sure about the Pixar USD reproduced copyright
please check the file

Copy link
Collaborator

Choose a reason for hiding this comment

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

Here's how I think the header of this file should read:

# Copyright Contributors to the Open Shading Language project.
# SPDX-License-Identifier: BSD-3-Clause
#
# Portions of this file were derived from USD, which has the following notice:
# Copyright Pixar
# Apache 2.0 license with modifications: https://github.com/PixarAnimationStudios/USD/blob/release/LICENSE.txt

@lgritz
Copy link
Collaborator

lgritz commented Jan 16, 2021

Every file (if at all possible) in the project needs both of these lines somewhere (usually as comments at the very top of the file):

Copyright Contributors to the Open Shading Language project.
SPDX-License-Identifier: BSD-3-Clause

We use BSD-3-Clause for code files, but if the file is purely documentation, we instead use a Creative Commons license, so that would instead read:

SPDX-License-Identifier: CC-BY-4.0

Any material "imported" from any other project -- that is, not written from scratch for the OSL project -- should have a comment that says (a) The copyright notice preferred by the project it came from, (b) the appropriate SPDX identifier for the license used by that project, and (c) exactly which code that applies to (this whole file? a particular function or set of functions? just these three lines?).

Also the top-level file THIRD-PARTY.md details reproduces the licenses used by any third-party bits in our code base, and says which parts/projects are associated with which license.

@madoodia
Copy link
Contributor Author

Thanks @lgritz
I will edit files

@mprater mprater merged commit 1e7d8f0 into AcademySoftwareFoundation:master Jan 24, 2021
@mprater
Copy link
Contributor

mprater commented Jan 24, 2021

Merging now. Will make English language edits at a later time.

@madoodia
Copy link
Contributor Author

Merging now. Will make English language edits at a later time.

Yes, it needs lots of edits.
thanks though @mprater

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants