Received: by 2002:a05:6a10:22f:0:0:0:0 with SMTP id 15csp4569684pxk; Wed, 30 Sep 2020 06:29:40 -0700 (PDT) X-Google-Smtp-Source: ABdhPJw7ajce4/MkGlE3mYVcSWHoD0wJ2MlfmkmvWwqncWL54OY4tx+Gps6IUDBAo4lUiLM8/JZj X-Received: by 2002:a50:d4d8:: with SMTP id e24mr2757157edj.1.1601472580601; Wed, 30 Sep 2020 06:29:40 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1601472580; cv=none; d=google.com; s=arc-20160816; b=TFYRpviULuAFxP0omgUxFnHOcOT1YWa/ciGaMgftEQNgvRkmLnzZk0S0tC+AL25EPF CmLxlEqxxTZiIinX5ecB9ev3+asS/vF/ieAK5HlsTsp9nlSSY1DcuL2xAUyU5INPzyF7 uxOOv3naOHf78h1f9xnkjhuEPk+F/Rriac2Jd28OzupyC240hWgoFgFOLAr1VaMcuQJl fzSx09F2TsunLr2ftRugQc8TMhQAsW8dwUJWTV/BlxtF/FflpgQVyKDl+Ky5yTgzlTHA LGIOZXBJ3I2H1ZfpD0lmfT3ndCg23I8kHm9Y5EhrpiaVxiEioL5/yokrebGoT7iiNv4m Id6A== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=jgf4Q0KbRxN4my8rIpe/P5zV/CHrPjObACA6MDOcOng=; b=T2mk9hYBEpXfK2xiM1osaSQ0GLk8EBbCDFhtn2MSnqSI8vsillxnWcjIGMbecQ+TOq Ph+1AFUYvCrg+oWrVevbrtk77y60khqFyxk6lPWQr5jJOakTAOcCOvOZO9iB81vNyEgA WkLTRKmfl6hNrw54HH7OKOL8AVcS7G4vHONoaSAVil9sCrT4iGufryZaQ7VUKFYgxk5E aDOspFmykuQ+ELATtnAZ0OUWaLNrC3q3ZCtut9zdbvTkMQoCc0XoUbl7H0IQVYHZ8Vr/ 3gpgA2EPb7WJFVyHx7IRHVKiQMvxHbCrg2E7quvtP39iJlSSpVa0qx5nlMO79r46Qm8j Zoqw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=default header.b=VYhTrFDM; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id d11si1092887edo.244.2020.09.30.06.29.17; Wed, 30 Sep 2020 06:29:40 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@kernel.org header.s=default header.b=VYhTrFDM; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1730663AbgI3N13 (ORCPT + 99 others); Wed, 30 Sep 2020 09:27:29 -0400 Received: from mail.kernel.org ([198.145.29.99]:39018 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1730240AbgI3NZW (ORCPT ); Wed, 30 Sep 2020 09:25:22 -0400 Received: from mail.kernel.org (unknown [95.90.213.196]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 5BFCA23A51; Wed, 30 Sep 2020 13:25:21 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1601472321; bh=nm9qJomKwVXcljIx0Ng6FM4B6A36zuOApRHbFINo3A4=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=VYhTrFDMlQ8GXf61TAS9LNhpFwZS+A9+i4k6ZaWE8BkybGFIXvLJZU6A/0wPGqajy 2/WMXr1jRiKny7/oGQ+wtMbyDkzocB0gvoxZjl5CUskD609gnqgwvMvt17iBObYEL6 pITFyee7P37o+7wRjrjkZ9hnoA8IzN7LCyoz6BJ0= Received: from mchehab by mail.kernel.org with local (Exim 4.94) (envelope-from ) id 1kNc6h-001XKi-Gb; Wed, 30 Sep 2020 15:25:19 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List , Jonathan Corbet Cc: Mauro Carvalho Chehab , Moritz Fischer , Tom Rix , linux-fpga@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v4 40/52] docs: fpga: replace :c:member: macros Date: Wed, 30 Sep 2020 15:25:03 +0200 Message-Id: <720b01d37a7d6f50721d95988cfd9a9e463f43cd.1601467849.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.26.2 In-Reply-To: References: MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Sender: Mauro Carvalho Chehab Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Those macros are not doing the right thing with Sphinx 3, causing parse errors: ./Documentation/driver-api/fpga/fpga-mgr.rst:104: WARNING: Unparseable C cross-reference: 'fpga_manager->state' Invalid C declaration: Expected end of definition. [error at 12] fpga_manager->state ------------^ ./Documentation/driver-api/fpga/fpga-programming.rst:18: WARNING: Unparseable C cross-reference: 'fpga_region->info' Invalid C declaration: Expected end of definition. [error at 11] fpga_region->info -----------^ ./Documentation/driver-api/fpga/fpga-region.rst:62: WARNING: Unparseable C cross-reference: 'fpga_region->bridge_list' Invalid C declaration: Expected end of definition. [error at 11] fpga_region->bridge_list -----------^ ./Documentation/driver-api/fpga/fpga-region.rst:62: WARNING: Unparseable C cross-reference: 'fpga_region->get_bridges' Invalid C declaration: Expected end of definition. [error at 11] fpga_region->get_bridges -----------^ Replace them by :c:expr:, with does what's desired. Signed-off-by: Mauro Carvalho Chehab --- Documentation/driver-api/fpga/fpga-mgr.rst | 2 +- Documentation/driver-api/fpga/fpga-programming.rst | 2 +- Documentation/driver-api/fpga/fpga-region.rst | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Documentation/driver-api/fpga/fpga-mgr.rst b/Documentation/driver-api/fpga/fpga-mgr.rst index 22f7885b32c9..917ee22db429 100644 --- a/Documentation/driver-api/fpga/fpga-mgr.rst +++ b/Documentation/driver-api/fpga/fpga-mgr.rst @@ -101,7 +101,7 @@ in state. API for implementing a new FPGA Manager driver ---------------------------------------------- -* ``fpga_mgr_states`` — Values for :c:member:`fpga_manager->state`. +* ``fpga_mgr_states`` — Values for :c:expr:`fpga_manager->state`. * struct fpga_manager — the FPGA manager struct * struct fpga_manager_ops — Low level FPGA manager driver ops * devm_fpga_mgr_create() — Allocate and init a manager struct diff --git a/Documentation/driver-api/fpga/fpga-programming.rst b/Documentation/driver-api/fpga/fpga-programming.rst index f487ad64dfb9..002392dab04f 100644 --- a/Documentation/driver-api/fpga/fpga-programming.rst +++ b/Documentation/driver-api/fpga/fpga-programming.rst @@ -15,7 +15,7 @@ the FPGA manager and bridges. It will: * lock the mutex of the region's FPGA manager * build a list of FPGA bridges if a method has been specified to do so * disable the bridges - * program the FPGA using info passed in :c:member:`fpga_region->info`. + * program the FPGA using info passed in :c:expr:`fpga_region->info`. * re-enable the bridges * release the locks diff --git a/Documentation/driver-api/fpga/fpga-region.rst b/Documentation/driver-api/fpga/fpga-region.rst index 3e52be7e2968..363a8171ab0a 100644 --- a/Documentation/driver-api/fpga/fpga-region.rst +++ b/Documentation/driver-api/fpga/fpga-region.rst @@ -61,9 +61,9 @@ during the region's probe function. The FPGA region will need to specify which bridges to control while programming the FPGA. The region driver can build a list of bridges during probe time -(:c:member:`fpga_region->bridge_list`) or it can have a function that creates +(:c:expr:`fpga_region->bridge_list`) or it can have a function that creates the list of bridges to program just before programming -(:c:member:`fpga_region->get_bridges`). The FPGA bridge framework supplies the +(:c:expr:`fpga_region->get_bridges`). The FPGA bridge framework supplies the following APIs to handle building or tearing down that list. * fpga_bridge_get_to_list() — Get a ref of an FPGA bridge, add it to a -- 2.26.2