Skip to content

Commit

Permalink
Minor documentation fixes [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
daboehme committed Jun 12, 2021
1 parent 1bd1ff2 commit f59cfc3
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions doc/sphinx/CaliperBasics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ An easy way to do this is to use one of Caliper's built-in measurement
configurations. For example, the `runtime-report` config prints out the time
spent in the annotated regions. You can activate built-in measurement
configurations with the :ref:`configmgr_api` or with the
:doc:envvar:`CALI_CONFIG` environment variable.
:envvar:`CALI_CONFIG` environment variable.
Let's try this on Caliper's cxx-example program:

.. code-block:: sh
Expand Down Expand Up @@ -273,7 +273,7 @@ Notes:

* Multiple ConfigManager objects can co-exist in a program.
* The ConfigManager API can be used in combination with
the :doc:envvar:`CALI_CONFIG` environment variable or manual
the :envvar:`CALI_CONFIG` environment variable or manual
configurations.

.. _more-on-configurations:
Expand All @@ -282,7 +282,7 @@ More on configurations
--------------------------------

A configuration string for the ConfigManager API or the
:doc:envvar:`CALI_CONFIG` environment variable is a comma-separated list of
:envvar:`CALI_CONFIG` environment variable is a comma-separated list of
*configs* and *parameters*.

A *config* is the name of one of Caliper's built-in measurement configurations,
Expand Down
2 changes: 1 addition & 1 deletion doc/sphinx/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Configuration variables
........................................

These variables can be set using environment variables, config files,
or the configuration API).
or the configuration API.

CALI_CONFIG_FILE
Comma-separated list of configuration files. The provided
Expand Down
2 changes: 1 addition & 1 deletion src/caliper/controllers/OpenMPReportController.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ make_controller(const char* name, const config_map_t& initial_cfg, const cali::C
const char* controller_spec =
"{"
" \"name\" : \"openmp-report\","
" \"description\" : \"Record and print CUDA activities (kernel executions, memcopies, etc.)\","
" \"description\" : \"Record and print OpenMP performance metrics (loops, barriers, etc.)\","
" \"categories\" : [ \"output\", \"region\", \"metric\" ],"
" \"services\" : [ \"aggregate\", \"ompt\", \"event\" ],"
" \"config\" : "
Expand Down

0 comments on commit f59cfc3

Please sign in to comment.