rr-debugger / rr-debugger/rr

Suggestions for the Wiki

Open
#2,937 1 comment 0 reactions 0 assignees View on GitHub

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 tried make install PREFIX=/myprefix first, then CMAKE_INSTALL_PREFIX=/myprefix cmake, but "of course" the correct one is cmake -DCMAKE_INSTALL_PREFIX=/myprefix (while the correct way to specify the C compiler is CC=gcc cmake)

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

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.