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 Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id D7D5BC6FA82 for ; Fri, 23 Sep 2022 11:34:45 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230327AbiIWLeo (ORCPT ); Fri, 23 Sep 2022 07:34:44 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:40224 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231459AbiIWLel (ORCPT ); Fri, 23 Sep 2022 07:34:41 -0400 Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id CEB9F2646 for ; Fri, 23 Sep 2022 04:34:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1663932877; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding; bh=4X3wisODltpxscZtCSRmTQy5pbD/XdZXOSG0hYXXj4k=; b=d+rlQrrcxAK3iCy9I3xEtWUsCC1ndP+UxbAYVj6bb+elqDhpkN5KHB5QR6aXncYX6aPZ9g bbLxniH8jEWAIZPNWdBGAk2kzQtwCJqmdMBje1R6qvtx59lpRPDfLuxME50Mv+770xP+Gx RTYCQURhX37WzhwkE9SmXnGvlbY6Wgc= Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-381-WxR3GrKZOCqkUD7z_oVV3g-1; Fri, 23 Sep 2022 07:34:33 -0400 X-MC-Unique: WxR3GrKZOCqkUD7z_oVV3g-1 Received: from smtp.corp.redhat.com (int-mx10.intmail.prod.int.rdu2.redhat.com [10.11.54.10]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 9B7D83806721; Fri, 23 Sep 2022 11:34:32 +0000 (UTC) Received: from t480s.redhat.com (unknown [10.39.192.189]) by smtp.corp.redhat.com (Postfix) with ESMTP id 78889492B06; Fri, 23 Sep 2022 11:34:27 +0000 (UTC) From: David Hildenbrand To: linux-kernel@vger.kernel.org Cc: linux-mm@kvack.org, linux-doc@vger.kernel.org, David Hildenbrand , Linus Torvalds , Andrew Morton , Ingo Molnar , David Laight , Jonathan Corbet , Andy Whitcroft , Joe Perches , Dwaipayan Ray , Lukas Bulwahn , Baoquan He , Vivek Goyal , Dave Young , Jani Nikula , Michael Ellerman , Nicholas Piggin , Christophe Leroy , Akira Yokosawa , Kalle Valo , "Daniel K ." Subject: [PATCH v2 0/2] coding-style.rst: document BUG() and WARN() rules Date: Fri, 23 Sep 2022 13:34:23 +0200 Message-Id: <20220923113426.52871-1-david@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Scanned-By: MIMEDefang 3.1 on 10.11.54.10 Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org As it seems to be rather unclear if/when to use BUG(), BUG_ON(), VM_BUG_ON(), WARN_ON_ONCE(), ... let's try to document the result of a recent discussion. Details can be found in patch #1. v1 -> v2: * "coding-style.rst: document BUG() and WARN() rules ("do not crash the kernel")" -> Minor rephrasing / reference fix [John] -> Compile fix [Akira] * "powerpc/prom_init: drop PROM_BUG()" -> Dropped because it will go upstream via a different tree * "checkpatch: warn on usage of VM_BUG_ON() and other BUG variants" -> Rephrase warning message and remove trailing period [John+Joe] RFC -> v1: * "coding-style.rst: document BUG() and WARN() rules ("do not crash the kernel")" -> Rephrase/extend according to John -> Add some details regarding the use of panic() * powerpc/prom_init: drop PROM_BUG() -> Added * "checkpatch: warn on usage of VM_BUG_ON() and other BUG variants" -> Warn on more variants Cc: Linus Torvalds Cc: Andrew Morton Cc: Ingo Molnar Cc: David Laight Cc: Jonathan Corbet Cc: Andy Whitcroft Cc: Joe Perches Cc: Dwaipayan Ray Cc: Lukas Bulwahn Cc: Baoquan He Cc: Vivek Goyal Cc: Dave Young Cc: Jani Nikula Cc: Michael Ellerman Cc: Nicholas Piggin Cc: Christophe Leroy Cc: Akira Yokosawa Cc: Kalle Valo Cc: Daniel K. David Hildenbrand (2): coding-style.rst: document BUG() and WARN() rules ("do not crash the kernel") checkpatch: warn on usage of VM_BUG_ON() and other BUG variants Documentation/process/coding-style.rst | 62 ++++++++++++++++++++++++++ scripts/checkpatch.pl | 6 +-- 2 files changed, 65 insertions(+), 3 deletions(-) -- 2.37.3