From patchwork Mon Jan 15 00:48:42 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Kent Gibson X-Patchwork-Id: 188001 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:693c:2614:b0:101:6a76:bbe3 with SMTP id mm20csp1433138dyc; Sun, 14 Jan 2024 16:50:44 -0800 (PST) X-Google-Smtp-Source: AGHT+IHIGhWLyAjS7nsNGVi/yzRt3RUNYK/PZlosskoeQsrM+m7HVOpHYIjFEXtL4kJgESxOBCHW X-Received: by 2002:a05:6830:1446:b0:6da:300f:744 with SMTP id w6-20020a056830144600b006da300f0744mr5161948otp.50.1705279844611; Sun, 14 Jan 2024 16:50:44 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1705279844; cv=none; d=google.com; s=arc-20160816; b=HNNqcQBkbgsKN/n+b3bo8wubz6ayEplGmKJK+2miY8qu+jghb710A4l7Ont/yJRow6 4AjXs70fNzmyLu7fIANII/aPws1OB3opYqcvqfYBAPYfxTmQmhXXqaWvHBkaoiF1b99p Ae2nbPAS8Byw6CqN4zYUy79RMaYh+3aHkHAn4uxnZwUCLZHQ2dVLybLWzL3ZjPc5GDo4 3QU38MBYQseSbqSm6U1gc7qYjiXv9FwOaHXK5qTcR5CUbz/aa5Z/lgy5/q7VlWoyczwn LJS7mKWJ0CWyVq9HZhphY3ODOyibjO0DGnZySpmiQoTBQ2Ay0mVmx3NCVu/mEtvnCQmU jHnA== 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:references:in-reply-to:message-id :date:subject:cc:to:from:dkim-signature; bh=DT6DB3XTDC40oMMuTXn3Vaf1U+FT3q/F4RaRZt+9Hsw=; fh=VAUkZTzChiIGUh6kITzrsogUwm1/k7LdkteM1zwsPa0=; b=DadqX50kQgrV1CKiwz/AFPkqeEIUOBgwe07KvW7uUtMjSxv+l9oGvMpfUX+9moZoud GhBC6d5ktNvoPd1uvZCKbfHT5pD2KZQt59TLll1TvcmCWEK3M1BOsTtbAGqJAxarV5DT cJyYKWC7tDF8eahT4aq3vQEy89LjLkOKrYbi7DjaDg7vXDY4WvzolsQ2lHD/LMThTY9C KkhEnpidDgiKfwppTHmOAQ0af6Cp/o1vAHtcs00sY4THr9oBtrvvM/O0AKEd3JZTdxsW 1Jq7nSSJqjY8HOW2PovsQCf1o0AFAU78B9w5YqWYa09Q58ow5EHe+NyvvK5vtewh3tJ9 SVPw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20230601 header.b=A1fT7xfS; spf=pass (google.com: domain of linux-kernel+bounces-25569-ouuuleilei=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) smtp.mailfrom="linux-kernel+bounces-25569-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from sv.mirrors.kernel.org (sv.mirrors.kernel.org. [139.178.88.99]) by mx.google.com with ESMTPS id u28-20020a056a00099c00b006db05fad13fsi7961895pfg.380.2024.01.14.16.50.44 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 14 Jan 2024 16:50:44 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-25569-ouuuleilei=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20230601 header.b=A1fT7xfS; spf=pass (google.com: domain of linux-kernel+bounces-25569-ouuuleilei=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) smtp.mailfrom="linux-kernel+bounces-25569-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.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 sv.mirrors.kernel.org (Postfix) with ESMTPS id 62122281159 for ; Mon, 15 Jan 2024 00:50:44 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 3CDCE4402; Mon, 15 Jan 2024 00:49:58 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="A1fT7xfS" Received: from mail-oi1-f179.google.com (mail-oi1-f179.google.com [209.85.167.179]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 9738D3C00; Mon, 15 Jan 2024 00:49:50 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Received: by mail-oi1-f179.google.com with SMTP id 5614622812f47-3bd6ef33227so856122b6e.0; Sun, 14 Jan 2024 16:49:50 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1705279789; x=1705884589; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=DT6DB3XTDC40oMMuTXn3Vaf1U+FT3q/F4RaRZt+9Hsw=; b=A1fT7xfSnqKtt50iehnuLNPQdJWL+VTD8/9FKlBPZ2wCDnRj/ArMsBwt1YJJEpZYP1 e5/e0EfP5x7w/qUeof3WcpSgAKNiaQGC6y4AkpjMTstCjis4yOYOXfDVFeBiB2qdZVqT FsLtPQzETJMIj0cl3nXULIa1KC0DBjSgiMok+h5ycK++p6elPSVugo/UOCCa3UBgFXka ZzfMADF378feRrybgRbCDBkgWAKyCrWx4RhivwoV9kdM1cokTWqSRgLV5BhpkLHVktdW 6uAy7pljMxT5WhE/K2wkLW/BuaspS83EuHkg7RTRbBCNxxfzW9gjfwrLtmoM2yY1tlJD WIvg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1705279789; x=1705884589; 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=DT6DB3XTDC40oMMuTXn3Vaf1U+FT3q/F4RaRZt+9Hsw=; b=kzwEF9ay1WXIj05luwq73um+LpIPZ9KZESEiNlABmnmoIY57K7f3t6R+CXhgkFzIaB 4dH183whJx//FIV21dBay4snsFZPvmVz52Tmqf/LstOvPCSpopHGC8VpFJph2RsLwjyk qElLzRZxbNi5VSrey1yX/wymvBbvO+eSs5r1sl0TDiazSWx0J1hG/KdXG+3sCDLNNvIW lkciykVTPAtxDQA/9knVVkkk8Y6hJ/SBmEdeZM6XpTnK7FTXmqEqqNo0lszuVw/sVCw+ e/AvGIB4rRKiiX9mOHqdq5rmXAmiNCn02BLGH9OM0genxFqrnbfv9eJ+uV4qsBkCl2js noUA== X-Gm-Message-State: AOJu0YwIFR1doe875QIg7YLiJbJDcqaTfTd1KrsBaUSO6SehbXJ1yHgq IV/k9uBTENNbUdLtWVnn9/FU1goV6RQ4bA== X-Received: by 2002:a05:6808:1312:b0:3bd:6ab0:b98 with SMTP id y18-20020a056808131200b003bd6ab00b98mr4698191oiv.15.1705279789506; Sun, 14 Jan 2024 16:49:49 -0800 (PST) Received: from rigel.home.arpa (60-241-235-125.tpgi.com.au. [60.241.235.125]) by smtp.gmail.com with ESMTPSA id 4-20020aa79204000000b006d999f4a3c0sm6538365pfo.152.2024.01.14.16.49.46 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 14 Jan 2024 16:49:49 -0800 (PST) From: Kent Gibson To: linux-kernel@vger.kernel.org, linux-gpio@vger.kernel.org, linux-doc@vger.kernel.org, brgl@bgdev.pl, linus.walleij@linaro.org, andy@kernel.org, corbet@lwn.net Cc: Kent Gibson Subject: [PATCH v2 4/9] Documentation: gpio: move sysfs into an obsolete section Date: Mon, 15 Jan 2024 08:48:42 +0800 Message-Id: <20240115004847.22369-5-warthog618@gmail.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20240115004847.22369-1-warthog618@gmail.com> References: <20240115004847.22369-1-warthog618@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1788115518073868586 X-GMAIL-MSGID: 1788115518073868586 The GPIO sysfs API is long obsolete, so highlight this even further by moving it into an obsolete APIs section in both the admin-guide and userspace-api books. Signed-off-by: Kent Gibson --- Documentation/admin-guide/gpio/index.rst | 2 +- Documentation/admin-guide/gpio/obsolete.rst | 11 +++++++++++ Documentation/userspace-api/gpio/index.rst | 1 + Documentation/userspace-api/gpio/obsolete.rst | 10 ++++++++++ .../{admin-guide => userspace-api}/gpio/sysfs.rst | 0 5 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 Documentation/admin-guide/gpio/obsolete.rst create mode 100644 Documentation/userspace-api/gpio/obsolete.rst rename Documentation/{admin-guide => userspace-api}/gpio/sysfs.rst (100%) diff --git a/Documentation/admin-guide/gpio/index.rst b/Documentation/admin-guide/gpio/index.rst index b40f0a2a6822..3ac3aa15fa8b 100644 --- a/Documentation/admin-guide/gpio/index.rst +++ b/Documentation/admin-guide/gpio/index.rst @@ -9,9 +9,9 @@ gpio Character Device Userspace API <../../userspace-api/gpio/chardev> gpio-aggregator - sysfs gpio-mockup gpio-sim + Obsolete APIs .. only:: subproject and html diff --git a/Documentation/admin-guide/gpio/obsolete.rst b/Documentation/admin-guide/gpio/obsolete.rst new file mode 100644 index 000000000000..dbf88f13c680 --- /dev/null +++ b/Documentation/admin-guide/gpio/obsolete.rst @@ -0,0 +1,11 @@ +.. SPDX-License-Identifier: GPL-2.0 + +================== +Obsolete GPIO APIs +================== + +.. toctree:: + :maxdepth: 1 + + Sysfs Interface <../../userspace-api/gpio/sysfs> + diff --git a/Documentation/userspace-api/gpio/index.rst b/Documentation/userspace-api/gpio/index.rst index 072b9fa18aea..f258de4ef370 100644 --- a/Documentation/userspace-api/gpio/index.rst +++ b/Documentation/userspace-api/gpio/index.rst @@ -8,6 +8,7 @@ GPIO :maxdepth: 1 Character Device Userspace API + Obsolete Userspace APIs .. only:: subproject and html diff --git a/Documentation/userspace-api/gpio/obsolete.rst b/Documentation/userspace-api/gpio/obsolete.rst new file mode 100644 index 000000000000..c27bd6014a3d --- /dev/null +++ b/Documentation/userspace-api/gpio/obsolete.rst @@ -0,0 +1,10 @@ +.. SPDX-License-Identifier: GPL-2.0 + +============================ +Obsolete GPIO Userspace APIs +============================ + +.. toctree:: + :maxdepth: 1 + + Sysfs Interface diff --git a/Documentation/admin-guide/gpio/sysfs.rst b/Documentation/userspace-api/gpio/sysfs.rst similarity index 100% rename from Documentation/admin-guide/gpio/sysfs.rst rename to Documentation/userspace-api/gpio/sysfs.rst