Received: by 2002:a05:7412:3290:b0:fa:6e18:a558 with SMTP id ev16csp14893rdb; Thu, 25 Jan 2024 07:03:31 -0800 (PST) X-Google-Smtp-Source: AGHT+IEQq1BZka6I4Z2gVdNlrLfAxvz9fNUbcRd77h84EsE3pg0vLan49rwzN6PLeOu9nU76jYA2 X-Received: by 2002:a05:6402:50b:b0:559:ea16:130 with SMTP id m11-20020a056402050b00b00559ea160130mr745169edv.26.1706195011329; Thu, 25 Jan 2024 07:03:31 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1706195011; cv=pass; d=google.com; s=arc-20160816; b=NVtBK8egH2JvHPOvbbJp3zlrb/9e/dh9ZXcn0QgK2deeagaWTy4HceBMMPORnHXuLV jyfDophwoAJBfWPtzEjvFJy4obz3aHVkCvC77Cxw4JDcFzuFvoR3sHHDbzd5Y8tdhONa tMcJSzkx4K3v09Hqq4Af4684/vGBzG4HIn43n1FuyedkXNqo9lyyoPvVqUEkjSdCJ0yb OrgljbOQpSZlENU+NhkU3f1BKkE42iJVZcLOg9hSZGMnl4NwOoPQv9iFdXWqSfppt8jO kWf+NPnL56Yr10b/Kut5u2+V1vESkk0qhwHznBGT2t+6sskxtKDTdxlfX+l6Gea/U4YG OcwQ== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=mime-version:list-unsubscribe:list-subscribe:list-id:precedence :message-id:date:references:in-reply-to:subject:cc:to:from :dkim-signature:dkim-filter; bh=19H+ohazVHtseGiYiVAg+hU89peX8rovYsg56MVemuI=; fh=l1PxStHjvnmxmUCxVGQ0bwXTpEPw9g8YIceCIujc2Ds=; b=pHZ7Xhh/wu6xb3AIbnb8RgBm0lsjBQQzUII7cA2RzfrgCnJ6Q4blEID+83j82boGPY gcBVwMXd/zpnVgm3ONHonBcanW4DptG3lVG2QBBc51+RpUD11NU1CVmWI30bbV/wbzgO FJGWpvnLOSxAywN3Wu7vOvOfHyUNq6QyYhDVSQA1VBIZWKEMMpDfLXT2rk/MbznXtwfJ Olcj7SOsvtuyLawnkHytW8Slz+cMQTCVCbom0tPEw09WQ4AfqJytpXIiWWtsF/4Ft1Jy gNUKXiKVIDlxv1K4IT2uK+ClG6UQZQ/p8sKudSK8cjY3AyEVGF1DpHqBGXNQatSk0MGV 7SNw== ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@lwn.net header.s=20201203 header.b=W7J4Aj8j; arc=pass (i=1 spf=pass spfdomain=lwn.net dkim=pass dkdomain=lwn.net dmarc=pass fromdomain=lwn.net); spf=pass (google.com: domain of linux-kernel+bounces-38788-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) smtp.mailfrom="linux-kernel+bounces-38788-linux.lists.archive=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=lwn.net Return-Path: Received: from am.mirrors.kernel.org (am.mirrors.kernel.org. [2604:1380:4601:e00::3]) by mx.google.com with ESMTPS id fi14-20020a056402550e00b00557a9932fb7si14862848edb.150.2024.01.25.07.03.31 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 25 Jan 2024 07:03:31 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-38788-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3; Authentication-Results: mx.google.com; dkim=pass header.i=@lwn.net header.s=20201203 header.b=W7J4Aj8j; arc=pass (i=1 spf=pass spfdomain=lwn.net dkim=pass dkdomain=lwn.net dmarc=pass fromdomain=lwn.net); spf=pass (google.com: domain of linux-kernel+bounces-38788-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) smtp.mailfrom="linux-kernel+bounces-38788-linux.lists.archive=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=lwn.net Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by am.mirrors.kernel.org (Postfix) with ESMTPS id 8C73D1F255A3 for ; Thu, 25 Jan 2024 15:03:14 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 6598E7319A; Thu, 25 Jan 2024 15:00:46 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=lwn.net header.i=@lwn.net header.b="W7J4Aj8j" Received: from ms.lwn.net (ms.lwn.net [45.79.88.28]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id DFEF36EB54; Thu, 25 Jan 2024 15:00:43 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=45.79.88.28 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1706194845; cv=none; b=ZcT6dvDSY10AcTk/LpPXGnEn73vunHreU/16O28AXO8vX5dfwhcjyldbzbnIxAJD+LHaVjnF+eEKRuVcSH4d79lVNFer29AUY8siP2TLPiPIkZy4uSozgltP9rDQ42DJcHFZeokUkfaB7C9+kuViO9Sv+7WUoQw0g6LEKfXLBZo= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1706194845; c=relaxed/simple; bh=pBmISwiuDHvWTZNjtbdX+o01/6GuunQ6rno2/95NOs4=; h=From:To:Cc:Subject:In-Reply-To:References:Date:Message-ID: MIME-Version:Content-Type; b=pGc0Y+XZKHLcBMAPhK5yhrpVsYkA7FrFDN8Zv4tTxOyhGyomwSlaELeUeNbOjWMpxJfNy2H7FRwH1FCiB+r20bguEZGclwqJf2Lk/4rz3+poMWDLXy9/uTdiWoBla6r0g+1IoZ2PSSOfIruwCHUovaDVRog/8wGtJzzZaTlb78o= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=lwn.net; spf=pass smtp.mailfrom=lwn.net; dkim=pass (2048-bit key) header.d=lwn.net header.i=@lwn.net header.b=W7J4Aj8j; arc=none smtp.client-ip=45.79.88.28 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=lwn.net Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=lwn.net Received: from localhost (unknown [IPv6:2601:280:5e00:7e19::646]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ms.lwn.net (Postfix) with ESMTPSA id F1B027A98; Thu, 25 Jan 2024 15:00:40 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net F1B027A98 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1706194841; bh=19H+ohazVHtseGiYiVAg+hU89peX8rovYsg56MVemuI=; h=From:To:Cc:Subject:In-Reply-To:References:Date:From; b=W7J4Aj8j1Qr/slt8R4Q1kt+tx8l4FGxwsZqSveb4K6Gpi2st9BOZlsrB3+NB41Hau 7nEIVQFtwdCFHMDPuE69Aig/Yf/VLTh1H//0mOpDL5z1FbKIetLRQ2mM7m5DN4XGCJ Z6SrYLHHctQHSBRN8F326JPoBNxRPNywN9K/7nvh56+DUtaw8FHsMj9YC8Pj/0mUsQ jYBKpwD7Vdqv1iNVlOV3n0JUPtKiH+XAcgRO+iAxs4+Gz8+kkBPFAI+aJ8vjaypAUU rrLQvIX8nhDxgcwh5QZ75CwubwuI9CTp9VHfAHlGTvhAnMzfm2hvPPmJsYnF9rIiED Ia1uGJWg7v/bw== From: Jonathan Corbet To: Anna-Maria Behnsen , Randy Dunlap , linux-kernel@vger.kernel.org Cc: Thomas Gleixner , Frederic Weisbecker , Ingo Molnar , John Stultz , Stephen Boyd , Clemens Ladisch , linux-doc@vger.kernel.org Subject: Re: [PATCH 6/8] Documentation: Create a new folder for all timer internals In-Reply-To: <87o7d9d7dd.fsf@somnus> References: <20240123164702.55612-1-anna-maria@linutronix.de> <20240123164702.55612-7-anna-maria@linutronix.de> <8eac7bf0-86c5-43ef-99e0-0896c994184a@infradead.org> <87o7d9d7dd.fsf@somnus> Date: Thu, 25 Jan 2024 08:00:40 -0700 Message-ID: <87plxpbgpz.fsf@meer.lwn.net> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain Anna-Maria Behnsen writes: > 4. Add a warning banner at the existing documentation and prepare > everything to get the timer documentation to the proper place and > create a place for timer documentation below the current structure. > > The benefit of 4. for me is, that there is this warning banner at the > top. So this suggests the reader, that this has to be revisited before > relying on it for 100%. This banner might also remind the original > author/technically deep involved developer that this should be > updated. The best thing, of course, is to just fix all of the documentation and make it perfect now :) Failing that, the banners are fine IMO. They mark possibly obsolete docs, warning readers, and also just might, in an optimal world, inspire somebody else to work to improve the situation. I've thought for a while that we should have a standard warning or two along these lines, like Wikipedia does, but of course haven't done anything about it. jon