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=-7.0 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_HELO_NONE, SPF_PASS,URIBL_BLOCKED autolearn=no 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 759AFC4727F for ; Wed, 30 Sep 2020 14:58:25 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 3E3542076B for ; Wed, 30 Sep 2020 14:58:25 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1730736AbgI3O6Y (ORCPT ); Wed, 30 Sep 2020 10:58:24 -0400 Received: from mx2.suse.de ([195.135.220.15]:53844 "EHLO mx2.suse.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728729AbgI3O6X (ORCPT ); Wed, 30 Sep 2020 10:58:23 -0400 X-Virus-Scanned: by amavisd-new at test-mx.suse.de Received: from relay2.suse.de (unknown [195.135.221.27]) by mx2.suse.de (Postfix) with ESMTP id D5AA4B2DC; Wed, 30 Sep 2020 14:58:20 +0000 (UTC) Date: Wed, 30 Sep 2020 16:58:20 +0200 Message-ID: From: Takashi Iwai To: Mauro Carvalho Chehab Cc: Linux Doc Mailing List , Jonathan Corbet , Arnd Bergmann , Jaroslav Kysela , Julia Lawall , Takashi Iwai , alsa-devel@alsa-project.org, linux-kernel@vger.kernel.org Subject: Re: [PATCH v4 39/52] docs: writing-an-alsa-driver.rst: fix some bad c:func: markups In-Reply-To: <9c68c182ae5aa978d68b64695b1e3292fcf58e76.1601467849.git.mchehab+huawei@kernel.org> References: <9c68c182ae5aa978d68b64695b1e3292fcf58e76.1601467849.git.mchehab+huawei@kernel.org> User-Agent: Wanderlust/2.15.9 (Almost Unreal) SEMI/1.14.6 (Maruoka) FLIM/1.14.9 (=?UTF-8?B?R29qxY0=?=) APEL/10.8 Emacs/25.3 (x86_64-suse-linux-gnu) MULE/6.0 (HANACHIRUSATO) MIME-Version: 1.0 (generated by SEMI 1.14.6 - "Maruoka") Content-Type: text/plain; charset=US-ASCII Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Wed, 30 Sep 2020 15:25:02 +0200, Mauro Carvalho Chehab wrote: > > 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. > > Signed-off-by: Mauro Carvalho Chehab Reviewed-by: Takashi Iwai thanks, Takashi