From patchwork Tue Jul 4 05:24:03 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 115561 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:9f45:0:b0:3ea:f831:8777 with SMTP id v5csp985982vqx; Mon, 3 Jul 2023 22:25:24 -0700 (PDT) X-Google-Smtp-Source: APBJJlEJzT43E37dFhipIGThfv+Acg//+bNzgJpvIxfohJYa3b7TdAdnjO5oqsD5Wfa8xcOB/Vu2 X-Received: by 2002:a05:6359:bb0:b0:134:28d6:be7 with SMTP id gf48-20020a0563590bb000b0013428d60be7mr9114892rwb.9.1688448324367; Mon, 03 Jul 2023 22:25:24 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1688448324; cv=none; d=google.com; s=arc-20160816; b=aE1Yjb8Oz/hBOIefxtSrVfa+8b/3lxN/Wb8Q3qkONxNvnHLHS76P79sEABSvzZJYzy YRWH2k0x5mTvYV+bijIneYAKU9RlOzAj4VxqhLSUSURCMNKXYpyICPC3ehl/99qGKQeA YgAUutyckxTFpY/rZEQadu5RpMka71JihsctuKH4ioc7xftbN8pfuQNoJ0a/3a+Fu3Wy MhuPZ52/wNa/kIykdxlU6qo1A6DG2C1qDwTCEYVfPO8p6o49Vl7ddIzTIq7QgyLtpIQJ kg4/DtTCbwiKfOYm7w5UT2yMrSM2DhfaqhQ9tgq/ffPd19WMjvNJxgTiEponkLP2kwpc rM8w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from:dkim-signature; bh=fiR1+lFkN2QVNdbkR0zd5B6McX2iHjjNhF7dWolHvAY=; fh=qaQBYOSscPye/YoBG2OFhpMAe2+mq+pFE0BAdwIADkw=; b=vrwTla+JHEq0foNfZ6RAB/3hYRv9s/r16dsPTofIJc5gYmKTam5j2zbbWa5QRlTei/ hrWgf0jV7Rjm8KTc7wKfS5p4Skjm/GKIeUkAfOSZMhWMckr+0etHL1s0XeADiweZS7ME fiR3EVdJbwnC/3+7c5RCrVamMmta94es54HTmbU6ezpMy1kiR4EGk+8frSgyqgZGZrAE lk+FTDLCuC2uvhZvw6LTEXZXMJRgyHRRiClphk+BM5Ui7v4vHesOS5FcrQtLhFYqspyM ZfJuQH4oBFBL6EMxtQmIenjSWoBpvxMOntOU0KrLLyG+KVuPn/hfR06p+QrhAWqDBVs3 tRUg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=od2wZMvb; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id bk13-20020a056a02028d00b005539d3ab914si21260741pgb.694.2023.07.03.22.25.10; Mon, 03 Jul 2023 22:25:24 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=od2wZMvb; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230197AbjGDFYJ (ORCPT + 99 others); Tue, 4 Jul 2023 01:24:09 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33092 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229441AbjGDFYH (ORCPT ); Tue, 4 Jul 2023 01:24:07 -0400 Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:3::133]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 07DE9BD; Mon, 3 Jul 2023 22:24:07 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type: Content-ID:Content-Description:In-Reply-To:References; bh=fiR1+lFkN2QVNdbkR0zd5B6McX2iHjjNhF7dWolHvAY=; b=od2wZMvbbm+a53f1gqi9uGaZ7D A14n+3uWiMVP/UqCNg8bHm39l054jjJdJT/iod1S9+2mCrBwlDAuzUARuJ4fp8UiMRoqMzkf8plsi +6Bw2JZDgRXGnDjQG9MVT7IKyk8fFkXsq7raPYW+jH4FMWp17ThqD9nkwn6yMu2Y4WgkR47ToiAEr HsHo6kWdzsxixrS1k9f4DZXRge7Gfqqc9Uqme1WxTeNlkm2GIC4LvVxh++UMYQR1wue7FIb0r71Jg v4TnMuqXw6SgOeQpv2wUfgHa49GiOmnP4wS4vG7R851Guu9E67UfipygyLTf8dBVhCoyTcGjAppLw ADjrG16A==; Received: from [2601:1c2:980:9ec0::2764] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1qGYWE-00CCEU-0C; Tue, 04 Jul 2023 05:24:06 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , John Stultz , Thomas Gleixner , Stephen Boyd , Jonathan Corbet , linux-doc@vger.kernel.org Subject: [PATCH 1/3] docs: time: make separate section for time and timers Date: Mon, 3 Jul 2023 22:24:03 -0700 Message-ID: <20230704052405.5089-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.41.0 MIME-Version: 1.0 X-Spam-Status: No, score=-4.4 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_MED,SPF_HELO_NONE, SPF_NONE,T_SCC_BODY_TEXT_LINE,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1770466390018325659?= X-GMAIL-MSGID: =?utf-8?q?1770466390018325659?= Give time & timer APIs their own section and begin adding entries to that section. Move hrtimers immediately after this new section so that they are all together. Signed-off-by: Randy Dunlap Cc: John Stultz Cc: Thomas Gleixner Cc: Stephen Boyd Cc: Jonathan Corbet Cc: linux-doc@vger.kernel.org --- Documentation/driver-api/basics.rst | 27 +++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff -- a/Documentation/driver-api/basics.rst b/Documentation/driver-api/basics.rst --- a/Documentation/driver-api/basics.rst +++ b/Documentation/driver-api/basics.rst @@ -15,8 +15,8 @@ Driver device table :no-identifiers: pci_device_id -Delaying, scheduling, and timer routines ----------------------------------------- +Delaying and scheduling routines +-------------------------------- .. kernel-doc:: include/linux/sched.h :internal: @@ -33,16 +33,16 @@ Delaying, scheduling, and timer routines .. kernel-doc:: include/linux/completion.h :internal: -.. kernel-doc:: kernel/time/timer.c - :export: - -Wait queues and Wake events ---------------------------- +Time and timer routines +----------------------- -.. kernel-doc:: include/linux/wait.h +.. kernel-doc:: include/linux/jiffies.h :internal: -.. kernel-doc:: kernel/sched/wait.c +.. kernel-doc:: kernel/time/time.c + :export: + +.. kernel-doc:: kernel/time/timer.c :export: High-resolution timers @@ -57,6 +57,15 @@ High-resolution timers .. kernel-doc:: kernel/time/hrtimer.c :export: +Wait queues and Wake events +--------------------------- + +.. kernel-doc:: include/linux/wait.h + :internal: + +.. kernel-doc:: kernel/sched/wait.c + :export: + Internal Functions ------------------