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

Documentation Fix #8233

Open
andrej opened this issue Jun 11, 2024 · 0 comments
Open

Documentation Fix #8233

andrej opened this issue Jun 11, 2024 · 0 comments

Comments

@andrej
Copy link

andrej commented Jun 11, 2024

I noticed a very minor issue in the docs. I would have opened a PR instead of an issue with the fix, but I can't seem to find the source for the docs.

On this page: https://xilinx.github.io/XRT/master/html/build.html
Under section "Building the XRT Runtime", it says:

build.sh script builds for both Debug and Release profiles.

I think this is no longer accurate. At least on my end, I have to pass the -opt flag to get a Release build. Suggested change:

The build.sh script builds for the Debug profile by default. To get a Release build, pass the -opt flag.

The help for build.sh --help would also need to be updated, from:

[-dbg] Build debug library only (default)
[-opt] Build optimized library only (default)

to

[-dbg] Build debug library only (default)
[-opt] Build optimized library only

Like I said, very minor, but thought I'd let you know.

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

No branches or pull requests

1 participant