clean up

Signed-off-by: Peter Jun Park <peter.park@amd.com>

docs/conceptual/includes/high-level-design.rst

@@ -8,23 +8,25 @@ following diagram.
 
 Core Omniperf profiler
    Acquires raw performance counters via application replay using ``rocprof``.
-   Counters are stored in a comma-separated-values format for further analysis.
-   It runs a set of accelerator-specific micro benchmarks to acquire
-   hierarchical roofline data. The roofline model is not available on
-   accelerators pre-MI200.
+   Counters are stored in a comma-separated-values format for further
+   :ref:`analysis <cli-analysis>`. It runs a set of accelerator-specific micro
+   benchmarks to acquire hierarchical roofline data. The roofline model is not
+   available on accelerators pre-MI200.
 
-Grafana analyzer for Omniperf
+Grafana server for Omniperf
    * **Grafana database import**: All raw performance counters are imported into
-     the a backend MongoDB database to support analysis and visualization in the
-     Grafana GUI. Compatibility with previously generated data using older
-     Omniperf versions is not guaranteed.
-   * **Grafana dashboard GUI**: The Grafana dashboard retrieves the raw counters
-     information from the backend database. It displays the relevant performance
-     metrics and visualization.
+     the a :ref:`backend MongoDB database <grafana-mongodb-setup>` to support
+     analysis and visualization in the Grafana GUI. Compatibility with
+     previously generated data using older Omniperf versions is not guaranteed.
+   * **Grafana analysis dashboard GUI**: The
+     :ref:`Grafana dashboard <grafana-analysis>` retrieves the raw counters
+     information from the backend database. It displays the relevant
+     performance metrics and visualization.
 
-Omniperf standalone GUI analyzer
-   Omniperf provides a standalone GUI to enable basic performance analysis
-   without the need to import data into a database instance.
+Omniperf standalone analysis GUI
+   Omniperf provides a :ref:`standalone GUI <standalone-gui-analysis>` to enable
+   basic performance analysis without the need to import data into a database
+   instance.
 
 .. figure:: ./data/omniperf_server_vs_client_install.png
    :align: center

docs/how-to/includes/modes.rst

@@ -37,7 +37,7 @@ Analyze mode
    generated metrics. It generates metrics from the entirety of your profiled
    application or a subset identified through the Omniperf CLI analysis filters.
 
-   To generate a lightweight GUI interface, you can add the `--gui` flag to your
+   To generate a lightweight GUI interface, you can add the ``--gui`` flag to your
    analysis command.
 
    This mode is a middle ground to the highly detailed Omniperf Grafana GUI and
@@ -57,11 +57,11 @@ Database mode
 -------------
 
 ``database``
-   The :doc:`Grafana GUI dashboard <../install/grafana-setup>` is built on a
-   MongoDB database. ``--import`` profiling results to the DB to interact with
-   the workload in Grafana or `--remove` the workload from the DB.
+   The Grafana analyzer GUI is built on a MongoDB database. ``--import``
+   profiling results to the DB to interact with the workload in Grafana or
+   ``--remove`` the workload from the DB.
 
-   Connection options need to be specified. See :ref:`grafana-gui-import` for
+   Connection options need to be specified. See :ref:`grafana-analysis` for
    more details.
 
    .. code-block:: shell

docs/how-to/use.rst

@@ -89,6 +89,8 @@ workload path.
 ``-p``, ``--path``
    Enables you to analyze existing profiling data in the Omniperf CLI.
 
+See :ref:`cli-analysis` for more detailed information.
+
 .. _basic-analyze-grafana:
 
 Analyze in the Grafana GUI
@@ -100,15 +102,36 @@ data to the MongoDB instance included in the Omniperf Dockerfile. See
 :doc:`../install/grafana-setup`.
 
 To interact with Grafana data, stored in the Omniperf database, enter
-``database`` :ref:`mode <modes>`; for example:
+``database`` :ref:`mode <modes-database>`; for example:
 
 .. code-block:: shell
 
    $ omniperf database --import [CONNECTION OPTIONS]
 
+See :ref:`grafana-analysis` for more detailed information.
+
 .. include:: ./includes/modes.rst
 
-.. include:: ./includes/global-options.rst
+.. _global-options:
+
+Global options
+==============
+
+The Omniperf command line tool has a set of *global* utility options that are
+available across all modes. 
+
+``-v``, ``--version``
+   Prints the Omniperf version and exits.
+
+``-V``, ``--verbose``
+   Increases output verbosity. Use multiple times for higher levels of
+   verbosity.
+
+``-q``, ``--quiet``
+   Reduces output verbosity and runs quietly.
+
+``-s``, ``--specs``
+   Prints system specs and exits.
 
 .. note::
 

docs/index.rst

@@ -7,7 +7,7 @@ Omniperf
 ********
 
 Omniperf documentation provides a detailed breakdown of all facets of Omniperf.
-In addition to a full deployment guide with installation instructions, this 
+In addition to a full deployment guide with installation instructions, this
 documentation also explains the ideas motivating the design behind the tool and
 its components.
 
@@ -56,10 +56,10 @@ in practice.
       * :doc:`license`
 
 
-This project is proudly open source and we welcome all feedback. For more
-details on how to contribute, refer to `Contributing to ROCm
-<https://rocm.docs.amd.com/en/latest/contribute/contributing.html>`_.
+This project is proudly open source; all feedback is welcome. For more details
+on how to contribute, refer to
+`Contributing to ROCm <https://rocm.docs.amd.com/en/latest/contribute/contributing.html>`_.
 
-Find licensing information on the
+Find ROCm licensing information on the
 `Licensing <https://rocm.docs.amd.com/en/latest/about/license.html>`_ page.
 

docs/install/grafana-setup.rst

@@ -73,6 +73,7 @@ directory to begin.
 
 .. code-block:: bash
 
+   $ cd grafana
    $ sudo docker-compose build
    $ sudo docker-compose up -d