David Galiffi
d13617cf91
* Update branding in docs
* Rename image used in documentation
* Update names of code samples.
In the code snippets, the "-" is not valid. ex., rocprof-sys_ --> rocprofsys_
* Update ASCII art
* update Doxyfile strip_from_path
* Add a "Formerly known as" message.
* Fixed typo in product name
ROCm Systems Profiler, not ROCm Profiler System
* Add "Omnitrace" back to the metadata keywords
* Update "install via package manager" section
* Update paths to user API files
* Rename configuration and environment settings
* Update Doxyfiles
Update publisher name & ID to "AMD".
Update bundle ID to "rocprofiler-systems"
* Update docs/what-is-rocprof-sys.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/conceptual/data-collection-modes.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/tutorials/video-tutorials.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/conceptual/rocprof-sys-feature-set.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/how-to/configuring-runtime-options.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/how-to/configuring-validating-environment.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/how-to/general-tips-using-rocprof-sys.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/reference/rocprof-sys-glossary.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/reference/development-guide.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/how-to/instrumenting-rewriting-binary-application.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/install/quick-start.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Note that videos were recorded using the "Omnitrace" name.
* Rebase and update some file paths
* Update paths to doc images
* Update Omnitrace references in code snippets
* Rename examples still using the "omni" prefix.
* Update docs/how-to/performing-causal-profiling.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/how-to/profiling-python-scripts.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/how-to/sampling-call-stack.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/how-to/understanding-rocprof-sys-output.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/install/install.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
---------
Co-authored-by: Peter Park <peter.park@amd.com>
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
[ROCm/rocprofiler-systems commit: 032d39f15c]
374 líneas
14 KiB
Plaintext
374 líneas
14 KiB
Plaintext
# Doxyfile 1.8.20
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Project related configuration options
|
|
#---------------------------------------------------------------------------
|
|
DOXYFILE_ENCODING = UTF-8
|
|
PROJECT_NAME = rocprofiler-systems
|
|
PROJECT_NUMBER = 1.11.3
|
|
PROJECT_BRIEF = "High-level and comprehensive application tracing and profiling on both the CPU and GPU"
|
|
PROJECT_LOGO =
|
|
OUTPUT_DIRECTORY = .
|
|
CREATE_SUBDIRS = NO
|
|
ALLOW_UNICODE_NAMES = YES
|
|
OUTPUT_LANGUAGE = English
|
|
OUTPUT_TEXT_DIRECTION = None
|
|
BRIEF_MEMBER_DESC = YES
|
|
REPEAT_BRIEF = YES
|
|
ABBREVIATE_BRIEF =
|
|
ALWAYS_DETAILED_SEC = YES
|
|
INLINE_INHERITED_MEMB = YES
|
|
FULL_PATH_NAMES = YES
|
|
STRIP_FROM_PATH = /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocprofiler-systems/checkouts/
|
|
STRIP_FROM_INC_PATH = /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocprofiler-systems/checkouts/
|
|
SHORT_NAMES = NO
|
|
JAVADOC_AUTOBRIEF = NO
|
|
JAVADOC_BANNER = NO
|
|
QT_AUTOBRIEF = NO
|
|
MULTILINE_CPP_IS_BRIEF = YES
|
|
PYTHON_DOCSTRING = YES
|
|
INHERIT_DOCS = YES
|
|
SEPARATE_MEMBER_PAGES = NO
|
|
TAB_SIZE = 4
|
|
ALIASES =
|
|
OPTIMIZE_OUTPUT_FOR_C = NO
|
|
OPTIMIZE_OUTPUT_JAVA = NO
|
|
OPTIMIZE_FOR_FORTRAN = NO
|
|
OPTIMIZE_OUTPUT_VHDL = NO
|
|
OPTIMIZE_OUTPUT_SLICE = NO
|
|
EXTENSION_MAPPING = hpp=C++ \
|
|
cpp=C++ \
|
|
hh=C++ \
|
|
cc=C++ \
|
|
h=C \
|
|
c=C \
|
|
py=Python
|
|
MARKDOWN_SUPPORT = YES
|
|
TOC_INCLUDE_HEADINGS = 2
|
|
AUTOLINK_SUPPORT = YES
|
|
BUILTIN_STL_SUPPORT = YES
|
|
CPP_CLI_SUPPORT = NO
|
|
SIP_SUPPORT = NO
|
|
IDL_PROPERTY_SUPPORT = YES
|
|
DISTRIBUTE_GROUP_DOC = NO
|
|
GROUP_NESTED_COMPOUNDS = YES
|
|
SUBGROUPING = YES
|
|
INLINE_GROUPED_CLASSES = NO
|
|
INLINE_SIMPLE_STRUCTS = YES
|
|
TYPEDEF_HIDES_STRUCT = NO
|
|
LOOKUP_CACHE_SIZE = 5
|
|
NUM_PROC_THREADS = 0
|
|
#---------------------------------------------------------------------------
|
|
# Build related configuration options
|
|
#---------------------------------------------------------------------------
|
|
EXTRACT_ALL = YES
|
|
EXTRACT_PRIVATE = NO
|
|
EXTRACT_PRIV_VIRTUAL = NO
|
|
EXTRACT_PACKAGE = NO
|
|
EXTRACT_STATIC = NO
|
|
EXTRACT_LOCAL_CLASSES = YES
|
|
EXTRACT_LOCAL_METHODS = NO
|
|
EXTRACT_ANON_NSPACES = NO
|
|
HIDE_UNDOC_MEMBERS = NO
|
|
HIDE_UNDOC_CLASSES = YES
|
|
HIDE_FRIEND_COMPOUNDS = NO
|
|
HIDE_IN_BODY_DOCS = NO
|
|
INTERNAL_DOCS = NO
|
|
CASE_SENSE_NAMES = NO
|
|
HIDE_SCOPE_NAMES = NO
|
|
HIDE_COMPOUND_REFERENCE= NO
|
|
SHOW_INCLUDE_FILES = YES
|
|
SHOW_GROUPED_MEMB_INC = NO
|
|
FORCE_LOCAL_INCLUDES = YES
|
|
INLINE_INFO = YES
|
|
SORT_MEMBER_DOCS = YES
|
|
SORT_BRIEF_DOCS = NO
|
|
SORT_MEMBERS_CTORS_1ST = YES
|
|
SORT_GROUP_NAMES = NO
|
|
SORT_BY_SCOPE_NAME = NO
|
|
STRICT_PROTO_MATCHING = NO
|
|
GENERATE_TODOLIST = NO
|
|
GENERATE_TESTLIST = NO
|
|
GENERATE_BUGLIST = NO
|
|
GENERATE_DEPRECATEDLIST= NO
|
|
ENABLED_SECTIONS =
|
|
MAX_INITIALIZER_LINES = 30
|
|
SHOW_USED_FILES = YES
|
|
SHOW_FILES = YES
|
|
SHOW_NAMESPACES = YES
|
|
FILE_VERSION_FILTER =
|
|
LAYOUT_FILE =
|
|
CITE_BIB_FILES =
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to warning and progress messages
|
|
#---------------------------------------------------------------------------
|
|
QUIET = NO
|
|
WARNINGS = YES
|
|
WARN_IF_UNDOCUMENTED = YES
|
|
WARN_IF_DOC_ERROR = YES
|
|
WARN_NO_PARAMDOC = YES
|
|
WARN_AS_ERROR = YES
|
|
WARN_FORMAT = "---> WARNING! $file:$line: $text"
|
|
WARN_LOGFILE = doc/warnings.log
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the input files
|
|
#---------------------------------------------------------------------------
|
|
INPUT = ../../README.md \
|
|
../../source/lib/rocprof-sys-user/rocprofiler-systems/types.h \
|
|
../../source/lib/rocprof-sys-user/rocprofiler-systems/categories.h \
|
|
../../source/lib/rocprof-sys-user/rocprofiler-systems/user.h \
|
|
../../source/lib/rocprof-sys-user/rocprofiler-systems/causal.h
|
|
INPUT_ENCODING = UTF-8
|
|
FILE_PATTERNS = *.h \
|
|
*.hh \
|
|
*.hpp \
|
|
*.c \
|
|
*.cc \
|
|
*.cxx \
|
|
*.cpp \
|
|
*.c++ \
|
|
*.icc \
|
|
*.tcc \
|
|
*.py
|
|
RECURSIVE = YES
|
|
EXCLUDE =
|
|
EXCLUDE_SYMLINKS = YES
|
|
EXCLUDE_PATTERNS = */.git/* \
|
|
../../external/* \
|
|
../../examples/* \
|
|
../../tests/*
|
|
EXCLUDE_SYMBOLS = "std::*" \
|
|
"ROCPROFSYS_ATTRIBUTE" \
|
|
"ROCPROFSYS_VISIBILITY" \
|
|
"ROCPROFSYS_PUBLIC_API" \
|
|
"ROCPROFSYS_HIDDEN_API" \
|
|
"SpaceHandle" \
|
|
"KokkosPDevice*"
|
|
EXAMPLE_PATH = ../../examples
|
|
EXAMPLE_PATTERNS = *.h \
|
|
*.hh \
|
|
*.hpp \
|
|
*.c \
|
|
*.cc \
|
|
*.cpp \
|
|
*.py \
|
|
*.txt
|
|
EXAMPLE_RECURSIVE = YES
|
|
IMAGE_PATH =
|
|
INPUT_FILTER =
|
|
FILTER_PATTERNS =
|
|
FILTER_SOURCE_FILES = NO
|
|
FILTER_SOURCE_PATTERNS =
|
|
USE_MDFILE_AS_MAINPAGE = ../../README.md
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to source browsing
|
|
#---------------------------------------------------------------------------
|
|
SOURCE_BROWSER = YES
|
|
INLINE_SOURCES = YES
|
|
STRIP_CODE_COMMENTS = NO
|
|
REFERENCED_BY_RELATION = YES
|
|
REFERENCES_RELATION = YES
|
|
REFERENCES_LINK_SOURCE = YES
|
|
SOURCE_TOOLTIPS = YES
|
|
USE_HTAGS = NO
|
|
VERBATIM_HEADERS = YES
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the alphabetical class index
|
|
#---------------------------------------------------------------------------
|
|
ALPHABETICAL_INDEX = YES
|
|
COLS_IN_ALPHA_INDEX = 5
|
|
IGNORE_PREFIX =
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the HTML output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_HTML = YES
|
|
HTML_OUTPUT = html
|
|
HTML_FILE_EXTENSION = .html
|
|
HTML_HEADER = ../_doxygen/header.html
|
|
HTML_FOOTER = ../_doxygen/footer.html
|
|
HTML_STYLESHEET = ../_doxygen/stylesheet.css
|
|
HTML_EXTRA_STYLESHEET = ../_doxygen/extra_stylesheet.css
|
|
HTML_EXTRA_FILES =
|
|
HTML_COLORSTYLE_HUE = 220
|
|
HTML_COLORSTYLE_SAT = 100
|
|
HTML_COLORSTYLE_GAMMA = 80
|
|
HTML_TIMESTAMP = YES
|
|
HTML_DYNAMIC_MENUS = YES
|
|
HTML_DYNAMIC_SECTIONS = YES
|
|
HTML_INDEX_NUM_ENTRIES = 1000
|
|
GENERATE_DOCSET = NO
|
|
DOCSET_FEEDNAME = "Doxygen generated docs"
|
|
DOCSET_BUNDLE_ID = org.doxygen.rocprofiler-systems
|
|
DOCSET_PUBLISHER_ID = org.doxygen.amd
|
|
DOCSET_PUBLISHER_NAME = "Advanced Micro Devices, Inc."
|
|
GENERATE_HTMLHELP = NO
|
|
CHM_FILE =
|
|
HHC_LOCATION =
|
|
GENERATE_CHI = NO
|
|
CHM_INDEX_ENCODING =
|
|
BINARY_TOC = NO
|
|
TOC_EXPAND = YES
|
|
GENERATE_QHP = NO
|
|
QCH_FILE =
|
|
QHP_NAMESPACE =
|
|
QHP_VIRTUAL_FOLDER = doc
|
|
QHP_CUST_FILTER_NAME =
|
|
QHP_CUST_FILTER_ATTRS =
|
|
QHP_SECT_FILTER_ATTRS =
|
|
QHG_LOCATION =
|
|
GENERATE_ECLIPSEHELP = NO
|
|
ECLIPSE_DOC_ID = org.doxygen.rocprofiler-systems
|
|
DISABLE_INDEX = NO
|
|
GENERATE_TREEVIEW = NO
|
|
ENUM_VALUES_PER_LINE = 1
|
|
TREEVIEW_WIDTH = 300
|
|
EXT_LINKS_IN_WINDOW = YES
|
|
HTML_FORMULA_FORMAT = png
|
|
FORMULA_FONTSIZE = 12
|
|
FORMULA_TRANSPARENT = YES
|
|
FORMULA_MACROFILE =
|
|
USE_MATHJAX = NO
|
|
MATHJAX_FORMAT = HTML-CSS
|
|
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
|
|
MATHJAX_EXTENSIONS =
|
|
MATHJAX_CODEFILE =
|
|
SEARCHENGINE = NO
|
|
SERVER_BASED_SEARCH = NO
|
|
EXTERNAL_SEARCH = NO
|
|
SEARCHENGINE_URL =
|
|
SEARCHDATA_FILE = searchdata.xml
|
|
EXTERNAL_SEARCH_ID =
|
|
EXTRA_SEARCH_MAPPINGS =
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the LaTeX output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_LATEX = NO
|
|
LATEX_OUTPUT = latex
|
|
LATEX_CMD_NAME = latex
|
|
MAKEINDEX_CMD_NAME = makeindex
|
|
LATEX_MAKEINDEX_CMD = makeindex
|
|
COMPACT_LATEX = NO
|
|
PAPER_TYPE = a4wide
|
|
EXTRA_PACKAGES = float
|
|
LATEX_HEADER =
|
|
LATEX_FOOTER =
|
|
LATEX_EXTRA_STYLESHEET =
|
|
LATEX_EXTRA_FILES =
|
|
PDF_HYPERLINKS = YES
|
|
USE_PDFLATEX = YES
|
|
LATEX_BATCHMODE = YES
|
|
LATEX_HIDE_INDICES = NO
|
|
LATEX_SOURCE_CODE = YES
|
|
LATEX_BIB_STYLE = plain
|
|
LATEX_TIMESTAMP = NO
|
|
LATEX_EMOJI_DIRECTORY =
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the RTF output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_RTF = NO
|
|
RTF_OUTPUT = rtf
|
|
COMPACT_RTF = NO
|
|
RTF_HYPERLINKS = NO
|
|
RTF_STYLESHEET_FILE =
|
|
RTF_EXTENSIONS_FILE =
|
|
RTF_SOURCE_CODE = NO
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the man page output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_MAN = NO
|
|
MAN_OUTPUT = man
|
|
MAN_EXTENSION = .3
|
|
MAN_SUBDIR =
|
|
MAN_LINKS = YES
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the XML output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_XML = YES
|
|
XML_OUTPUT = xml
|
|
XML_PROGRAMLISTING = YES
|
|
XML_NS_MEMB_FILE_SCOPE = YES
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the DOCBOOK output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_DOCBOOK = NO
|
|
DOCBOOK_OUTPUT = docbook
|
|
DOCBOOK_PROGRAMLISTING = NO
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options for the AutoGen Definitions output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_AUTOGEN_DEF = NO
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the Perl module output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_PERLMOD = NO
|
|
PERLMOD_LATEX = NO
|
|
PERLMOD_PRETTY = YES
|
|
PERLMOD_MAKEVAR_PREFIX =
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the preprocessor
|
|
#---------------------------------------------------------------------------
|
|
ENABLE_PREPROCESSING = YES
|
|
MACRO_EXPANSION = YES
|
|
EXPAND_ONLY_PREDEF = NO
|
|
SEARCH_INCLUDES = YES
|
|
INCLUDE_PATH = ../../source/lib/rocprof-sys-user
|
|
INCLUDE_FILE_PATTERNS = *.h \
|
|
*.hpp
|
|
PREDEFINED = ROCPROFSYS_PUBLIC_API= \
|
|
ROCPROFSYS_HIDDEN_API= \
|
|
"ROCPROFSYS_ATTRIBUTE(...)=" \
|
|
"ROCPROFSYS_VISIBILITY(...)=" \
|
|
"__attribute__(x)=" \
|
|
"__declspec(x)=" \
|
|
"size_t=unsigned long" \
|
|
"uintptr_t=unsigned long" \
|
|
DOXYGEN_SHOULD_SKIP_THIS
|
|
EXPAND_AS_DEFINED =
|
|
SKIP_FUNCTION_MACROS = NO
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to external references
|
|
#---------------------------------------------------------------------------
|
|
TAGFILES =
|
|
GENERATE_TAGFILE = html/tagfile.xml
|
|
ALLEXTERNALS = NO
|
|
EXTERNAL_GROUPS = YES
|
|
EXTERNAL_PAGES = YES
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the dot tool
|
|
#---------------------------------------------------------------------------
|
|
CLASS_DIAGRAMS = YES
|
|
DIA_PATH =
|
|
HIDE_UNDOC_RELATIONS = NO
|
|
HAVE_DOT = NO
|
|
DOT_NUM_THREADS = 0
|
|
DOT_FONTNAME = Helvetica
|
|
DOT_FONTSIZE = 12
|
|
DOT_FONTPATH =
|
|
CLASS_GRAPH = NO
|
|
COLLABORATION_GRAPH = YES
|
|
GROUP_GRAPHS = YES
|
|
UML_LOOK = YES
|
|
UML_LIMIT_NUM_FIELDS = 10
|
|
TEMPLATE_RELATIONS = YES
|
|
INCLUDE_GRAPH = YES
|
|
INCLUDED_BY_GRAPH = YES
|
|
CALL_GRAPH = NO
|
|
CALLER_GRAPH = NO
|
|
GRAPHICAL_HIERARCHY = YES
|
|
DIRECTORY_GRAPH = YES
|
|
DOT_IMAGE_FORMAT = svg
|
|
INTERACTIVE_SVG = YES
|
|
DOT_PATH = /usr/bin/dot
|
|
DOTFILE_DIRS =
|
|
MSCFILE_DIRS =
|
|
DIAFILE_DIRS =
|
|
PLANTUML_JAR_PATH =
|
|
PLANTUML_CFG_FILE =
|
|
PLANTUML_INCLUDE_PATH =
|
|
DOT_GRAPH_MAX_NODES = 50
|
|
MAX_DOT_GRAPH_DEPTH = 0
|
|
DOT_TRANSPARENT = NO
|
|
DOT_MULTI_TARGETS = YES
|
|
GENERATE_LEGEND = YES
|
|
DOT_CLEANUP = YES
|