Received: by 2002:a05:6a10:206:0:0:0:0 with SMTP id 6csp1895438pxj; Sat, 5 Jun 2021 06:24:18 -0700 (PDT) X-Google-Smtp-Source: ABdhPJy6a/4U6+HrpZFq9EElpFYpYRlOLtnGdHn0QqTYYE6I08Uw/XdsqTXwoC48IPjqLCfygAm2 X-Received: by 2002:aa7:c354:: with SMTP id j20mr10328961edr.294.1622899458422; Sat, 05 Jun 2021 06:24:18 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1622899458; cv=none; d=google.com; s=arc-20160816; b=wzAh47FjFbxlMEMroGzpfQ3ODEUlpqEDGormnTQobI8/HMlqIMO8pSDQOJPvH2XBqq avmJoFyDa8kDikILH96RI2abkrfsWPxXNfpK6lYYt1xLyCnVFPI8Z7POglKfWXrZzVNT QWbrW1ICGuMM3WEls3+wvhrK0btJnct/76RY+kgQmuNohsFf7EEHlqVJn41If10vaBX1 DYfAKhWJgqshEBq8QpNULKhU+ABX9Yge720B/D5uBetZpx8LwtD2cII+oub4S3Hevy3L F2IBmquL97mHdzNvZC6iRV9pQFQ4efriJGG97bRfxhc4Z2oJTNmWAOWhzmZcTDfhWbNv Cu5A== 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=fd9OGQ33NLJvWstmmRVwGNKuHXtlPiOI9AzeolbNJc0=; b=NBpSlsqUH8+k/nylj2dcq6+KF3bfuID0zkPEnYM5mE5lL6INfPMJu/gj6JgDcSERGX OUs2ZWBfWVXCfW8K0+VYVtimQwKXrnvSuONQlb1xxNT95BSkKsmmQZkpfGhvCWRHTNN1 qMbj4WL58AWYd356Tq/DYXU+Cr1+taoIloBYQ6mmJsWSWkGLt1kP79xY1NRc7XNnLQBy k2MysdEEHN96VNRqmDpaiRp+iBAfDQWvjEKB61YxHbVyTpqJUOTT8WCw8FGUDiEY2Sct aj2P3M0jcqNtulTILfeNMl5bzgpUwWkPcc2CqcCD64nzBs5Rf14ErenDT9mwrP9u1Aht 2zUw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=Rn23v6UO; 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 la17si7373367ejc.402.2021.06.05.06.23.55; Sat, 05 Jun 2021 06:24:18 -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=k20201202 header.b=Rn23v6UO; 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 S231259AbhFENVh (ORCPT + 99 others); Sat, 5 Jun 2021 09:21:37 -0400 Received: from mail.kernel.org ([198.145.29.99]:35108 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230059AbhFENU0 (ORCPT ); Sat, 5 Jun 2021 09:20:26 -0400 Received: by mail.kernel.org (Postfix) with ESMTPSA id A4DB061422; Sat, 5 Jun 2021 13:18:37 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1622899117; bh=RluDluVvgOJfMawxkXAd8MJmBCh51i/nH0Xg7JEnU2k=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=Rn23v6UOS3jVgJGKdEfJhkyjYQRs8OvLNlHdRpl2ordTXAs6+I2kXEVu+5r9ez8Bx MDwBPoD+XYywM2CNTOhLFQbV8/rnHyJURNjZKo44FYnlxb1OCIE4w2gomG9qD0W/JX ll7GI0dXPwKcAZ6b+gorSvC9ATt3crAe8RMYMBJQkH1fWLIICdAYf5CQ/VxZMfcW2Z G+v14acNvd/krFluGCENq0lV8slKNfmhV4wC4a3dzPcUG37C+rOCQjBEbW+K/YnqdR n/Jks3nBTjXb/Y1rHmnNktAeTNUwecGp0PSH+Od7GJJp7Y7Ahln7VTlY4D3KnXiKrD VZ5opdzX6XR5g== Received: by mail.kernel.org with local (Exim 4.94.2) (envelope-from ) id 1lpWCB-008GFF-PJ; Sat, 05 Jun 2021 15:18:35 +0200 From: Mauro Carvalho Chehab To: "Jonathan Corbet" , Linux Doc Mailing List Cc: Mauro Carvalho Chehab , Daniel Borkmann , Lukas Bulwahn , Robin Murphy , Tomasz Figa , linux-kernel@vger.kernel.org Subject: [PATCH 12/34] docs: core-api: avoid using ReSt :doc:`foo` markup Date: Sat, 5 Jun 2021 15:18:11 +0200 Message-Id: X-Mailer: git-send-email 2.31.1 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: Mauro Carvalho Chehab Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org The :doc:`foo` tag is auto-generated via automarkup.py. So, use the filename at the sources, instead of :doc:`foo`. Signed-off-by: Mauro Carvalho Chehab --- Documentation/core-api/bus-virt-phys-mapping.rst | 2 +- Documentation/core-api/dma-api.rst | 5 +++-- Documentation/core-api/dma-isa-lpc.rst | 2 +- Documentation/core-api/index.rst | 4 ++-- 4 files changed, 7 insertions(+), 6 deletions(-) diff --git a/Documentation/core-api/bus-virt-phys-mapping.rst b/Documentation/core-api/bus-virt-phys-mapping.rst index c7bc99cd2e21..c72b24a7d52c 100644 --- a/Documentation/core-api/bus-virt-phys-mapping.rst +++ b/Documentation/core-api/bus-virt-phys-mapping.rst @@ -8,7 +8,7 @@ How to access I/O mapped memory from within device drivers The virt_to_bus() and bus_to_virt() functions have been superseded by the functionality provided by the PCI DMA interface - (see :doc:`/core-api/dma-api-howto`). They continue + (see Documentation/core-api/dma-api-howto.rst). They continue to be documented below for historical purposes, but new code must not use them. --davidm 00/12/12 diff --git a/Documentation/core-api/dma-api.rst b/Documentation/core-api/dma-api.rst index 00a1d4fa3f9e..6d6d0edd2d27 100644 --- a/Documentation/core-api/dma-api.rst +++ b/Documentation/core-api/dma-api.rst @@ -5,7 +5,7 @@ Dynamic DMA mapping using the generic device :Author: James E.J. Bottomley This document describes the DMA API. For a more gentle introduction -of the API (and actual examples), see :doc:`/core-api/dma-api-howto`. +of the API (and actual examples), see Documentation/core-api/dma-api-howto.rst. This API is split into two pieces. Part I describes the basic API. Part II describes extensions for supporting non-consistent memory @@ -479,7 +479,8 @@ without the _attrs suffixes, except that they pass an optional dma_attrs. The interpretation of DMA attributes is architecture-specific, and -each attribute should be documented in :doc:`/core-api/dma-attributes`. +each attribute should be documented in +Documentation/core-api/dma-attributes.rst. If dma_attrs are 0, the semantics of each of these functions is identical to those of the corresponding function diff --git a/Documentation/core-api/dma-isa-lpc.rst b/Documentation/core-api/dma-isa-lpc.rst index e59a3d35a93d..17b193603f0a 100644 --- a/Documentation/core-api/dma-isa-lpc.rst +++ b/Documentation/core-api/dma-isa-lpc.rst @@ -17,7 +17,7 @@ To do ISA style DMA you need to include two headers:: #include The first is the generic DMA API used to convert virtual addresses to -bus addresses (see :doc:`/core-api/dma-api` for details). +bus addresses (see Documentation/core-api/dma-api.rst for details). The second contains the routines specific to ISA DMA transfers. Since this is not present on all platforms make sure you construct your diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/index.rst index f1c9d20bd42d..5de2c7a4b1b3 100644 --- a/Documentation/core-api/index.rst +++ b/Documentation/core-api/index.rst @@ -48,7 +48,7 @@ Concurrency primitives ====================== How Linux keeps everything from happening at the same time. See -:doc:`/locking/index` for more related documentation. +Documentation/locking/index.rst for more related documentation. .. toctree:: :maxdepth: 1 @@ -77,7 +77,7 @@ Memory management ================= How to allocate and use memory in the kernel. Note that there is a lot -more memory-management documentation in :doc:`/vm/index`. +more memory-management documentation in Documentation/vm/index.rst. .. toctree:: :maxdepth: 1 -- 2.31.1