From 779399c4dbaa0c6f3faf660af42bfb3cffc8453e Mon Sep 17 00:00:00 2001
From: "Salvador E. Tropea" <salvador@inti.gob.ar>
Date: Wed, 1 Dec 2021 14:18:56 -0300
Subject: [PATCH] Documented the global `out_dir` option.

---
 README.md      | 10 ++++++++++
 docs/README.in | 10 ++++++++++
 2 files changed, 20 insertions(+)

diff --git a/README.md b/README.md
index 8e95c03b..c114718f 100644
--- a/README.md
+++ b/README.md
@@ -23,7 +23,9 @@
     * [Filtering DRC and ERC errors](#filtering-drc-and-erc-errors)
   * [Default global options](#default-global-options)
     * [Default *output* option](#default-output-option)
+    * [Default *dir* option](#default-dir-option)
     * [Default *variant* option](#default-variant-option)
+    * [Output directory option](#output-directory-option)
     * [Filtering KiBot warnings](#filtering-kibot-warnings)
   * [Filters and variants](#filters-and-variants)
     * [Supported filters](#supported-filters)
@@ -246,6 +248,14 @@ global:
   variant: 'production'
 ```
 
+#### Output directory option
+
+The `out_dir` option can define the base outut directory. This is the same as the `-d`/`--out-dir` command line option.
+Note that the command line option has precedence over it.
+
+Expansion patterns are applied to this value, but you should avoid using patterns that expand according to the context, i.e. **%c**, **%d**, **%f**, **%F**, **%p** and **%r**.
+The behavior of these patterns isn't fully defined in this case and the results may change in the future.
+
 #### Filtering KiBot warnings
 
 KiBot warnings are marked with `(Wn)` where *n* is the warning id.
diff --git a/docs/README.in b/docs/README.in
index 1ce83cb6..30a76825 100644
--- a/docs/README.in
+++ b/docs/README.in
@@ -23,7 +23,9 @@
     * [Filtering DRC and ERC errors](#filtering-drc-and-erc-errors)
   * [Default global options](#default-global-options)
     * [Default *output* option](#default-output-option)
+    * [Default *dir* option](#default-dir-option)
     * [Default *variant* option](#default-variant-option)
+    * [Output directory option](#output-directory-option)
     * [Filtering KiBot warnings](#filtering-kibot-warnings)
   * [Filters and variants](#filters-and-variants)
     * [Supported filters](#supported-filters)
@@ -225,6 +227,14 @@ global:
   variant: 'production'
 ```
 
+#### Output directory option
+
+The `out_dir` option can define the base outut directory. This is the same as the `-d`/`--out-dir` command line option.
+Note that the command line option has precedence over it.
+
+Expansion patterns are applied to this value, but you should avoid using patterns that expand according to the context, i.e. **%c**, **%d**, **%f**, **%F**, **%p** and **%r**.
+The behavior of these patterns isn't fully defined in this case and the results may change in the future.
+
 #### Filtering KiBot warnings
 
 KiBot warnings are marked with `(Wn)` where *n* is the warning id.