From be5dc28303f8c3b1f893565f033b7af5c88e98f9 Mon Sep 17 00:00:00 2001 From: Betsy Gitelman Date: Wed, 13 Mar 2024 16:23:19 -0400 Subject: [PATCH] Edits to PWR PR5380 --- product_docs/docs/pwr/1/configuring.mdx | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/product_docs/docs/pwr/1/configuring.mdx b/product_docs/docs/pwr/1/configuring.mdx index 7c9b8e6bd18..3aaf0181356 100644 --- a/product_docs/docs/pwr/1/configuring.mdx +++ b/product_docs/docs/pwr/1/configuring.mdx @@ -8,7 +8,7 @@ To reduce the number of command-line arguments needed when executing `pwr`, you ## Configuration file locations -Postgres Workload Report looks for a configuration file in the following places, and uses the first one found: +Postgres Workload Report looks for a configuration file in the following places and uses the first one found: 1. The file named in the `--config` command-line option, if given. 2. The file named in the `PWR_CONFIG_FILE` environment variable, if set. @@ -16,27 +16,27 @@ Postgres Workload Report looks for a configuration file in the following places, 4. `/etc/pwr.conf`. The installation package creates a template for the configuration file in `/etc/pwr.conf.templ`. We recommend copying this file to one of the -two places where Postgres Workload Report looks for a configuration file by default (locations #3 or #4 in the previous list), and editing the options in the template as necessary. +two places where Postgres Workload Report looks for a configuration file by default (`~/.pwr.conf` and `/etc/pwr.conf`), and editing the options in the template as necessary. !!! Note -If no configuration file is found, Postgres Workload Report assumes the default value for all options, which can still be overriden via the corresponding command-line options. See [Using Postgres Workload Report](using/) for more on using command-line options. +If no configuration file is found, Postgres Workload Report assumes the default value for all options, which you can still override using the corresponding command-line options. See [Using Postgres Workload Report](using/) for more on using command-line options. !!! ## Configuration file options ### `input_dir` -An existing directory where the `edb_wait_states` portion of a Lasso report are located. This option is used mainly for `pwr report` execution (see [Using Postgres Workload Report](using)). +An existing directory where the `edb_wait_states` portion of a Lasso report is located. This option is used mainly for `pwr report` execution (see [Using Postgres Workload Report](using)). ### `output_dir` -Location of the directory where Postgres Workload Report writes report files. Executing `pwr` will create this directory if it doesn't exist. +Location of the directory where Postgres Workload Report writes report files. Executing `pwr` creates this directory if it doesn't exist. ### `report_name` -The name of the report files generated. Usually, you would specify this option on the command line because different reports typically have different names. +The name of the report files generated. Usually, you specify this option on the command line because different reports typically have different names. -Don't include a file extension; an appropriate extension will be added will be added based on the output format(s) specified on the command line (`--pdf` adds `.pdf`, `--html` adds `.html`, and so on). +Don't include a file extension. An appropriate extension is added based on the output formats specified on the command line (that is, `--pdf` adds `.pdf`, `--html` adds `.html`, and so on). ### `log_file`