From patchwork Thu Jun 1 14:55:55 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Costa Shulyupin X-Patchwork-Id: 101995 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:994d:0:b0:3d9:f83d:47d9 with SMTP id k13csp395507vqr; Thu, 1 Jun 2023 08:02:58 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ70PI+efUvZyAwehc/aLMEf+oNBvKaWM0pigUHITLvtDPnSV4VpFnoKdu1IP+OsHzh/WGVa X-Received: by 2002:a05:6a00:1786:b0:627:6328:79f1 with SMTP id s6-20020a056a00178600b00627632879f1mr8554541pfg.34.1685631777691; Thu, 01 Jun 2023 08:02:57 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1685631777; cv=none; d=google.com; s=arc-20160816; b=Wy6vFAM03SWPF7SEP3notMmZwvxgVoDRLthJqI8Yo74Yox1hqubglF009UG5CiVolU q6WIGd/ouxIkSICaQDcUG44Yy9ASyRT/IbW+3f6AgipubcCEvrYxu2mE2DzHMtw+Xkw/ ev6mnioRRLRuspdNI7gCSLI0Sy1wp1+IiZodD1xNTnhRizs8JCn1wen54E8ZL41a9+yO Eh1vN2CBSlV2ka8vksBdMxgm/IuuKJGwVysErixp8Ihz0Cy0grKj1NwmLHrCDLjgRxUO 6C3vkjlv2ylL3txMTXsEewe7B99hNhRrm3fgJvqJx4pYQBmlqkX8aN5oA26a58D/fX1N Zk4w== 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 :references:in-reply-to:message-id:date:subject:cc:to:from; bh=6pQX1x+nXF4H20kd14hFqiq2M6ndmVSb039N9uVMABU=; b=eCKn7UdCxOrYsxFfLO+d4uum2uvvmG2cvgP24Xpu6bosGl0lyn3uWesFcxvAVZo2Zs xCZF7Q2QKYlBZpi72+d1eHej7GzPkYB/BqMFu7JTzW0+MBBfTt9XqocR4BC0djLJGj/d GjKFI7CT6OmJDtZSp1SzsWXRTw0acVlWFyX4hUp3dqRxaH+DtlT80yFXgxZv39WNYd9g MzZZBjSM9TQVSHiRkpzxgi1TGNN9+zkHoKHQxevg7zir6JJSdVtY8TAqsJ64Rpo8iSy9 35Tsx5sVCeaqOtqaUfEKxCDnr+wjWwQdvene9jWQrsmLhVbYZkp1U9WWTjvrR4M4Su7n ICcA== ARC-Authentication-Results: i=1; mx.google.com; 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; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=redhat.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id q12-20020aa7960c000000b00648019bae38si5610405pfg.277.2023.06.01.08.02.18; Thu, 01 Jun 2023 08:02:57 -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; 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; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=redhat.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234513AbjFAO4y (ORCPT + 99 others); Thu, 1 Jun 2023 10:56:54 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:38960 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233870AbjFAO4w (ORCPT ); Thu, 1 Jun 2023 10:56:52 -0400 Received: from mail-lj1-f170.google.com (mail-lj1-f170.google.com [209.85.208.170]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id A6502107; Thu, 1 Jun 2023 07:56:50 -0700 (PDT) Received: by mail-lj1-f170.google.com with SMTP id 38308e7fff4ca-2af290cf9b7so12928431fa.3; Thu, 01 Jun 2023 07:56:50 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1685631409; x=1688223409; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=6pQX1x+nXF4H20kd14hFqiq2M6ndmVSb039N9uVMABU=; b=M54yAih28+g4x2/uh0AkDPpDr6CcGoY7DPAzik2ricRhJPDgWWKV646dprSX/WbM7d 2xRTQOt1UdWPPHco9dMIegPU2zu8o0VeqlnhO2eNZz+vLqZLmTcbTNunEToGaZK8BS4b 7JSq4hZu+N1zahd6+FCaPZT3GFowq3jFJ0sWk2lHl41+xkN4UawzDG5wzNsASeANbPs+ 9VXavpFKvSo18R3SdGXYPKJULwNjYiLLtiIklPdv6+LJnRm8aptfLSlQIyy/c0T8GeUd S0lZEFYajUwhgryTvwCXodfq3s1lAI7ULw10OU1nwRTqhns7HutnkX5GCI+NSFmG39un Sd7A== X-Gm-Message-State: AC+VfDwH1GNgbJ2Js0jPPimdqIos28rjAJMA0SxXMUn/Dinx5Ufkt+X0 sUbXiHto5DYNYHHrjlh4YZw= X-Received: by 2002:a2e:3203:0:b0:2ad:dd7e:6651 with SMTP id y3-20020a2e3203000000b002addd7e6651mr5556136ljy.43.1685631408555; Thu, 01 Jun 2023 07:56:48 -0700 (PDT) Received: from costa-tp.bos2.lab ([2a00:a040:1a3:c11b:3ae6:1732:e587:a81f]) by smtp.gmail.com with ESMTPSA id y24-20020a2e9d58000000b002b135080b1esm366217ljj.12.2023.06.01.07.56.46 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 01 Jun 2023 07:56:47 -0700 (PDT) From: Costa Shulyupin To: Jonathan Corbet , linux-doc@vger.kernel.org, Bagas Sanjaya Cc: Costa Shulyupin , linux-kernel@vger.kernel.org (open list), bpf@vger.kernel.org (open list:BPF [MISC]) Subject: [PATCH v3] Documentation: subsystem-apis: Categorize remaining subsystems Date: Thu, 1 Jun 2023 17:55:55 +0300 Message-Id: <20230601145556.3927838-1-costa.shul@redhat.com> X-Mailer: git-send-email 2.40.1 In-Reply-To: References: MIME-Version: 1.0 X-Spam-Status: No, score=-1.4 required=5.0 tests=BAYES_00, FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM,HEADER_FROM_DIFFERENT_DOMAINS, RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,SPF_HELO_NONE,SPF_PASS, T_SCC_BODY_TEXT_LINE autolearn=no 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?1767513026673666001?= X-GMAIL-MSGID: =?utf-8?q?1767513026673666001?= From: Bagas Sanjaya Add classes: * Core subsystems * Storage * Networking * Peripherals and devices * Embedded systems * Integrity * Virtualization * Miscellaneous There is a FIXME that says to organize subsystems listed in subsystem-apis.rst. Fulfill it by categorize remaining subsytems by purpose/themes, while sorting entries in each category. HID devices are already categorized in 3c591cc954d56e ("docs: consolidate human interface subsystems"). Signed-off-by: Costa Shulyupin --- Changes: v3: add Integrity, Virtualization and Miscellaneous per Bagas Sanjaya v2: add Core subsystems, Networking, Peripherals and Embedded v1: add Storgre category --- Documentation/subsystem-apis.rst | 119 ++++++++++++++++++++++--------- 1 file changed, 86 insertions(+), 33 deletions(-) diff --git a/Documentation/subsystem-apis.rst b/Documentation/subsystem-apis.rst index 55c90d5383ef..2c0b18a66e4e 100644 --- a/Documentation/subsystem-apis.rst +++ b/Documentation/subsystem-apis.rst @@ -10,58 +10,111 @@ is taken directly from the kernel source, with supplemental material added as needed (or at least as we managed to add it — probably *not* all that is needed). +Core subsystems +--------------- + +.. toctree:: + :maxdepth: 1 + + core-api/index + cpu-freq/index + driver-api/index + locking/index + mm/index + power/index + scheduler/index + timers/index + wmi/index + Human interfaces ---------------- .. toctree:: :maxdepth: 1 - input/index + fb/index + gpu/index hid/index + input/index sound/index - gpu/index - fb/index -**Fixme**: much more organizational work is needed here. +Storage +------- .. toctree:: :maxdepth: 1 - driver-api/index - core-api/index - locking/index - accounting/index block/index cdrom/index - cpu-freq/index - fpga/index - i2c/index - iio/index - isdn/index + filesystems/index + pcmcia/index + scsi/index + target/index + + +Networking +---------- + +.. toctree:: + :maxdepth: 1 + + bpf/index infiniband/index - leds/index + isdn/index + mhi/index netlabel/index networking/index - pcmcia/index - power/index - target/index - timers/index + + +Peripherals and devices +----------------------- + +.. toctree:: + :maxdepth: 1 + + PCI/index + hwmon/index + leds/index + misc-devices/index + usb/index + + +Embedded systems +---------------- + +.. toctree:: + :maxdepth: 1 + + fpga/index + i2c/index + iio/index + peci/index spi/index w1/index - watchdog/index + +Integrity +--------- + +.. toctree:: + :maxdepth: 1 + + crypto/index + security/index + +Virtualization +-------------- + +.. toctree:: + :maxdepth: 1 + virt/index - hwmon/index + +Miscellaneous +------------- + +.. toctree:: + :maxdepth: 1 + accel/index - security/index - crypto/index - filesystems/index - mm/index - bpf/index - usb/index - PCI/index - scsi/index - misc-devices/index - scheduler/index - mhi/index - peci/index - wmi/index + accounting/index + watchdog/index