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

Add more documentation on building the tools #1584

Closed

Conversation

kingsawyer
Copy link
Contributor

The instructions for building the writer app don't include the filename. Adding this makes the following steps which assume the file is named "writer.cpp" work seamlessly.

There are no instructions on building the tools and unless you've used cmake you would be stuck wondering.

Signed-off-by: Dave Sawyer <kingsawyer@gmail.com>
Signed-off-by: Dave Sawyer <kingsawyer@gmail.com>
Signed-off-by: Dave Sawyer <kingsawyer@gmail.com>
Signed-off-by: Dave Sawyer <kingsawyer@gmail.com>
Signed-off-by: Dave Sawyer <kingsawyer@gmail.com>
@linux-foundation-easycla
Copy link

CLA Not Signed

@cary-ilm
Copy link
Member

Thank you for the contribution, we appreciate anything that helps make things more clear.

The Hello, World example reader and writer code are meant to be examples of using OpenEXR as a library, separate from building the library and tools itself, so these instructions should address the needs of someone on a system with the libraries installed, without access to the actual library source code. That's a good suggestion to make the code downloadable, I admit that didn't occur to me. Rather than simply giving the filename as writer.cpp, could you make that rst reference a link to actually download the file? The same would apply to the example CMakeLists.txt and reader.cpp.

README.md Show resolved Hide resolved
@@ -14,6 +14,12 @@ operations, consider `oiiotool
Swiss Army Knife of `OpenImageIO
<https://sites.google.com/site/openimageio/home>`_

To build a tool in a git bash window:
Copy link
Member

Choose a reason for hiding this comment

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

This page isn't intended to discuss building the tools, just how to use them, so I don't think this is appropriate here.

Copy link
Member

Choose a reason for hiding this comment

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

I also think this is where the error is that causes the build to fail, see the "Website/Website" link below.

Copy link
Contributor Author

@kingsawyer kingsawyer Oct 31, 2023

Choose a reason for hiding this comment

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

Where would I learn how to build the tools? Should we add a readme.md to the tools directory?

Copy link
Member

Choose a reason for hiding this comment

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

The tools get built as a component of the full project build as long as OPENEXR_BUILD_TOOLS is ON, which is is by default. But I guess that's not entirely obvious, so worth mentioning in the other parts of the documentation.

Copy link
Member

Choose a reason for hiding this comment

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

But the instructions below won't work because the tool directory is not set up for an independent build. The more appropriate thing to say here is something like the previous comment, the tools are built as a component of the overall project build when OPENEXR_BUILD_TOOLS is ON.

And the indentation is off, so it's causing the website build to fail as well.

@cary-ilm
Copy link
Member

Apologies for letting this sit, but we would indeed like to accept your submission. The ASWF project policy is to require a signed contributor license agreement. Can you click on the red "NOT COVERED" link above and fill out the form? Thanks.

@cary-ilm
Copy link
Member

The confusion cited here and the suggestions for explicitly-named downloadable files are hopefully address by #1620 and #1622

@cary-ilm cary-ilm closed this Feb 13, 2024
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.

2 participants