[tip:,x86/urgent] x86/Documentation: Indent 'note::' directive for protocol version number note
| Message ID | 169927189613.3135.13352646601079651163.tip-bot2@tip-bot2 |
|---|---|
| State | New |
| Headers |
Return-Path: <linux-kernel-owner@vger.kernel.org>
Delivered-To: ouuuleilei@gmail.com
Received: by 2002:a59:8f47:0:b0:403:3b70:6f57 with SMTP id j7csp2602248vqu;
Mon, 6 Nov 2023 03:58:30 -0800 (PST)
X-Google-Smtp-Source:
AGHT+IFJoQ9hfJV5wbGhbsdQOheXUDhfcTeAM+CubJpLu5RXbrSGAprJPxCsAsxAsjmDYt7hWDQF
X-Received: by 2002:a17:902:f990:b0:1c6:21b4:30bb with SMTP id
ky16-20020a170902f99000b001c621b430bbmr21336662plb.15.1699271909784;
Mon, 06 Nov 2023 03:58:29 -0800 (PST)
ARC-Seal: i=1; a=rsa-sha256; t=1699271909; cv=none;
d=google.com; s=arc-20160816;
b=Rb8O3eV9/7tY+MRlXlpzOLe/UxVfmxYVBzW0Tb72iYm1qPcwa3Q0l4XF/9jMfIddx0
S5pbd8wJtRbLMlQPYTs8aPbedOTJTHafdFioIoo/jfVL5HmJuRcbVEJwr+UPfgPqlUf6
OCajXiilfzcMpaa+Fs3/SnCTzlYY3rDPCIT8DXPQWls5ReWMUdu1Bw57BF6F4AXpZ10n
q025E6ojq0eC/luNSBEVxkJ/ovZfM4HwpAN1ujawC8gxl8qjdB3r0H2QL2/SD5H7TYSt
ExDOi+TogieABa4xzoO1twFY8z1iTIAhrqawEnwQ/OsQ88uwFT4z4Uyu5bNQAeL4qRc5
1Emg==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com;
s=arc-20160816;
h=list-id:precedence:content-transfer-encoding:robot-unsubscribe
:robot-id:message-id:mime-version:references:in-reply-to:cc:subject
:to:reply-to:sender:from:dkim-signature:dkim-signature:date;
bh=Df9J214P8Zz/oGO9QrDdGXEMmj4NrRZS6MYKXAvIxCc=;
fh=Hw6k3nz5hfsKFus22VC4Jr/k2y9opZ8Wec30w0rKZ2I=;
b=Twi6F/YijkrIQ4wKug007GPoGz/UZay2pIw9/vBCart1+QatkiCLMdnDxyeULK5Ry8
U4X0LmMkp0WIFDUC9p0VNN8WUoEb23v08nW4kDp3B4IMxVPvKuD6tiC0KxgcMRgOX/sS
9Nw/VI4k4AjpOb2E78KjN8ftdupdATF67eIVWJBbDZWBizNsaKuAPauBxs38qV1DgKJF
vo61euUMEofS53WX1CJQNWeN9ir+F+a3XNpvvnUwJ9hiA6HO39w+RpUdk6HVQEXz0+4O
MJuhL+/t5SPGYVeElWO65Fb/7o3oYpMfgdNF+1mjwxzixDRvmutvbW40F0C2scrXKvhC
UHsQ==
ARC-Authentication-Results: i=1; mx.google.com;
dkim=pass header.i=@linutronix.de header.s=2020 header.b=M1kghMME;
dkim=neutral (no key) header.i=@linutronix.de header.b=8GEYy3ZA;
spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org
designates 23.128.96.37 as permitted sender)
smtp.mailfrom=linux-kernel-owner@vger.kernel.org;
dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de
Received: from snail.vger.email (snail.vger.email. [23.128.96.37])
by mx.google.com with ESMTPS id
j13-20020a170903024d00b001c9b3c3ce7asi8195525plh.300.2023.11.06.03.58.29
(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
Mon, 06 Nov 2023 03:58:29 -0800 (PST)
Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org
designates 23.128.96.37 as permitted sender) client-ip=23.128.96.37;
Authentication-Results: mx.google.com;
dkim=pass header.i=@linutronix.de header.s=2020 header.b=M1kghMME;
dkim=neutral (no key) header.i=@linutronix.de header.b=8GEYy3ZA;
spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org
designates 23.128.96.37 as permitted sender)
smtp.mailfrom=linux-kernel-owner@vger.kernel.org;
dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de
Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0])
by snail.vger.email (Postfix) with ESMTP id F39A9805DC04;
Mon, 6 Nov 2023 03:58:28 -0800 (PST)
X-Virus-Status: Clean
X-Virus-Scanned: clamav-milter 0.103.10 at snail.vger.email
Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand
id S231533AbjKFL6Z (ORCPT <rfc822;jaysivo@gmail.com> + 36 others);
Mon, 6 Nov 2023 06:58:25 -0500
Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57662 "EHLO
lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org
with ESMTP id S231472AbjKFL6X (ORCPT
<rfc822;linux-kernel@vger.kernel.org>);
Mon, 6 Nov 2023 06:58:23 -0500
Received: from galois.linutronix.de (Galois.linutronix.de
[IPv6:2a0a:51c0:0:12e:550::1])
by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 066EC94;
Mon, 6 Nov 2023 03:58:18 -0800 (PST)
Date: Mon, 06 Nov 2023 11:58:16 -0000
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linutronix.de;
s=2020; t=1699271897;
h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date:
message-id:message-id:to:to:cc:cc:mime-version:mime-version:
content-type:content-type:
content-transfer-encoding:content-transfer-encoding:
in-reply-to:in-reply-to:references:references;
bh=Df9J214P8Zz/oGO9QrDdGXEMmj4NrRZS6MYKXAvIxCc=;
b=M1kghMMEkrl+K+UtS7CV8LZdbVZFYP+qnp5SDw60+zbXKl2DJq6Yu6dNw9M2J0jWFIO4EP
zZfxAp9bXxToG7daTUcl8AJZIq14aTLpMuecIQiRrDCJJl27B50O5rVG40HS2t1E7T+cG1
p9xLkC6bRNKbPWCcsYwi6qQ8MUSJEqBctcqbs80Tn1VRu30fCpC5omNi5DRI+wGZPHmTO4
RJ3SPeMN7cpKjHvVNSP57GTmcg/jwVUobXPF5UWyGSElVeli9U11+OejqEgOi9wcx7zD/E
Wc0/2wwwolPAwjNXYSLfrLhxk1qGxgaATqhaxBMd8jgciMXrnj5XcwCJGvYlzw==
DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=linutronix.de;
s=2020e; t=1699271897;
h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date:
message-id:message-id:to:to:cc:cc:mime-version:mime-version:
content-type:content-type:
content-transfer-encoding:content-transfer-encoding:
in-reply-to:in-reply-to:references:references;
bh=Df9J214P8Zz/oGO9QrDdGXEMmj4NrRZS6MYKXAvIxCc=;
b=8GEYy3ZAQlQUp4WOpr3BpHEhGgZ0drOnhm1lm+La67VYnpFcfhglpNB+oSK9/Rlt4r4JYA
dwx0gs8XxJxq88Cg==
From: "tip-bot2 for Bagas Sanjaya" <tip-bot2@linutronix.de>
Sender: tip-bot2@linutronix.de
Reply-to: linux-kernel@vger.kernel.org
To: linux-tip-commits@vger.kernel.org
Subject: [tip: x86/urgent] x86/Documentation: Indent 'note::' directive for
protocol version number note
Cc: Bagas Sanjaya <bagasdotme@gmail.com>,
Ingo Molnar <mingo@kernel.org>,
Jonathan Corbet <corbet@lwn.net>, x86@kernel.org,
linux-kernel@vger.kernel.org
In-Reply-To: <20231106101206.76487-2-bagasdotme@gmail.com>
References: <20231106101206.76487-2-bagasdotme@gmail.com>
MIME-Version: 1.0
Message-ID: <169927189613.3135.13352646601079651163.tip-bot2@tip-bot2>
Robot-ID: <tip-bot2@linutronix.de>
Robot-Unsubscribe: Contact <mailto:tglx@linutronix.de> to get blacklisted from
these emails
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_BLOCKED,
SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE 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: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-Greylist: Sender passed SPF test,
not delayed by milter-greylist-4.6.4 (snail.vger.email [0.0.0.0]);
Mon, 06 Nov 2023 03:58:29 -0800 (PST)
X-getmail-retrieved-from-mailbox: INBOX
X-GMAIL-THRID: 1781815741971079837
X-GMAIL-MSGID: 1781815741971079837
|
| Series |
[tip:,x86/urgent] x86/Documentation: Indent 'note::' directive for protocol version number note
|
|
Commit Message
tip-bot2 for Thomas Gleixner
Nov. 6, 2023, 11:58 a.m. UTC
The following commit has been merged into the x86/urgent branch of tip:
Commit-ID: 18216762bcf618c52b85719d3563243f80e4a2d4
Gitweb: https://git.kernel.org/tip/18216762bcf618c52b85719d3563243f80e4a2d4
Author: Bagas Sanjaya <bagasdotme@gmail.com>
AuthorDate: Mon, 06 Nov 2023 17:12:04 +07:00
Committer: Ingo Molnar <mingo@kernel.org>
CommitterDate: Mon, 06 Nov 2023 12:53:57 +01:00
x86/Documentation: Indent 'note::' directive for protocol version number note
The protocol version number note is between the protocol version table and
the memory layout section. As such, Sphinx renders the note directive not
only on the actual note, but until the end of doc.
Indent the directive so that only the actual protocol version number
note is rendered as such.
Fixes: 2c33c27fd603 ("x86/boot: Introduce kernel_info")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: Ingo Molnar <mingo@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20231106101206.76487-2-bagasdotme@gmail.com
Signed-off-by: Ingo Molnar <mingo@kernel.org>
---
Documentation/arch/x86/boot.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/arch/x86/boot.rst b/Documentation/arch/x86/boot.rst index f5d2f24..22cc7a0 100644 --- a/Documentation/arch/x86/boot.rst +++ b/Documentation/arch/x86/boot.rst @@ -77,7 +77,7 @@ Protocol 2.14 BURNT BY INCORRECT COMMIT Protocol 2.15 (Kernel 5.5) Added the kernel_info and kernel_info.setup_type_max. ============= ============================================================ -.. note:: + .. note:: The protocol version number should be changed only if the setup header is changed. There is no need to update the version number if boot_params or kernel_info are changed. Additionally, it is recommended to use