1# Description
2
3The OpenBMC debugtools tarball clashes with the filesystem layout of witherspoon
4systems, and contains a number of other outstanding issues with respect to the
5tools it deploys. The debug script here documents and executes the workarounds
6necessary to make it functional.
7
8## Usage
9
10```sh
11./debug [USER@]HOST TARBALL
12```
13
14For example:
15
16```sh
17./debug root@my-witherspoon obmc-phosphor-debug-tarball-witherspoon.tar.xz
18```
19
20## Notes
21
22The script will:
23
241. Ensure `/usr/local` is a tmpfs mountpoint (may not be if system is configured
25   for Field Mode)
262. Deploy the debugtools tarball to `/usr/local`
273. Make `perf(1)` work by
28   1. Installing a fake `expand(1)` if necessary
29   2. Fixing the `objdump(1)` symlink
30   3. Disabling `perf(1)`'s buildid tracking (fills the RW filesystem)
314. Make `latencytop(1)` work by deploying and symlinking libncurses{,w}.so
32