summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNĂ­colas F. R. A. Prado <nfraprado@collabora.com>2021-03-17 16:28:28 -0300
committerLaurent Pinchart <laurent.pinchart@ideasonboard.com>2021-03-19 01:54:41 +0200
commitd32accd6540ddd99225f0b87aff662651dd8d9d1 (patch)
treede8eb53f9719e725bfd8e3c6f8bc8eae690c1320
parent7ebc19752a32e42f7a8eee194c1a243b0f41121c (diff)
Documentation: environment-variables: Use standard rST link syntax
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 <nfraprado@collabora.com> Reviewed-by: Sebastian Fricke <sebastian.fricke@posteo.net> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
-rw-r--r--Documentation/environment_variables.rst12
1 files changed, 6 insertions, 6 deletions
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 <Log levels_>`__).
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 <IPA configuration_>`__).
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 <IPA module_>`__).
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 <Log levels_>`__ 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 <Log categories_>`__ 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 <http://libcamera.org/api-h
Examples:
-Enable full debug output to a separate file, for every `category <#log-categories>`__
+Enable full debug output to a separate file, for every `category <Log categories_>`__
within a local environment:
.. code:: bash