From patchwork Wed Mar 17 19:28:28 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?b?TsOtY29sYXMgRi4gUi4gQS4gUHJhZG8=?= X-Patchwork-Id: 11609 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id C16A7BD80C for ; Wed, 17 Mar 2021 22:53:48 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id DBB4168D6B; Wed, 17 Mar 2021 23:53:46 +0100 (CET) Received: from bhuna.collabora.co.uk (bhuna.collabora.co.uk [IPv6:2a00:1098:0:82:1000:25:2eeb:e3e3]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 04DDD68D50 for ; Wed, 17 Mar 2021 20:29:15 +0100 (CET) Received: from [127.0.0.1] (localhost [127.0.0.1]) (Authenticated sender: nfraprado) with ESMTPSA id BC4501F453D8 From: =?utf-8?b?TsOtY29sYXMgRi4gUi4gQS4gUHJhZG8=?= To: libcamera-devel@lists.libcamera.org Date: Wed, 17 Mar 2021 16:28:28 -0300 Message-Id: <20210317192831.359014-3-nfraprado@collabora.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20210317192831.359014-1-nfraprado@collabora.com> References: <20210317192831.359014-1-nfraprado@collabora.com> MIME-Version: 1.0 X-Mailman-Approved-At: Wed, 17 Mar 2021 23:53:43 +0100 Subject: [libcamera-devel] [PATCH 2/5] Documentation: environment-variables: Use standard rST link syntax X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Chris Chinchilla , Sebastian Fricke Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" 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 --- Documentation/environment_variables.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Documentation/environment_variables.rst b/Documentation/environment_variables.rst index e482c98e5f30..d392fd26b87a 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