Add documentation for the --logfile option

809f1da5 · Javier D. Garcia-Lasheras · bc1607fd · 809f1da5
Commit 809f1da5 authored Jun 15, 2017 by Javier D. Garcia-Lasheras
Hide whitespace changes
Inline Side-by-side

Showing with 10 additions and 0 deletions

index.rst docs/index.rst +10 -0

No files found.
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1552,6 +1552,16 @@ Set logging level for the Python logger facility. You can choose one of the leve
 | not provided  | 0             |
 +---------------+---------------+

+``--logfile LOGFILE``
+---------------------
+
+Use a file to store all of the log information generated by ``hdlmake``. For example, if we want to list the files contained by a design while storing the log in ``/var/log/hdlmake.log``, we should run the following command:
+
+.. code-block:: bash
+
+   hdlmake --logfile /var/log/hdlmake.log list-files
+
+

 ``-p, --prefix ARBITRARY_CODE``
 -------------------------------