From patchwork Thu Oct 3 18:48:20 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jonathan Corbet X-Patchwork-Id: 175193 Delivered-To: patch@linaro.org Received: by 2002:a92:7e96:0:0:0:0:0 with SMTP id q22csp723418ill; Thu, 3 Oct 2019 11:48:24 -0700 (PDT) X-Google-Smtp-Source: APXvYqx3JPvx01rE6bC+sf0MBWLhbE0tnJMmWzm+DPiLfg6U9Snyp0gJO9LknHd8Isddr3LxHAYK X-Received: by 2002:a17:906:bcd9:: with SMTP id lw25mr1403463ejb.315.1570128504165; Thu, 03 Oct 2019 11:48:24 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1570128504; cv=none; d=google.com; s=arc-20160816; b=KueXMY+9E2eIfWGPzfnNpozA/35v2P4Gf9KBTPV/uHS4HnKot/INhSW2k/YGeVvxzF BAH902VL+uB9XDbt8Cg8W6jxvcUCz44eLznZaNuZLGUw7oMlmBH9sYNfSOqSgHMkRP1W 77X+WXzsVAp1+sLW5TCcu1sYWDfSRORlNWV1b6XDAjERmlggLgxJ0DGew3VstFAAMhYB mJOqANcmNf8j64a94dh3uGijCO0XZFatKHRpnzN9jvPN+KqRRuDZY4wFBBcziVGM9oxU EAjtjzjfdADh/8UitiULOWZtygawd1tyr1xOqxIuF90pEWmSwWGqIOn+Rhl1QRWceriG VTuA== 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 :organization:message-id:subject:cc:to:from:date; bh=ioNbTltfvkPRCHI4OAbaa1EsLP3xN70bYuhWRlT9cls=; b=FfpVtLxwavW4Vv646MbewUqwq+TZucoMzsKtSnIyns/IlW9Tj6wglepNcOCJa12M4Y dKlbeARo8p0zukicmk2BS6+3dQQDsU/SWtKIm2S7tZAI/KQNOYueZk7dgw5qdkVI/57G niLt3yj7HRf7GdoEfNHA4HFp75iIMcgtUzLwo6rPa1i9YU/hEb9sGzPdm2EfEpqv/dH8 1cZ40/SuCjcub1CfRSzPmF0cg841lqn1U/u8hL7rcLKJCod3bi29J48vbqZSVSlegaiw oYUy+GOBwyQGyX8iNwOAivQbItHKK+F7xg33N9blqCMb7VF+JX2VeFYzq0sqtQpBcnfL 08Yg== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id ck2si1624178ejb.346.2019.10.03.11.48.23; Thu, 03 Oct 2019 11:48:24 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1730134AbfJCSsX (ORCPT + 27 others); Thu, 3 Oct 2019 14:48:23 -0400 Received: from ms.lwn.net ([45.79.88.28]:33626 "EHLO ms.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726677AbfJCSsW (ORCPT ); Thu, 3 Oct 2019 14:48:22 -0400 Received: from lwn.net (localhost [127.0.0.1]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ms.lwn.net (Postfix) with ESMTPSA id A7DDB300; Thu, 3 Oct 2019 18:48:21 +0000 (UTC) Date: Thu, 3 Oct 2019 12:48:20 -0600 From: Jonathan Corbet To: Andrew Morton Cc: LKML , linux-doc@vger.kernel.org, Dan Williams Subject: [PATCH] genalloc: Fix a set of docs build warnings Message-ID: <20191003124820.57a0fca8@lwn.net> Organization: LWN.net MIME-Version: 1.0 Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Commit 795ee30648c7 ("lib/genalloc: introduce chunk owners") made a number of changes to the genalloc API and implementation but did not update the documentation to match, leading to these docs build warnings: ./lib/genalloc.c:1: warning: 'gen_pool_add_virt' not found ./lib/genalloc.c:1: warning: 'gen_pool_alloc' not found ./lib/genalloc.c:1: warning: 'gen_pool_free' not found ./lib/genalloc.c:1: warning: 'gen_pool_alloc_algo' not found Fix these by updating the docs to match new function locations and names, and by completing the update of one kerneldoc comment. Fixes: 795ee30648c7 ("lib/genalloc: introduce chunk owners") Signed-off-by: Jonathan Corbet --- Documentation/core-api/genalloc.rst | 8 ++++---- lib/genalloc.c | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) -- 2.21.0 Acked-by: Dan Williams diff --git a/Documentation/core-api/genalloc.rst b/Documentation/core-api/genalloc.rst index 6b38a39fab24..2db2f79eb229 100644 --- a/Documentation/core-api/genalloc.rst +++ b/Documentation/core-api/genalloc.rst @@ -53,7 +53,7 @@ to the pool. That can be done with one of: :functions: gen_pool_add .. kernel-doc:: lib/genalloc.c - :functions: gen_pool_add_virt + :functions: gen_pool_add_owner A call to :c:func:`gen_pool_add` will place the size bytes of memory starting at addr (in the kernel's virtual address space) into the given @@ -65,14 +65,14 @@ for DMA allocations. The functions for allocating memory from the pool (and putting it back) are: -.. kernel-doc:: lib/genalloc.c +.. kernel-doc:: include/linux/genalloc.h :functions: gen_pool_alloc .. kernel-doc:: lib/genalloc.c :functions: gen_pool_dma_alloc .. kernel-doc:: lib/genalloc.c - :functions: gen_pool_free + :functions: gen_pool_free_owner As one would expect, :c:func:`gen_pool_alloc` will allocate size< bytes from the given pool. The :c:func:`gen_pool_dma_alloc` variant allocates @@ -89,7 +89,7 @@ return. If that sort of control is needed, the following functions will be of interest: .. kernel-doc:: lib/genalloc.c - :functions: gen_pool_alloc_algo + :functions: gen_pool_alloc_algo_owner .. kernel-doc:: lib/genalloc.c :functions: gen_pool_set_algo diff --git a/lib/genalloc.c b/lib/genalloc.c index 9fc31292cfa1..24d20ca7e91b 100644 --- a/lib/genalloc.c +++ b/lib/genalloc.c @@ -472,7 +472,7 @@ void *gen_pool_dma_zalloc_align(struct gen_pool *pool, size_t size, EXPORT_SYMBOL(gen_pool_dma_zalloc_align); /** - * gen_pool_free - free allocated special memory back to the pool + * gen_pool_free_owner - free allocated special memory back to the pool * @pool: pool to free to * @addr: starting address of memory to free back to pool * @size: size in bytes of memory to free