Received: by 2002:a05:6a10:8c0a:0:0:0:0 with SMTP id go10csp1998621pxb; Mon, 8 Mar 2021 11:17:29 -0800 (PST) X-Google-Smtp-Source: ABdhPJwxkymaQbivBCUE94K55opsUwVrJaPuqtJZlT/GXCPj7EQ+XUMCQZveP4xvYV2smO73YsLG X-Received: by 2002:a50:ef11:: with SMTP id m17mr93871eds.151.1615231048979; Mon, 08 Mar 2021 11:17:28 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1615231048; cv=none; d=google.com; s=arc-20160816; b=wSj8eYuqgcTKbytesGeDgfy0hpSJ0RBcEQ+EQqCK0E2xd/HeRPxoxyG3bbWAMnSICT nzeNSlVLxyYNFtCTbl8C8jlfTsCx1rgfee8MTnqK2HxVu5MiQ4VQ+lPdbGJ7i8TuOUMz qY64/7vyc6qqaS2CIZTaSmOft6tMq9BrKK9a3w/63kCY4xoylCF/OuxSl/JU98b767Ts CaqQA5bjg/Z2wfAMZ8mjHo6NyCVsbMgrysDtv1rGDIO9T6eXAVp8YTwiHbQYlxC+FWWj 2oxDybxL1hXjP04lVub7akxCRWrM3k2SiHLveT1Hkc/KWIMccwjuf8ptzLvcYqnBzq9K dvJg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=LWecoEPEy7ALFRmQYpSfE1kaYSEjuJUyw+bo5UyVzWw=; b=PGX2XP45/37Hy2OVE5TXHzx6EJ/FUSKARKuGngBao+65W6KpAPxDtu6wYJsXcUaFkZ FcNxV9lG1H+w9KMljSE5wImhk1Qo3AXSo84xxvp/nyZ11kvoy68chnMopfc8ynAhg8Sa skD/qH4tK5W/8Ds+/S3oeL4omSL1jiVGI8BsGJfzAiUOCZCcM9rbx2D3Ner2yDyFDoZu xWBodvKDSK3D5f9UeNKJnHKNn4YVzlzZk97GwofCVqshr1w4KzXo3uqNQKa3rEwyymAU 86Ba+iTQJBKVT3EY9JY4E/KkJkYotCcYd/U3Iu8DP6fkISk68zP5tHMnEgwAcx5t6blg fgtw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@penguintechs.org header.s=google header.b=LvnxUKbw; 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 Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id x18si7303857ejo.233.2021.03.08.11.17.00; Mon, 08 Mar 2021 11:17:28 -0800 (PST) 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=@penguintechs.org header.s=google header.b=LvnxUKbw; 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 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231201AbhCHTQC (ORCPT + 99 others); Mon, 8 Mar 2021 14:16:02 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:34672 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231254AbhCHTPh (ORCPT ); Mon, 8 Mar 2021 14:15:37 -0500 Received: from mail-pl1-x632.google.com (mail-pl1-x632.google.com [IPv6:2607:f8b0:4864:20::632]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D1998C06175F for ; Mon, 8 Mar 2021 11:15:36 -0800 (PST) Received: by mail-pl1-x632.google.com with SMTP id a24so5320167plm.11 for ; Mon, 08 Mar 2021 11:15:36 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=penguintechs.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=LWecoEPEy7ALFRmQYpSfE1kaYSEjuJUyw+bo5UyVzWw=; b=LvnxUKbwQmtaiY55wHaHLYFa+BIjo3x+Iz2ruou/w8AK9km3h+FloxJdaRogOZUc2z +YHNDGJalFqpTUBxwyU2qB6M9n7j8N4znGUF3pgItH07q/hi9CvuqY06eTfBUvbkuOBR O6P1HPk+0Tv4F1UOW69bjeXgVlv86tSrcPuTQ= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=LWecoEPEy7ALFRmQYpSfE1kaYSEjuJUyw+bo5UyVzWw=; b=YDa40Did+xgEk3a4+cm1mjCu/fSzOK+BSlFjkeGt8B05dQXk4Eg2MO0YJDWsARcMD6 x4R8LQhq9yAkGf/5EV57nP4MFIwT7BZK+/obHHaTMA7thCoUKLQz6+UIlq8nRJeTMckr nqC/4eStkrALAtpiMjuPBRYaoqijCl7JK/tyYNQjEE6fSxshpsPg51QQ2lEFrn5rhste DfdMjpcKXwf8iBb/pBACYPxeh8yn+JgZWERKBM9AtTcoQeG50ckc76fPgDbPGGR2PnBt QzBQ3srfLKkpJX9+dYRmbYJ2jyMqpcydLi/WI9twB5YXhDpbijsE058Wth9KrU46EIDN qtJQ== X-Gm-Message-State: AOAM530P/YAh8mZvJ4EITxP0rtPFHuqAwn/VAKb1VLolltSBjaJbhI5s CFOPux+HkEmgBEdOuDXhrYZNRw== X-Received: by 2002:a17:90a:f2d2:: with SMTP id gt18mr382352pjb.210.1615230936307; Mon, 08 Mar 2021 11:15:36 -0800 (PST) Received: from braindead.localdomain (c-71-202-115-154.hsd1.ca.comcast.net. [71.202.115.154]) by smtp.gmail.com with ESMTPSA id j3sm10331735pgk.24.2021.03.08.11.15.35 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 08 Mar 2021 11:15:35 -0800 (PST) From: Wren Turkal To: Jonathan Corbet Cc: Wren Turkal , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v3] Expose the bus kernel docs to the build docs. Date: Mon, 8 Mar 2021 11:14:18 -0800 Message-Id: <20210308191417.4750-1-wt@penguintechs.org> X-Mailer: git-send-email 2.30.1 In-Reply-To: <20210307031611.GU2723601@casper.infradead.org> References: <20210307031611.GU2723601@casper.infradead.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Before, the bus type related APIs that were defined in the include/linux/device/bus.h were not referenced anywhere in the docs, so I linked it to the bus types api documentation. Signed-off-by: Wren Turkal --- Documentation/driver-api/driver-model/bus.rst | 8 ++++++++ Documentation/driver-api/infrastructure.rst | 3 +-- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/Documentation/driver-api/driver-model/bus.rst b/Documentation/driver-api/driver-model/bus.rst index 016b15a6e8ea..c53b01e95fd9 100644 --- a/Documentation/driver-api/driver-model/bus.rst +++ b/Documentation/driver-api/driver-model/bus.rst @@ -1,3 +1,5 @@ +.. _bus_types: + ========= Bus Types ========= @@ -144,3 +146,9 @@ sysfs directory using:: int bus_create_file(struct bus_type *, struct bus_attribute *); void bus_remove_file(struct bus_type *, struct bus_attribute *); + +Functions and Structures +======================== + +.. kernel-doc:: include/linux/device/bus.h +.. kernel-doc:: drivers/base/bus.c diff --git a/Documentation/driver-api/infrastructure.rst b/Documentation/driver-api/infrastructure.rst index 683bd460e222..eb2a2c9e3c0c 100644 --- a/Documentation/driver-api/infrastructure.rst +++ b/Documentation/driver-api/infrastructure.rst @@ -41,8 +41,7 @@ Device Drivers Base .. kernel-doc:: drivers/base/platform.c :export: -.. kernel-doc:: drivers/base/bus.c - :export: +:ref:`bus_types` Device Drivers DMA Management ----------------------------- -- 2.30.1