Skip to content

Commit

Permalink
Improve drmemtrace -indir and -outdir docs: directory contents are in…
Browse files Browse the repository at this point in the history
…ternal (#6786)

If the user happens to, for example, create a file in this directory
then drcachesim will complain that it doesn't understand the file. Warn
the user that the contents of these directories are internal to the
tool.
  • Loading branch information
xdje42 authored Jun 21, 2024
1 parent 0fb958e commit 44d677f
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
7 changes: 5 additions & 2 deletions clients/drcachesim/common/options.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,8 @@ droption_t<std::string> op_ipc_name(
droption_t<std::string> op_outdir(
DROPTION_SCOPE_ALL, "outdir", ".", "Target directory for offline trace files",
"For the offline analysis mode (when -offline is requested), specifies the path "
"to a directory where per-thread trace files will be written.");
"to a directory where per-thread trace files will be written. The contents of this "
"directory are internal to the tool. Do not alter, add, or delete files here.");

droption_t<std::string> op_subdir_prefix(
DROPTION_SCOPE_ALL, "subdir_prefix", "drmemtrace",
Expand All @@ -89,7 +90,9 @@ droption_t<std::string> op_indir(
"The -offline tracing produces raw data files which are converted into final "
"trace files on the first execution with -indir. The raw files can also be manually "
"converted using the drraw2trace tool. Legacy single trace files with all threads "
"interleaved into one are not supported with this option: use -infile instead.");
"interleaved into one are not supported with this option: use -infile instead. "
"The contents of this directory are internal to the tool. Do not alter, add, or "
"delete files here.");

droption_t<std::string> op_infile(
DROPTION_SCOPE_ALL, "infile", "", "Offline legacy file for input to the simulator",
Expand Down
2 changes: 2 additions & 0 deletions clients/drcachesim/docs/drcachesim.dox.in
Original file line number Diff line number Diff line change
Expand Up @@ -1147,6 +1147,8 @@ $ bin64/drrun -t drmemtrace -indir drmemtrace.app.pid.xxxx.dir/

The direct results of the \p -offline run are raw, compacted files, stored
in a \p raw/ subdirectory of the \p drmemtrace.app.pid.xxxx.dir directory.
The contents of \p drmemtrace.app.pid.xxxx.dir, and all its subdirectories,
are internal to the tools. Do not alter, add, or delete files here.
The \p -indir option both converts the data to a canonical trace form and
passes the resulting data to the cache simulator. The canonical trace data
is stored by \p -indir in a \p trace/ subdirectory inside the \p
Expand Down

0 comments on commit 44d677f

Please sign in to comment.