From patchwork Wed Oct 12 12:11:51 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Alex_Benn=C3=A9e?= X-Patchwork-Id: 614560 Delivered-To: patch@linaro.org Received: by 2002:a17:522:c983:b0:460:3032:e3c4 with SMTP id kr3csp3227560pvb; Wed, 12 Oct 2022 05:13:42 -0700 (PDT) X-Google-Smtp-Source: AMsMyM6HS8tgoRRIXBJi863YwmVDhQb3M7m6k5e+g7DYzsgV7m3Wen10S16Y0wxuXg3A7JZArGN0 X-Received: by 2002:a05:6214:23cc:b0:496:fa7b:2503 with SMTP id hr12-20020a05621423cc00b00496fa7b2503mr22663064qvb.38.1665576821922; Wed, 12 Oct 2022 05:13:41 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1665576821; cv=none; d=google.com; s=arc-20160816; b=nUDunYXbHQoBB8fa8zW1KUrTLVlELLohWvi15bHfOCKZMVvXys+tANgpc2U4MwiM1u YAb5msvkTRa7QpVTVYiWfh/AQZECTX4wYf/35/wEGNj4kQQIa3EF1b2d7YMIDzWl2Ky4 pfWou712eH5kEfGfyz3pZUpW/CiCnql9DFFyunNfPt7ZZ10AaIh8C1vGc+5PKUIc4wLc P4qMynucmlQ+ZD4YTE9u/XyyZX/0wt0DBQ3KpfU6w07SYZef3CKnfP21UthDJzQJuwAK OL5mnnmFhJSPO+MSei31ZgVAt0/ETkT3PgJHwy35Fk0v519wWue9qsk26DyhtL9ykam7 1s0w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=4CKTdhbx6tlAZWIAIdhc6Vldni/ktTJ3HMieMzD9m98=; b=hZAqrmKtkeJ1VcdCc9d7RpdNDYLj8hYfwF9tfi2+owYUBfCyCwF1LhhwKEF9bBM/jw CS3ccn+0y21nVtdkgrIQXoDjD4fuX6EOwOZjco5TVHG1f5b+wSJwFyK6OyAk4zFsOk3N 1zkRPM3ZoIoXLU4rmiAnxHVB8G0B0Uh1yaCdwJ5S7AuaQHsk+Hp3uFIRrMh5QSok+BFK xtq/Sh6v9qIK86loP0PYWaYl321LNceBhMMikkYPYgL5xyAo+6Ry2z6P1Nf1LTu+8L9/ svMb7Fb40NlGM1n5YCjAirNKJ9RZBndLSG1UaCq9Eugw4bdOrJNWO2YIw4GOU8FV7Sp4 lh+w== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=KIJjR0yw; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id bt11-20020ac8690b000000b00394b3aac961si8171006qtb.380.2022.10.12.05.13.41 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Wed, 12 Oct 2022 05:13:41 -0700 (PDT) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=KIJjR0yw; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1]:45430 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oiacH-0006W8-Cv for patch@linaro.org; Wed, 12 Oct 2022 08:13:41 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:43472) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oiaaf-0006U3-95 for qemu-devel@nongnu.org; Wed, 12 Oct 2022 08:12:01 -0400 Received: from mail-wr1-x42e.google.com ([2a00:1450:4864:20::42e]:45940) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1oiaac-0006Tc-Ji for qemu-devel@nongnu.org; Wed, 12 Oct 2022 08:12:00 -0400 Received: by mail-wr1-x42e.google.com with SMTP id a10so25889700wrm.12 for ; Wed, 12 Oct 2022 05:11:58 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; 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=4CKTdhbx6tlAZWIAIdhc6Vldni/ktTJ3HMieMzD9m98=; b=KIJjR0yweqha8kdyh4iak5ahw34wEFIkzGZlOfTtwZ4P8uZ3Js/pZgSNyRd2hJ55ku XIVUcyA+dRYgSAUZdSW1vLQLLyTaFOjfudxfnRsxHtuUnbrUXJQ4aU3H7tSSpI+d8NBL dNFLf8FaTPEubkU+0cvRR4EMBGtnCkEIaGmZmkCjW4gVYro5Ad6ft8++5tImgkXFStAt oUcE1b5sQoZcUTmbz+i6k2uVPuzubC1KSOwvL6L1730sfHJWcBf8+JvQQn07Xmb/Vz58 AXbNCYdA/NnDCrXRw955hO3gSPE9AC00NXvUcpsSxIJMXo7MDZbf/ztu5dvBFtqAt1kn MMiw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; 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=4CKTdhbx6tlAZWIAIdhc6Vldni/ktTJ3HMieMzD9m98=; b=ghcydJua0AkC21HAxCyuf1+VGMa6jYTVV4MQLriYIYjU7PLKHThx/58XSotpeJ4lnd +Pd/80alBNIZcOLL68yAxJ6tgp4ukwEZdmt1NysGngee9i+GzJEVlYFlaZt/NYdeetCm UTxdl4dQRjgR3aIOMuG6i5gyW2HNKMM/dDs3DSa3nig7Qc9cLcWwakRo2iFCpjCrK1pb 3W+d5/BARAEVNCNyTsC0KpLGYSm9WxSHgypnOkppnINsVn8iMRau5j6dPWWgqsthrQAH ed8p+2dPfy/ubiduxK0Gm6NM7+q4KExHx6Ith83rXlMjWeiCN+3sAW6fojnuOTsGRt1l sA8Q== X-Gm-Message-State: ACrzQf0I8UEfjHzVjV0lb2ggsik1aiw5ffeaxp+yvotOcvCVpL434qVv cFCAmcM8Sh1kmf/9v2ONr5IEQA== X-Received: by 2002:adf:fc10:0:b0:22e:55e5:9bb5 with SMTP id i16-20020adffc10000000b0022e55e59bb5mr18089317wrr.112.1665576717190; Wed, 12 Oct 2022 05:11:57 -0700 (PDT) Received: from zen.linaroharston ([185.81.254.11]) by smtp.gmail.com with ESMTPSA id da5-20020a056000408500b00225239d9265sm14423480wrb.74.2022.10.12.05.11.53 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 12 Oct 2022 05:11:53 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id D18CB1FFBB; Wed, 12 Oct 2022 13:11:52 +0100 (BST) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: pbonzini@redhat.com, stefanha@redhat.com, peter.maydell@linaro.org, agraf@csgraf.de, =?utf-8?q?Alex_Benn=C3=A9e?= Subject: [RFC PATCH 3/4] docs/devel: simplify the minimal checklist Date: Wed, 12 Oct 2022 13:11:51 +0100 Message-Id: <20221012121152.1179051-4-alex.bennee@linaro.org> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20221012121152.1179051-1-alex.bennee@linaro.org> References: <20221012121152.1179051-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::42e; envelope-from=alex.bennee@linaro.org; helo=mail-wr1-x42e.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" The bullet points are quite long and contain process tips. Move those bits of the bullet to the relevant sections and link to them. Use a table for nicer formatting of the checklist. Signed-off-by: Alex Bennée --- docs/devel/submitting-a-patch.rst | 75 ++++++++++++++++++++----------- roms/qboot | 2 +- 2 files changed, 50 insertions(+), 27 deletions(-) diff --git a/docs/devel/submitting-a-patch.rst b/docs/devel/submitting-a-patch.rst index fb1673e974..41771501bf 100644 --- a/docs/devel/submitting-a-patch.rst +++ b/docs/devel/submitting-a-patch.rst @@ -12,25 +12,18 @@ be committed faster. This page seems very long, so if you are only trying to post a quick one-shot fix, the bare minimum we ask is that: -- You **must** provide a Signed-off-by: line (this is a hard - requirement because it's how you say "I'm legally okay to contribute - this and happy for it to go into QEMU", modeled after the `Linux kernel - `__ - policy.) ``git commit -s`` or ``git format-patch -s`` will add one. -- All contributions to QEMU must be **sent as patches** to the - qemu-devel `mailing list `__. - Patch contributions should not be posted on the bug tracker, posted on - forums, or externally hosted and linked to. (We have other mailing lists too, - but all patches must go to qemu-devel, possibly with a Cc: to another - list.) ``git send-email`` (`step-by-step setup - guide `__ and `hints and - tips `__) - works best for delivering the patch without mangling it, but - attachments can be used as a last resort on a first-time submission. -- You must read replies to your message, and be willing to act on them. - Note, however, that maintainers are often willing to manually fix up - first-time contributions, since there is a learning curve involved in - making an ideal patch submission. +.. list-table:: Minimal Checklist for Patches + :widths: 35 65 + :header-rows: 1 + + * - Check + - Reason + * - Patches contain Signed-off-by: Author Name + - States you are legally able to contribute the code. See :ref:`patch_emails_must_include_a_signed_off_by_line` + * - Sent as patch emails to ``qemu-devel@nongnu.org`` + - The project uses an email list based workflow. See :ref:`submitting_your_patches` + * - Be prepared to respond to review comments + - Code that doesn't pass review will not get merged. See :ref:`participating_in_code_review` You do not have to subscribe to post (list policy is to reply-to-all to preserve CCs and keep non-subscribers in the loop on the threads they @@ -229,6 +222,19 @@ bisection doesn't land on a known-broken state. Submitting your Patches ----------------------- +The QEMU project uses a public email based workflow for reviewing and +merging patches. As a result all contributions to QEMU must be **sent +as patches** to the qemu-devel `mailing list +`__. Patch +contributions should not be posted on the bug tracker, posted on +forums, or externally hosted and linked to. (We have other mailing +lists too, but all patches must go to qemu-devel, possibly with a Cc: +to another list.) ``git send-email`` (`step-by-step setup guide +`__ and `hints and tips +`__) +works best for delivering the patch without mangling it, but +attachments can be used as a last resort on a first-time submission. + .. _if_you_cannot_send_patch_emails: If you cannot send patch emails @@ -314,10 +320,12 @@ git repository to fetch the original commit. Patch emails must include a ``Signed-off-by:`` line ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -For more information see `SubmittingPatches 1.12 -`__. -This is vital or we will not be able to apply your patch! Please use -your real name to sign a patch (not an alias or acronym). +Your patches **must** include a Signed-off-by: line. This is a hard +requirement because it's how you say "I'm legally okay to contribute +this and happy for it to go into QEMU". The process is modelled after +the `Linux kernel +`__ +policy. If you wrote the patch, make sure your "From:" and "Signed-off-by:" lines use the same spelling. It's okay if you subscribe or contribute to @@ -327,6 +335,11 @@ include a "From:" line in the body of the email (different from your envelope From:) that will give credit to the correct author; but again, that author's Signed-off-by: line is mandatory, with the same spelling. +There are various tooling options for automatically adding these tags +include using ``git commit -s`` or ``git format-patch -s``. For more +information see `SubmittingPatches 1.12 +`__. + .. _include_a_meaningful_cover_letter: Include a meaningful cover letter @@ -397,9 +410,19 @@ Participating in Code Review ---------------------------- All patches submitted to the QEMU project go through a code review -process before they are accepted. Some areas of code that are well -maintained may review patches quickly, lesser-loved areas of code may -have a longer delay. +process before they are accepted. This will often mean a series will +go through a number of iterations before being picked up by +:ref:`maintainers`. You therefor should be prepared to +read replies to your messages and be willing to act on them. + +Maintainers are often willing to manually fix up first-time +contributions, since there is a learning curve involved in making an +ideal patch submission. However for the best results you should +proactively respond to suggestions with changes or justifications for +your current approach. + +Some areas of code that are well maintained may review patches +quickly, lesser-loved areas of code may have a longer delay. .. _stay_around_to_fix_problems_raised_in_code_review: diff --git a/roms/qboot b/roms/qboot index 8ca302e86d..a5300c4949 160000 --- a/roms/qboot +++ b/roms/qboot @@ -1 +1 @@ -Subproject commit 8ca302e86d685fa05b16e2b208888243da319941 +Subproject commit a5300c4949b8d4de2d34bedfaed66793f48ec948