From patchwork Sat Jun 23 03:08:21 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 10483455 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 1C9036023A for ; Sat, 23 Jun 2018 03:08:30 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 008C728558 for ; Sat, 23 Jun 2018 03:08:30 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id E769C28668; Sat, 23 Jun 2018 03:08:29 +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=-7.8 required=2.0 tests=BAYES_00,DKIM_SIGNED, MAILING_LIST_MULTI, RCVD_IN_DNSWL_HI, T_DKIM_INVALID autolearn=ham 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 8E72528558 for ; Sat, 23 Jun 2018 03:08:29 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S933791AbeFWDI1 (ORCPT ); Fri, 22 Jun 2018 23:08:27 -0400 Received: from merlin.infradead.org ([205.233.59.134]:59296 "EHLO merlin.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S933783AbeFWDI0 (ORCPT ); Fri, 22 Jun 2018 23:08:26 -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=DJgScgbKpm6g1A52JSNBuJxbMfh5uHXgmljKVopCAI8=; b=gLokTjPv+JSlbK7iG5N4vdzf/9 whvqQPvZVIUfA71asDm8hbSWsOEt2gSw7IROexwngslCCJI25gGOEmBZrkFlaFI8QAjrKHZ7DdbIn Ff/k1yFkkdtZ2YZ8eHMdYiVQwouplzvMrFzbpyJodIr3mZcGOHT8SD5Ira0uhmiEhHeEH4WBaIK8g TH540wCtQQuQ0XP/WedEEUnPBkaB6THEIv+4qxvKWUS02NRyrnm9nN7zXGmIvCnVpKUD0y349K8Kn iGK8ssyKoRZulLmiHCyT8ZKKGNiZDvXZ6cL+qVPEJj7xdPJyrJK9+eHS+/BiKS1dtl2V6kJLTla8y 3XGHcbtg==; Received: from static-50-53-52-16.bvtn.or.frontiernet.net ([50.53.52.16] helo=dragon.dunlab) by merlin.infradead.org with esmtpsa (Exim 4.90_1 #2 (Red Hat Linux)) id 1fWYuX-00053d-Cy; Sat, 23 Jun 2018 03:08:25 +0000 To: linux-kbuild , Masahiro Yamada Cc: LKML From: Randy Dunlap Subject: [PATCH] kconfig: document Kconfig source file comments Message-ID: Date: Fri, 22 Jun 2018 20:08:21 -0700 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.8.0 MIME-Version: 1.0 Content-Language: en-US Sender: linux-kbuild-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kbuild@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP From: Randy Dunlap I saw this type of Kconfig construct on LKML: config SYMBOOL #bool "prompt string" default y and wondered what it does. Then I wondered if '#' comments are even documented. They aren't, so add a little doc for that. Ah, good. kconfig says: arch/x86/Kconfig:2942:warning: config symbol defined without type Signed-off-by: Randy Dunlap --- Documentation/kbuild/kconfig-language.txt | 6 ++++++ 1 file changed, 6 insertions(+) -- To unsubscribe from this list: send the line "unsubscribe linux-kbuild" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html --- lnx-418-rc1.orig/Documentation/kbuild/kconfig-language.txt +++ lnx-418-rc1/Documentation/kbuild/kconfig-language.txt @@ -430,6 +430,12 @@ This sets the config program's title bar to use it. It should be placed at the top of the configuration, before any other statement. +'#' Kconfig source file comment: + +An unquoted '#' character anywhere in a source file line indicates +the beginning of a source file comment. The remainder of that line +is a comment. + Kconfig hints -------------