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=-5.5 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS, USER_AGENT_SANE_1 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 388D1C433E2 for ; Sat, 18 Jul 2020 14:08:17 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 222482070E for ; Sat, 18 Jul 2020 14:08:17 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727779AbgGROIN (ORCPT ); Sat, 18 Jul 2020 10:08:13 -0400 Received: from netrider.rowland.org ([192.131.102.5]:50019 "HELO netrider.rowland.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with SMTP id S1726574AbgGROIN (ORCPT ); Sat, 18 Jul 2020 10:08:13 -0400 Received: (qmail 1180025 invoked by uid 1000); 18 Jul 2020 10:08:11 -0400 Date: Sat, 18 Jul 2020 10:08:11 -0400 From: Alan Stern To: Dave Chinner Cc: Eric Biggers , linux-kernel@vger.kernel.org, linux-arch@vger.kernel.org, "Paul E . McKenney" , linux-fsdevel@vger.kernel.org, Akira Yokosawa , Andrea Parri , Boqun Feng , Daniel Lustig , "Darrick J . Wong" , David Howells , Jade Alglave , Luc Maranget , Nicholas Piggin , Peter Zijlstra , Will Deacon Subject: Re: [PATCH] tools/memory-model: document the "one-time init" pattern Message-ID: <20200718140811.GA1179836@rowland.harvard.edu> References: <20200717044427.68747-1-ebiggers@kernel.org> <20200718014204.GN5369@dread.disaster.area> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20200718014204.GN5369@dread.disaster.area> User-Agent: Mutt/1.10.1 (2018-07-13) Sender: linux-fsdevel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-fsdevel@vger.kernel.org > This is one of the reasons that the LKMM documetnation is so damn > difficult to read and understand: just understanding the vocabulary > it uses requires a huge learning curve, and it's not defined > anywhere. Understanding the syntax of examples requires a huge > learning curve, because it's not defined anywhere. Have you seen tools/memory-model/Documentation/explanation.txt? That file was specifically written for non-experts to help them overcome the learning curve. It tries to define the vocabulary as terms are introduced and to avoid using obscure syntax. If you think it needs improvement and can give some specific details about where it falls short, I would like to hear them. Alan Stern