From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-13.1 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,INCLUDES_PATCH,MAILING_LIST_MULTI, SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 1AD20C433DF for ; Tue, 13 Oct 2020 11:59:39 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id C52A32080A for ; Tue, 13 Oct 2020 11:59:38 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1602590378; bh=78BG9Iu2yAlND/COH/HKK6//gm3h8RbYRE58LCuOyj4=; h=From:To:Cc:Subject:Date:In-Reply-To:References:List-ID:From; b=SGxtSJW2z6j2jFy9AQTdDYzcAeOHcR/szm82tIemKFI/btS3h7NQBnLoIcGLYpP64 5J+WdisdUzCvVxpcPT5+ZmstLJye3GaGHPcobspvZSZkeA0WkW/w3snnsc43IHuFtQ njJTyz45abk4ORy3pjnEXu2A4nJmDLkClDk1agwk= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728552AbgJML7h (ORCPT ); Tue, 13 Oct 2020 07:59:37 -0400 Received: from mail.kernel.org ([198.145.29.99]:57414 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727513AbgJMLyn (ORCPT ); Tue, 13 Oct 2020 07:54:43 -0400 Received: from mail.kernel.org (ip5f5ad5b2.dynamic.kabel-deutschland.de [95.90.213.178]) (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 DEBB122404; Tue, 13 Oct 2020 11:54:40 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1602590081; bh=78BG9Iu2yAlND/COH/HKK6//gm3h8RbYRE58LCuOyj4=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=AsK7hZKtJHTp+v/vQK7XgM0QCL3nZxAgSJGWungnQzL/zeI6v/B32acVF1enJu+A9 IRprqu9BkcwN4dzKVUpjjIYEAtgjJJPbBEVgieSPRbCuk+VUU8v322xh1wkbfjKvrM cwkig0bWKbK+uTEmlbTrA2y5DEC6r1TBITVQkz5U= Received: from mchehab by mail.kernel.org with local (Exim 4.94) (envelope-from ) id 1kSIt4-006CUx-PS; Tue, 13 Oct 2020 13:54:38 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , "Jonathan Corbet" , Arnd Bergmann , Jaroslav Kysela , Julia Lawall , Takashi Iwai , alsa-devel@alsa-project.org, linux-kernel@vger.kernel.org, Takashi Iwai Subject: [PATCH v6 39/80] docs: writing-an-alsa-driver.rst: fix some bad c:func: markups Date: Tue, 13 Oct 2020 13:53:54 +0200 Message-Id: X-Mailer: git-send-email 2.26.2 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 Some such markups are invalid, as reported by Sphinx: ./Documentation/sound/kernel-api/writing-an-alsa-driver.rst:3317: WARNING: Unparseable C cross-reference: 'snd_rawmidi_transmit*' Invalid C declaration: Expected end of definition. [error at 20] snd_rawmidi_transmit* --------------------^ ./Documentation/sound/kernel-api/writing-an-alsa-driver.rst:3917: WARNING: Unparseable C cross-reference: 'copy_from/to_user' Invalid C declaration: Expected end of definition. [error at 9] copy_from/to_user ---------^ The first case seems to be better replaced by a literal. For the second one, let's generate cross-references, by spliting it in two. Reviewed-by: Takashi Iwai Signed-off-by: Mauro Carvalho Chehab --- Documentation/sound/kernel-api/writing-an-alsa-driver.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/Documentation/sound/kernel-api/writing-an-alsa-driver.rst b/Documentation/sound/kernel-api/writing-an-alsa-driver.rst index 85d6e9c643ef..73bbd59afc33 100644 --- a/Documentation/sound/kernel-api/writing-an-alsa-driver.rst +++ b/Documentation/sound/kernel-api/writing-an-alsa-driver.rst @@ -3315,8 +3315,7 @@ data and removes them from the buffer at once: } If you know beforehand how many bytes you can accept, you can use a -buffer size greater than one with the -:c:func:`snd_rawmidi_transmit\*()` functions. +buffer size greater than one with the ``snd_rawmidi_transmit*()`` functions. The ``trigger`` callback must not sleep. If the hardware FIFO is full before the substream buffer has been emptied, you have to continue @@ -3916,7 +3915,7 @@ the maximum size of the proc file access. The read/write callbacks of raw mode are more direct than the text mode. You need to use a low-level I/O functions such as -:c:func:`copy_from/to_user()` to transfer the data. +:c:func:`copy_from_user()` and :c:func:`copy_to_user()` to transfer the data. :: -- 2.26.2