From patchwork Tue Apr 29 09:57:34 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jerome Forissier X-Patchwork-Id: 885716 Delivered-To: patch@linaro.org Received: by 2002:a5d:4884:0:b0:38f:210b:807b with SMTP id g4csp230693wrq; Tue, 29 Apr 2025 02:58:07 -0700 (PDT) X-Forwarded-Encrypted: i=2; AJvYcCWKscMxuMFaArl3CWL1vzyDjRpKu0gjuLqMGptNS+KyMhZ29ZpY0mLbIIZdQCmE9WSn1F5PwQ==@linaro.org X-Google-Smtp-Source: AGHT+IG+zSemKVSfdu573L2JSbgcxbSlrwIiTuHiAUsnT9Nf7OKcd1XTTDFhyOFPsHZgAttwazB4 X-Received: by 2002:a05:6000:4009:b0:3a0:849b:23a2 with SMTP id ffacd0b85a97d-3a0891b7fe1mr2356883f8f.25.1745920687436; Tue, 29 Apr 2025 02:58:07 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1745920687; cv=none; d=google.com; s=arc-20240605; b=UfPZOIDmYK4p2gN3W//cIMcIfps+3TM4p+Rg5rieByECoUto8AoZ/pvrq5RjIOolaF sumwe27AwgwZLAPN5Slb9i62+tWN8mI80C2IcGxZJnI0OrJrNp93jdH3fKe0I+uLvDEZ Jiub5/uEZC7INiowWEMC1kEnlQJejq+XmiWgetipYw/2ESU44B8Mt09Wy32bh2VI6CSh jJw8l2KL+JGN0Kjbmom+KYJjEzDSQiajwWBmEB7C7vAdqRxKqHMWhB9wMcyGYCWevp+7 zbo8wEN1+/57Qb/uvrjB2C8lrWcU9XOQDq516piWlCsf6F5+QpMbGBJ/HY0cy7Zan8g+ a/4g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20240605; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:message-id:date:subject:cc:to:from:dkim-signature; bh=0/z4Y/R/KQCEDvxoLHcyllV3vfJ/KcFBw3AcCvdqpq8=; fh=WnLQaXFU18x7HV+KShAyewTt5NpjTtgwJj54vQpB6mE=; b=Y/noLvdkTfwOQ52NH2IB73btvt6U4GFoNYCPRM6JImDJ4N9Kgke7UJMjmqxc/QrjCi biEQT1tH5a88ZoVrbOFr/ZsLP3o8eiU5+oMBwYX5cgpksxzvYWjrJW6qquHTfmEZGYmV pyCUtO3i0/SB3KpwtNV2mXtiud3X3UUID38u86u9vJzfpcqPGCskHOcJVT+RNubyIEOF vTe8ytjMYib9mTw9Eydi7pwh0VT87wL1SjBmKsQFgmTHA2J9mua26fkcphcCbcmRWE21 zzYQProymWe6mAgek0EPB0tCH6O6wWc6UGbMECt9zqcY/5Q/mbegY1ZQC65AU4MKkaD3 wkEA==; dara=google.com ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=V2FN19zw; spf=pass (google.com: domain of u-boot-bounces@lists.denx.de designates 85.214.62.61 as permitted sender) smtp.mailfrom=u-boot-bounces@lists.denx.de; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org; dara=neutral header.i=@linaro.org Return-Path: Received: from phobos.denx.de (phobos.denx.de. [85.214.62.61]) by mx.google.com with ESMTPS id ffacd0b85a97d-3a073c91e1bsi6371872f8f.65.2025.04.29.02.58.07 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 29 Apr 2025 02:58:07 -0700 (PDT) Received-SPF: pass (google.com: domain of u-boot-bounces@lists.denx.de designates 85.214.62.61 as permitted sender) client-ip=85.214.62.61; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=V2FN19zw; spf=pass (google.com: domain of u-boot-bounces@lists.denx.de designates 85.214.62.61 as permitted sender) smtp.mailfrom=u-boot-bounces@lists.denx.de; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org; dara=neutral header.i=@linaro.org Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 5454F80BAD; Tue, 29 Apr 2025 11:58:06 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (2048-bit key; unprotected) header.d=linaro.org header.i=@linaro.org header.b="V2FN19zw"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id DECAE80F03; Tue, 29 Apr 2025 11:58:04 +0200 (CEST) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on phobos.denx.de X-Spam-Level: X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_BLOCKED, SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.2 Received: from mail-wm1-x32d.google.com (mail-wm1-x32d.google.com [IPv6:2a00:1450:4864:20::32d]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id C4B70809A5 for ; Tue, 29 Apr 2025 11:58:02 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=jerome.forissier@linaro.org Received: by mail-wm1-x32d.google.com with SMTP id 5b1f17b1804b1-43cfe63c592so59401315e9.2 for ; Tue, 29 Apr 2025 02:58:02 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1745920682; x=1746525482; darn=lists.denx.de; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=0/z4Y/R/KQCEDvxoLHcyllV3vfJ/KcFBw3AcCvdqpq8=; b=V2FN19zwFjls8cvyqoC0D/IqpauRhzHIso/iDiR8m5NppHb2143xT5pxkfTVrtlxm3 a8c2c4yjfGPfwRF+9vZdFJ+9ynFtTIdcuTqCB7rRcviETFP6ZucL/cTqqW5qIPxErh+k +rT6k7E/ADdbtnGi0ngkt2gzmTpkFtuNtcvpSa4cop50R5Bwkwq15TSnAqh0XxWh4ZAl v8Pa6RHy21LVn+FW+HsNPBYamAv+zdG7w+4mfm6xISPxKktEloQTPUSHL21s6heW6kOz JPCJOEkjB5yldil0JE1bT2vYEUVElDndwdFbUalHwQkyFcTXbeZ4bGZpYAArr+tv1lXw r2ug== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1745920682; x=1746525482; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=0/z4Y/R/KQCEDvxoLHcyllV3vfJ/KcFBw3AcCvdqpq8=; b=Sks9y7REY+2ZQLQssRvW+lQ+Eun0pIFpNqTMDalHBsY7I4SgXCbZNaN/yTAmcdRTfL ctEBRPGVLKJtJhbjjO4h3D/vNOyADLuDzEIiYuabZGN3a7zfGEhO01nLfPBAtO1sfgNl GdVUyBjM7YBtkfNDRYxOeL2BsgNwnDubRXOFJBrrvmUovVxRRMOrdlFZb1C0Cy3QlqjF VYxJt9JV7b7KNc+7FZW8AJ3jOCPOXKR108E+ByI0mDInGm/c8+kEaTJHSPDE2jYMpsTC UE2iwYyWkF49uRaE4VTgaqTevfDvkS0Sa86Qs6M4b6UINnpJgl+HYfz4QWwKlwVt8EWG HwiA== X-Gm-Message-State: AOJu0YwcKcsWv+s8ycftUiF3nGGFwZXH9wpxYikZI2653sUMmfXV4qfn /xSVA5bs6PtlJMykxAJ4kmg1nNFjICr6u1PhqIzJP1WgshNo1lE9mVAfPn0VY2m7rsc6XtSLw07 PbqM= X-Gm-Gg: ASbGncve7c74eniJQhcaCYZ1QEO8NtM/RKrBp6uSZEUDLUGHkUreQBKkmRhCpXTsy2u 0zeD29ZrVeSiaABS4ogl7czV0r8kPNx2qK2k8d1ozKdiNB6Jjkwp1xsxmKkVmlHzj13Fdp6WYvh gKs32Q4yPDqu5jmxlCz29gxJx2hTS3eoxY9ZEhRwMRtWQhK3wxNYH3OOEJVy/qUL01MSJANnlco I70hfSIkzNXeHa4I+81ARCvJ1o1/ZQ0G1gIviOx484kiXRwvJin2uC8tYuAF3uQ+cuAEABL4wW/ 8ZbAvqXH6YwupDPYWMMb61MSQrtsZ2Jhp0/GhOat6lfFSP7tcw== X-Received: by 2002:a05:600c:5247:b0:43c:ef55:f1e8 with SMTP id 5b1f17b1804b1-441ac856c92mr22357445e9.13.1745920682064; Tue, 29 Apr 2025 02:58:02 -0700 (PDT) Received: from builder.. ([2a01:e0a:3cb:7bb0:af71:dfb2:66ef:80c3]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-440a5a74314sm155792445e9.4.2025.04.29.02.58.01 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 29 Apr 2025 02:58:01 -0700 (PDT) From: Jerome Forissier To: U-Boot mailing list Cc: Jerome Forissier , Tom Rini , Ilias Apalodimas Subject: [PATCH] uthread: doc: fix inline documentation Date: Tue, 29 Apr 2025 11:57:34 +0200 Message-ID: <20250429095747.3867260-1-jerome.forissier@linaro.org> X-Mailer: git-send-email 2.43.0 MIME-Version: 1.0 X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.39 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.103.8 at phobos.denx.de X-Virus-Status: Clean Fix Sphinx warnings: $ make htmldocs [...] ./include/uthread.h:56: warning: cannot understand function prototype: 'enum uthread_mutex_state ' ./include/uthread.h:64: warning: cannot understand function prototype: 'struct uthread_mutex ' ./include/uthread.h:56: warning: cannot understand function prototype: 'enum uthread_mutex_state ' ./include/uthread.h:64: warning: cannot understand function prototype: 'struct uthread_mutex ' Signed-off-by: Jerome Forissier Reported-by: Tom Rini Acked-by: Ilias Apalodimas --- include/uthread.h | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/include/uthread.h b/include/uthread.h index 89fa552a6f6..11a19aa9488 100644 --- a/include/uthread.h +++ b/include/uthread.h @@ -51,7 +51,10 @@ struct uthread { }; /** - * Internal state of a struct uthread_mutex + * enum uthread_mutex_state - internal state of a struct uthread_mutex + * + * @UTHREAD_MUTEX_UNLOCKED: mutex has no owner + * @UTHREAD_MUTEX_LOCKED: mutex has one owner */ enum uthread_mutex_state { UTHREAD_MUTEX_UNLOCKED = 0, @@ -59,7 +62,9 @@ enum uthread_mutex_state { }; /** - * Uthread mutex + * struct uthread_mutex - a mutex object + * + * @state: the internal state of the mutex */ struct uthread_mutex { enum uthread_mutex_state state;