From patchwork Mon Aug 28 23:10:09 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 9926397 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id C3AA6603B4 for ; Mon, 28 Aug 2017 23:10:59 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id A71AF287D2 for ; Mon, 28 Aug 2017 23:10:59 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 8CAB1287CE; Mon, 28 Aug 2017 23:10:59 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.8 required=2.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_HI,T_DKIM_INVALID autolearn=unavailable version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 3C772287D2 for ; Mon, 28 Aug 2017 23:10:59 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751221AbdH1XKP (ORCPT ); Mon, 28 Aug 2017 19:10:15 -0400 Received: from merlin.infradead.org ([205.233.59.134]:33746 "EHLO merlin.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751189AbdH1XKN (ORCPT ); Mon, 28 Aug 2017 19:10:13 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=merlin.20170209; h=Content-Transfer-Encoding:Content-Type: MIME-Version:Date:Message-ID:Subject:From:Cc:To:Sender:Reply-To:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:In-Reply-To:References:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=xMJ4wYoZDzfySRZA752EClJvFH6RalFOsIRrKPZW1Hk=; b=T+SAX4yjX0SQ2IYIH+ODbazg2+ dRZTVCkxyze/MEDn8dLrMt8NMtWy9fR+05VYlO/pNmQaxHXd1hSNe+cE8szsSSash0nNRFDcuvaCB pGRvk/ZpgekWz3oV7dYLCDwkDnGOhMtJIkN+G+BZ4bWYAW0u81IzOn/humL8quUtITRPOn0A98Rus bg6jYff0C4Zy+/Iv8Nlmzs2+4MCUtr7CWbf0PXf/K4ho+cD+3uge/QpbFjZyxAXcsxpVBf3plYu0U ezL088zSvxSIhxiwKTn7lwF08s39FFND5iRXKGSE9bHFC1qNfep+mpNUxfYHTnWTIew8yHDr+JmWp y2+aVP8Q==; Received: from static-50-53-52-16.bvtn.or.frontiernet.net ([50.53.52.16] helo=midway.dunlap) by merlin.infradead.org with esmtpsa (Exim 4.87 #1 (Red Hat Linux)) id 1dmTAZ-0000zz-N7; Mon, 28 Aug 2017 23:10:12 +0000 To: "linux-doc@vger.kernel.org" , LKML , Jonathan Corbet Cc: linux-media , Mauro Carvalho Chehab From: Randy Dunlap Subject: [PATCH 1/2] docs: kernel-doc comments are ASCII Message-ID: <54c23e8e-89c0-5cea-0dcc-e938952c5642@infradead.org> Date: Mon, 28 Aug 2017 16:10:09 -0700 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.3.0 MIME-Version: 1.0 Content-Language: en-US Sender: linux-media-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-media@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP From: Randy Dunlap kernel-doc parsing uses as ASCII codec, so let people know that kernel-doc comments should be in ASCII characters only. WARNING: kernel-doc '../scripts/kernel-doc -rst -enable-lineno ../drivers/media/dvb-core/demux.h' processing failed with: 'ascii' codec can't decode byte 0xe2 in position 6368: ordinal not in range(128) Signed-off-by: Randy Dunlap --- Documentation/doc-guide/kernel-doc.rst | 3 +++ 1 file changed, 3 insertions(+) --- lnx-413-rc7.orig/Documentation/doc-guide/kernel-doc.rst +++ lnx-413-rc7/Documentation/doc-guide/kernel-doc.rst @@ -108,6 +108,9 @@ The function and type kernel-doc comment function or type being described. The overview kernel-doc comments may be freely placed at the top indentation level. +.. attention:: kernel-doc comments should be written **only** in ASCII + characters since they are processed as ASCII input. + Example kernel-doc function comment:: /**