From patchwork Thu Jan 4 07:33:17 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dhruva Gole X-Patchwork-Id: 184928 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7301:6f82:b0:100:9c79:88ff with SMTP id tb2csp5465308dyb; Wed, 3 Jan 2024 23:34:12 -0800 (PST) X-Google-Smtp-Source: AGHT+IGp+0ksGk64/9gLcOxBByhJ3mKXocdAXUNPMn4LwsH3Cr+PNDPLCyTVxDwHo1rqSiClIO8w X-Received: by 2002:a05:6a20:3d8b:b0:199:5c:e1b9 with SMTP id s11-20020a056a203d8b00b00199005ce1b9mr214050pzi.1.1704353652675; Wed, 03 Jan 2024 23:34:12 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1704353652; cv=none; d=google.com; s=arc-20160816; b=0Zb83eeSlTcqVwVocaBwFLhRrjS/guDDmQZ3f9SHpoPQDii3iMtB/Q9ETaZqfIEyqX 9amzD5yyiw1UbVCStVVxq6bZjBBwA9tCGigOFjOkOUVNZr73fMkJUlxO6LTLIIPPF5nv XoXSZvYdhQgZNvKaC8bGm04jXuKrVg9EL9jEKLKXEMLEftSIcawLwxs3xPQeVgpIO3o/ mR5vrBnseb5m3kkUTRpTsUWRqnBe+slV4o3l3xczwA3G28OA87NEiS4luIRMCn7Ck365 bWHtJR7gQS3QZDk86h6cLlfGfxVCUOtpbOJG8MUibW66otUqc2dwnlHr6KGHz/X6EREt Usiw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:list-unsubscribe :list-subscribe:list-id:precedence:message-id:date:subject:cc:to :from:dkim-signature; bh=1YL4NazULIndzcTvOUJLeOSh+6JCTKDvgwntK+e06L8=; fh=mL4mcvC0rMZCP4AWimR7uv7IMwrl1JdlJPJDJkziryo=; b=M41cL0ySCYV/6UkYX/x3IYhDe8JqNg4C0I6ZkRXax7V5UYxZJIgjqRawZdOc+0nxfN 2NheQ+ihtqCc1T/4qULCfwDM16dNpFWqj0addHtNEiDBQ3KCxfqCKF3aNVYOnOhVs3Uu EJh6T9rF2Pe4/a37QU976ups+UMU/j8/AX3hOVXtMiuzlX+EhwzpQBQ95kOTLaW7wyYx jNjIWZzfJmz3kqq9MQIra360o/ZmIlCXgk8APQ1I9aIZJICcfABuDmU9XlEiRu9DSij7 sd9Sidugb5X4ROs2y/UTSR/MlhFxJSXFqp8+phUnbL2dOAQaYMxC9DZcbwTHrxx/tAup m9LQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@ti.com header.s=ti-com-17Q1 header.b=siffy2q7; spf=pass (google.com: domain of linux-kernel+bounces-16321-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-16321-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=QUARANTINE sp=NONE dis=NONE) header.from=ti.com Received: from sy.mirrors.kernel.org (sy.mirrors.kernel.org. [2604:1380:40f1:3f00::1]) by mx.google.com with ESMTPS id 15-20020a63124f000000b005ce01a07040si15445308pgs.504.2024.01.03.23.34.12 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 03 Jan 2024 23:34:12 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-16321-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) client-ip=2604:1380:40f1:3f00::1; Authentication-Results: mx.google.com; dkim=pass header.i=@ti.com header.s=ti-com-17Q1 header.b=siffy2q7; spf=pass (google.com: domain of linux-kernel+bounces-16321-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-16321-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=QUARANTINE sp=NONE dis=NONE) header.from=ti.com 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 sy.mirrors.kernel.org (Postfix) with ESMTPS id 64553B24805 for ; Thu, 4 Jan 2024 07:34:00 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 9CCF2200CD; Thu, 4 Jan 2024 07:33:46 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=ti.com header.i=@ti.com header.b="siffy2q7" X-Original-To: linux-kernel@vger.kernel.org Received: from lelv0142.ext.ti.com (lelv0142.ext.ti.com [198.47.23.249]) (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 18050200A0; Thu, 4 Jan 2024 07:33:41 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=ti.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=ti.com Received: from fllv0035.itg.ti.com ([10.64.41.0]) by lelv0142.ext.ti.com (8.15.2/8.15.2) with ESMTP id 4047Xdm3063000; Thu, 4 Jan 2024 01:33:39 -0600 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ti.com; s=ti-com-17Q1; t=1704353619; bh=1YL4NazULIndzcTvOUJLeOSh+6JCTKDvgwntK+e06L8=; h=From:To:CC:Subject:Date; b=siffy2q77BbTdXaUwKd9xiGfAyS0v0FF1SmYGbIzpdwDrvAUFF20QFgoTsgyHzGVL jcRZX/NKUJ78N1BaW9DQTdzJ+3gPSClr/dXDaegC7W3ZlfqiPj8hmUJljwmx/dU/FN BjZIWpjvVnXIbxA+pfP093qpjcsucFf5/kDcrBe4= Received: from DLEE106.ent.ti.com (dlee106.ent.ti.com [157.170.170.36]) by fllv0035.itg.ti.com (8.15.2/8.15.2) with ESMTPS id 4047XdaZ082970 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=FAIL); Thu, 4 Jan 2024 01:33:39 -0600 Received: from DLEE103.ent.ti.com (157.170.170.33) by DLEE106.ent.ti.com (157.170.170.36) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.2507.23; Thu, 4 Jan 2024 01:33:38 -0600 Received: from lelvsmtp6.itg.ti.com (10.180.75.249) by DLEE103.ent.ti.com (157.170.170.33) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.2507.23 via Frontend Transport; Thu, 4 Jan 2024 01:33:38 -0600 Received: from dhruva.dhcp.ti.com (dhruva.dhcp.ti.com [172.24.227.68]) by lelvsmtp6.itg.ti.com (8.15.2/8.15.2) with ESMTP id 4047Xatc060915; Thu, 4 Jan 2024 01:33:37 -0600 From: Dhruva Gole To: Jonathan Corbet CC: , , Dhruva Gole Subject: [PATCH] Documentation: index: Minor re-arrangement and improvements Date: Thu, 4 Jan 2024 13:03:17 +0530 Message-ID: <20240104073317.19709-1-d-gole@ti.com> X-Mailer: git-send-email 2.34.1 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-EXCLAIMER-MD-CONFIG: e1e8a2fd-e40a-4ac6-ac9b-f7e9cc9ee180 X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1787144335416261710 X-GMAIL-MSGID: 1787144335416261710 * It seems odd that a develper is forced to look at the licensing rules even before they get to the doc or coding guide. This belongs under the "Working with the development community" / "All development docs" page where it does reside even today. * Rearrange the section for Internal API manuals to go lower because generally one would want to look at the tools and processes and admin guide pages first and then move onto something deeper like the API manuals. * Reword the Dev tools section and title to something a bit more suitable. Signed-off-by: Dhruva Gole --- Documentation/index.rst | 34 ++++++++++++++++------------------ 1 file changed, 16 insertions(+), 18 deletions(-) base-commit: d0b3c8aa5e37775cd7c3ac07b256218df0fd6678 diff --git a/Documentation/index.rst b/Documentation/index.rst index 36e61783437c..409eba0b9601 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -28,30 +28,14 @@ community and getting your work upstream. maintainer/index All development-process docs - -Internal API manuals -==================== - -Manuals for use by developers working to interface with the rest of the -kernel. - -.. toctree:: - :maxdepth: 1 - - core-api/index - driver-api/index - subsystem-apis - Locking in the kernel - -Development tools and processes +Development tools and resources =============================== -Various other manuals with useful information for all kernel developers. +Various tools and manuals with useful information for all kernel developers. .. toctree:: :maxdepth: 1 - process/license-rules doc-guide/index dev-tools/index dev-tools/testing-overview @@ -81,6 +65,20 @@ developers seeking information on the kernel's user-space APIs. See also: the `Linux man pages `_, which are kept separately from the kernel's own documentation. +Internal API manuals +==================== + +Manuals for use by developers working to interface with the rest of the +kernel. + +.. toctree:: + :maxdepth: 1 + + core-api/index + driver-api/index + subsystem-apis + Locking in the kernel + Firmware-related documentation ============================== The following holds information on the kernel's expectations regarding the