Suggestions for the Wiki
Open
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 10.7k
- Forks
- 662
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 2
Description
I suggest to add the following pieces to https://github.com/rr-debugger/rr/wiki/Building-And-Installing:
- cmake define
disable32bit, reasoning: builds faster, has less dependencies, 64bit recording and replay is quite likely happening on most systems, works around #2936 (it possibly also could default to ON instead of OFF and then be documented there as an extra sub-header "build to record and replay 32bit applications"...) - cmake define
CMAKE_INSTALL_PREFIX; while this one is likely known to people that are familiar with cmake, it still would be possibly useful to know for others;
I've personally triedmake install PREFIX=/myprefixfirst, thenCMAKE_INSTALL_PREFIX=/myprefix cmake, but "of course" the correct one iscmake -DCMAKE_INSTALL_PREFIX=/myprefix(while the correct way to specify the C compiler isCC=gcc cmake)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the rr Wiki's Building-And-Installing page and review the requested CMake options: disable32bit and CMAKE_INSTALL_PREFIX. Document their purpose and the relevant command-line forms, including the 32-bit build tradeoff; the page should clearly explain how readers can use both options.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cmake, cpp
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100