From patchwork Mon Jan 25 20:14:04 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Heinrich Schuchardt X-Patchwork-Id: 1431366 X-Patchwork-Delegate: xypron.glpk@gmx.de Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=lists.denx.de (client-ip=2a01:238:438b:c500:173d:9f52:ddab:ee01; helo=phobos.denx.de; envelope-from=u-boot-bounces@lists.denx.de; receiver=) Authentication-Results: ozlabs.org; dkim=pass (1024-bit key; secure) header.d=gmx.net header.i=@gmx.net header.a=rsa-sha256 header.s=badeba3b8450 header.b=lfGtPvsS; dkim-atps=neutral Received: from phobos.denx.de (phobos.denx.de [IPv6:2a01:238:438b:c500:173d:9f52:ddab:ee01]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 4DPh0s0GDWz9sS8 for ; Tue, 26 Jan 2021 07:14:36 +1100 (AEDT) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 0717D82666; Mon, 25 Jan 2021 21:14:21 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=fail (p=none dis=none) header.from=gmx.de Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (1024-bit key; secure) header.d=gmx.net header.i=@gmx.net header.b="lfGtPvsS"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 2E59482667; Mon, 25 Jan 2021 21:14:18 +0100 (CET) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on phobos.denx.de X-Spam-Level: X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,FREEMAIL_FROM,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL,SPF_HELO_NONE autolearn=ham autolearn_force=no version=3.4.2 Received: from mout.gmx.net (mout.gmx.net [212.227.17.22]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id AF129806C5 for ; Mon, 25 Jan 2021 21:14:14 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=gmx.de Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=xypron.glpk@gmx.de DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.net; s=badeba3b8450; t=1611605653; bh=r0qFQ+sC4fpn0Z6G4ty8KqW/Jsw3ES9sRfVQpNJEw+I=; h=X-UI-Sender-Class:From:To:Cc:Subject:Date; b=lfGtPvsS4cRHy+MmIVAAffIE4DHzlzE1iEHI0LYJFkV1u7yrwdVb62PUIEPDdxcEY Be32DlnFbSDj3wSUUXIdxBOfUlCco/i5S/LanY9Odg6r0OUK+Q1DIrZLxL3zHmDw6G 71RM1kViNWBe3E6wTvI1YgJpmpIs5T2cN6Pk05qk= X-UI-Sender-Class: 01bb95c1-4bf8-414a-932a-4f6e2808ef9c Received: from localhost.localdomain ([62.143.246.89]) by mail.gmx.net (mrgmx105 [212.227.17.174]) with ESMTPSA (Nemesis) id 1Mo6qp-1lndDa11Vz-00pZoV; Mon, 25 Jan 2021 21:14:13 +0100 From: Heinrich Schuchardt To: Tom Rini Cc: imon Glass , u-boot@lists.denx.de, Heinrich Schuchardt Subject: [PATCH 1/1] doc: fix doc/develop/logging.rst Date: Mon, 25 Jan 2021 21:14:04 +0100 Message-Id: <20210125201404.66001-1-xypron.glpk@gmx.de> X-Mailer: git-send-email 2.29.2 MIME-Version: 1.0 X-Provags-ID: V03:K1:X7HB4i1hag2WQHF6W4WJxoMH+ugHN0HXJ7+SCLX/O2nptPKzjr3 bSr+8EjelIYfFzGW7zomqH0YFvKBly8hdSAS43q5xuKjLnN2I6qkFBDH0p0qCpxeJf7/D4v z5bHahER53DPH5LWKJktJHbGbVyfRXqqUbUHYQGM9w1cnzKcCDCde6XDfWwaOcXAt8gBo8E 2lkGMEpINAHmCWr36Cakw== X-UI-Out-Filterresults: notjunk:1;V03:K0:E0fli1+iJuU=:x4YglSJOCvIkzNQWDCp/TZ oSX08z4ofqSxMiOPEgRE9g/E8Ll6lTKUQso10NcPV1s3AZOgIaL4/MxAahUY7Fyu/+yBC2qN+ 2OpkjLbCczL99crZuToI/w9fhpkyK4tK2ZrfohEzFvAn+0Ij2I4YfN2ZD5uHev1lfkO3r6YfT +0dDw2RBGDWjm1v3gFBt61FWRLgw4f+5ftWvM1zoz3QQtyljizFcDYXWJ+GKPpkLsdF+e7ny+ FYg4PgMFMY+OU3/dpy8JvB+JK0vbycmeURUsvutmmuNGrCdbgie70khAFG0gYEJZkVnN4+HwL nRisoMiiyRG0hYYzx3qOx0fiqcazRFF1unxmQg5Lh1MGCvAVsE/OS6TbzsMT4DMIB1Y0QLcXU maxiCeqyWUTIszoikqVce/NKqI8xnOQnbinlJ0XpafUC5+Q5iH59pcJj4Gg1r7WuvI6SZp01o v0KPi4tSgKeLn/nt9bB55thJlk1MCy8F3W8mMhwf+k0cu8sgzOIdxu7qT4HqMaLoPHXQ1BXT/ YFyXF826ssSfK+G1mZLfiofWysrJix97gPFAKvg/zyklABqnr9fE4mt58yj/OYce5EsHRqlmo RHTfG/VNNO1Vhkag0AH8zN+klQ/0RkqlaVL9a/QMmVUb6BG7ZH1BtvJ5sek4GKqhOCwbhFjxU R4bjMi9KAwvi4MGMIpBcJdgBzZXmt/M496go/BCNYVf7FMIfPxfKnnTr1ai8Jh1Xt5MFUHh6a tdvc3jOCBUUUPuh7Tm1LNLzhtyZN9Wvrakw8zedsa2KHmNn+w3682WJxjZBW2YYx56M+XsK4e tU9X7hJwRITxhdlIpRCBMkwvA1doTEvU5OUqq1jAFO47JeVht5Vs5X7HEQpjbUS4jSx+CRfPj YrkrHlgq7WH8Qocwp7aw== X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.34 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" X-Virus-Scanned: clamav-milter 0.102.3 at phobos.denx.de X-Virus-Status: Clean Sphinx 3 builds fail due to doc/develop/logging.rst producing duplicate labels. Include logging.h only once in the API section and use cross-references for the enums log_level_t and log_category_t. Signed-off-by: Heinrich Schuchardt --- doc/api/index.rst | 1 + doc/api/logging.rst | 6 ++++++ doc/develop/logging.rst | 13 +++---------- 3 files changed, 10 insertions(+), 10 deletions(-) create mode 100644 doc/api/logging.rst -- 2.29.2 diff --git a/doc/api/index.rst b/doc/api/index.rst index cbecd10755..ea02aa5715 100644 --- a/doc/api/index.rst +++ b/doc/api/index.rst @@ -10,6 +10,7 @@ U-Boot API documentation efi getopt linker_lists + logging pinctrl rng sandbox diff --git a/doc/api/logging.rst b/doc/api/logging.rst new file mode 100644 index 0000000000..1e6cbc4931 --- /dev/null +++ b/doc/api/logging.rst @@ -0,0 +1,6 @@ +.. SPDX-License-Identifier: GPL-2.0+ + +Logging API +=========== + +.. kernel-doc:: include/log.h diff --git a/doc/develop/logging.rst b/doc/develop/logging.rst index 7fdd1132ef..60c18c5b3a 100644 --- a/doc/develop/logging.rst +++ b/doc/develop/logging.rst @@ -26,8 +26,7 @@ Logging levels There are a number logging levels available. -.. kernel-doc:: include/log.h - :identifiers: log_level_t +See enum :c:type:`log_level_t` Logging category ---------------- @@ -36,8 +35,7 @@ Logging can come from a wide variety of places within U-Boot. Each log message has a category which is intended to allow messages to be filtered according to their source. -.. kernel-doc:: include/log.h - :identifiers: log_category_t +See enum :c:type:`log_category_t` Enabling logging ---------------- @@ -67,7 +65,7 @@ to enable building in of all logging statements in a single file. Put it at the top of the file, before any #includes. To actually get U-Boot to output this you need to also set the default logging -level - e.g. set CONFIG_LOG_DEFAULT_LEVEL to 7 (:c:type:`LOGL_DEBUG`) or more. +level - e.g. set CONFIG_LOG_DEFAULT_LEVEL to 7 (:c:data:`LOGL_DEBUG`) or more. Otherwise debug output is suppressed and will not be generated. Using DEBUG @@ -290,8 +288,3 @@ number dropped due to them being generated before the log system was ready. Add a printf() format string pragma so that log statements are checked properly Add a command to delete existing log records. - -Logging API ------------ -.. kernel-doc:: include/log.h - :internal: