Xilinx / Xilinx/XRT

Documentation Fix

Open
#8,233 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
686
Forks
549
Avg merge
2d 4h
Merged PRs (30d)
70

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the source for the published build.html page and the build.sh --help text, since the issue does not name their files. Compare both statements with the current default behavior, then verify that the documentation and help output consistently describe Debug as the default and -opt as the Release option.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
build-system, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.