From d32accd6540ddd99225f0b87aff662651dd8d9d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?N=C3=ADcolas=20F=2E=20R=2E=20A=2E=20Prado?= Date: Wed, 17 Mar 2021 16:28:28 -0300 Subject: Documentation: environment-variables: Use standard rST link syntax MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The usage of # in embedded URIs for references to sections in reStructuredText is HTML specific. Use the standard rST reference to targets instead, to be compatible with other formats as well, should this documentation ever be exported to PDF, for example. See [1] for an equivalent commit in the Linux Kernel documentation. [1] https://lore.kernel.org/linux-doc/20201228144537.135353-1-nfraprado@protonmail.com/ Signed-off-by: Nícolas F. R. A. Prado Reviewed-by: Sebastian Fricke Reviewed-by: Laurent Pinchart Signed-off-by: Laurent Pinchart --- Documentation/environment_variables.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'Documentation') diff --git a/Documentation/environment_variables.rst b/Documentation/environment_variables.rst index e482c98e..d392fd26 100644 --- a/Documentation/environment_variables.rst +++ b/Documentation/environment_variables.rst @@ -15,17 +15,17 @@ LIBCAMERA_LOG_FILE Example value: ``/home/{user}/camera_log.log`` LIBCAMERA_LOG_LEVELS - Configure the verbosity of log messages for different categories (`more <#log-levels>`__). + Configure the verbosity of log messages for different categories (`more `__). Example value: ``*:DEBUG`` LIBCAMERA_IPA_CONFIG_PATH - Define custom search locations for IPA configurations (`more <#ipa-configuration>`__). + Define custom search locations for IPA configurations (`more `__). Example value: ``${HOME}/.libcamera/share/ipa:/opt/libcamera/vendor/share/ipa`` LIBCAMERA_IPA_MODULE_PATH - Define custom search locations for IPA modules (`more <#ipa-module>`__). + Define custom search locations for IPA modules (`more `__). Example value: ``${HOME}/.libcamera/lib:/opt/libcamera/vendor/lib`` @@ -42,10 +42,10 @@ libcamera. The ``LIBCAMERA_LOG_LEVELS`` variable accepts a comma-separated list of 'category:level' pairs. -The `level <#log-levels>`__ part is mandatory and can either be specified by +The `level `__ part is mandatory and can either be specified by name or by numerical index associated with each level. -The optional `category <#log-categories>`__ is a string matching the categories +The optional `category `__ is a string matching the categories defined by each file in the source base using the logging infrastructure. It can include a wildcard ('*') character at the end to match multiple categories. @@ -53,7 +53,7 @@ For more information refer to the `API documentation `__ +Enable full debug output to a separate file, for every `category `__ within a local environment: .. code:: bash -- cgit v1.2.1