summaryrefslogtreecommitdiff
path: root/tools/perf/Documentation/guestmount.txt
diff options
context:
space:
mode:
authorAdrian Hunter <adrian.hunter@intel.com>2022-08-11 20:04:11 +0300
committerArnaldo Carvalho de Melo <acme@redhat.com>2022-08-11 18:50:17 -0300
commit53e76d35f797b2975ad9b2934e668e59abba1f10 (patch)
treee98098da660237e286fe86d79b67788766336b97 /tools/perf/Documentation/guestmount.txt
parentd9ca43c06fb76d2829675b764093c7094ab636f0 (diff)
perf tools: Tidy guest option documentation
Move common guest options into include files. Use attribute substitution to customize an example, using "[verse]" to define the block instead of a "literal" block which does not permit substitution. Signed-off-by: Adrian Hunter <adrian.hunter@intel.com> Cc: Ian Rogers <irogers@google.com> Cc: Jiri Olsa <jolsa@kernel.org> Cc: Namhyung Kim <namhyung@kernel.org> Link: https://lore.kernel.org/r/20220811170411.84154-4-adrian.hunter@intel.com Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
Diffstat (limited to 'tools/perf/Documentation/guestmount.txt')
-rw-r--r--tools/perf/Documentation/guestmount.txt11
1 files changed, 11 insertions, 0 deletions
diff --git a/tools/perf/Documentation/guestmount.txt b/tools/perf/Documentation/guestmount.txt
new file mode 100644
index 000000000000..6edf12363add
--- /dev/null
+++ b/tools/perf/Documentation/guestmount.txt
@@ -0,0 +1,11 @@
+--guestmount=<path>::
+ Guest OS root file system mount directory. Users mount guest OS
+ root directories under <path> by a specific filesystem access method,
+ typically, sshfs.
+ For example, start 2 guest OS, one's pid is 8888 and the other's is 9999:
+[verse]
+ $ mkdir \~/guestmount
+ $ cd \~/guestmount
+ $ sshfs -o allow_other,direct_io -p 5551 localhost:/ 8888/
+ $ sshfs -o allow_other,direct_io -p 5552 localhost:/ 9999/
+ $ perf {GMEXAMPLECMD} --guestmount=~/guestmount {GMEXAMPLESUBCMD}