From patchwork Thu Nov 17 17:25:25 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: 625501 Delivered-To: patch@linaro.org Received: by 2002:a17:522:c983:b0:460:3032:e3c4 with SMTP id kr3csp1007927pvb; Thu, 17 Nov 2022 09:30:12 -0800 (PST) X-Google-Smtp-Source: AA0mqf7II+03+dFyK6u9TgvG4DDHSKSUGN8/nXxm9DBJrSsML034aA3GCQE+wHvB47wK2lIxqJwJ X-Received: by 2002:a37:607:0:b0:6ec:56df:12dd with SMTP id 7-20020a370607000000b006ec56df12ddmr2584322qkg.124.1668706212806; Thu, 17 Nov 2022 09:30:12 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1668706212; cv=none; d=google.com; s=arc-20160816; b=dx0RfdInJ1LypMYxsSqun4d3lM2hv5FAF/u169mcJLD3oIHgEcvhZ7a/bsh5CmRStj sOLnqhfS9xlKbRvYOJmALdFV4Ew/UfmAfwL+p/GUf+IwWRXXzMNPsWPSBPxrO8YTpfjS yxMOo7jlBb6YMNvHxu63CXqDhT0ebR5YpjSSFvvcbYG1cCJpR0jclf9EJqyOfoD87nmp Ui8qPn1sYGI+hpiNyMgXgbf4hxYnOCVZj7i+gazvcBMLk0i2df/b2sHSKcJ6cby4K84m d/msA6/5dRnWQ4wQA8AqAz7/z7MIhH826/wfCoLcRoaT78x8u8txDGl8Anyb910ojzqy Bq7w== 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=7dn3LYPsrO5MbYIeyGRbprma5QBVCnZAiF7XUQjrkFs=; b=L0Gw5pmY1zye4MrZFoTXQCVA5U1UQHn/rwh0zx/3tiduHIYxrsGQzn+xSpFMCHxGob ArU8SpLhYjrmLofVyqPMmReLbBLxjxlsqP2lxfzbyz10rpSg+uin8uIu1Z8fQIF4VUhw jM4dM3ly3xiVTJHHQQYRIaRJdVBcnFj8oTckorPbwf6IFlz8fr3CSH+J+9mayeaBH1Rp CCOVjewXCwr4ep3cfw1W0PHj2hqn83TgEutWeMvzaKukUumV3V0Hi6mfR/XxaPcZFTOv i5UccgGjNrIriiW3YGMqXtEeGlz9APuQ+CKprjxwx1A4Z6MJ+j+US+7UBWIhgBnSM9V0 b4tw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=pcGoj9oW; 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 x9-20020a05622a000900b003a612161453si792580qtw.164.2022.11.17.09.30.12 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Thu, 17 Nov 2022 09:30:12 -0800 (PST) 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=pcGoj9oW; 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] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ovieD-0006PL-De; Thu, 17 Nov 2022 12:25:57 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ovie2-0006KX-Ct for qemu-devel@nongnu.org; Thu, 17 Nov 2022 12:25:47 -0500 Received: from mail-wm1-x333.google.com ([2a00:1450:4864:20::333]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ovidw-0006ED-BI for qemu-devel@nongnu.org; Thu, 17 Nov 2022 12:25:43 -0500 Received: by mail-wm1-x333.google.com with SMTP id i186-20020a1c3bc3000000b003cfe29a5733so5626173wma.3 for ; Thu, 17 Nov 2022 09:25:39 -0800 (PST) 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=7dn3LYPsrO5MbYIeyGRbprma5QBVCnZAiF7XUQjrkFs=; b=pcGoj9oWj8iaNBySHG7ylm7ymDRkm8WhOsUWj8R8twOBzx1uO6W5KAGZ+vDJBLn0rK LWMu+lfP/sw45YHGphUw9a0/ex1LAFGI2rNaW0irAd03c54ITLxHbfJzu2DWIlQXOaHq 3pvYUH8PogbzNVkoKiDObhAgSp1cTcOZQyniw1/eLTGmIvFdOsWq+4m7jm6ebJnIELgx Y+xHZmd/e6xENHdxkQYh9WvjJJFWYy24rR0wvEv7RtFJLYCaJSogN2+ibBLjYCVRU5ae t/nAA8bjUOIaT5IYZIoNOLPor5B+sNppIDi7/cAnoWvBMwJGsQQMY5dNyk+7pKPDcq4T fm7A== 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=7dn3LYPsrO5MbYIeyGRbprma5QBVCnZAiF7XUQjrkFs=; b=oTBNT6sYaIQbMU7pqlNWQTBvrflxhu68Yst/j0uAAH4uHwFleANi2CggtFCz2qDqMG hls5yxBSEnIlIsB1+JM2703mmOR6qEQaS0hBELaiSdNPqKHvYz9ZTZFa7ry5yZGK73Ar RapV7RO19ju3rtFthbONBsl5KMs5Qp1Yg+CWMOEiwkfR49Zz976YP8VPbGTSMQlwNYrE OuzpK69NRTWDBxB4NPnqwg362CjzV9Cd6kyfzQJGqmC2NcIcpfwgpgsxEYjjnrM5ubWH vNUPCYhLeKJXdgedR2/7fL//zjiKSMNlofMA7F86Q3tSlSw4tDt64RiFmGlPXi4BKf9w 8VeQ== X-Gm-Message-State: ANoB5pmyAx+RA5QpySTiWDC82FhPOz+yeC4ydDm6MLm201eb3aJUwL4n iwu9D77Z5hQ/bE9oLDDvkGvNTQ== X-Received: by 2002:a05:600c:3ba1:b0:3d0:47c:9ff5 with SMTP id n33-20020a05600c3ba100b003d0047c9ff5mr1290265wms.121.1668705937511; Thu, 17 Nov 2022 09:25:37 -0800 (PST) Received: from zen.linaroharston ([185.81.254.11]) by smtp.gmail.com with ESMTPSA id d5-20020adffbc5000000b002417e7f0685sm1798388wrs.9.2022.11.17.09.25.34 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 17 Nov 2022 09:25:35 -0800 (PST) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 707CB1FFBE; Thu, 17 Nov 2022 17:25:33 +0000 (GMT) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: fam@euphon.net, berrange@redhat.com, f4bug@amsat.org, aurelien@aurel32.net, pbonzini@redhat.com, stefanha@redhat.com, crosa@redhat.com, =?utf-8?q?Alex_Benn=C3=A9e?= Subject: [PATCH v3 06/13] docs/devel: simplify the minimal checklist Date: Thu, 17 Nov 2022 17:25:25 +0000 Message-Id: <20221117172532.538149-7-alex.bennee@linaro.org> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20221117172532.538149-1-alex.bennee@linaro.org> References: <20221117172532.538149-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::333; envelope-from=alex.bennee@linaro.org; helo=mail-wm1-x333.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-bounces+patch=linaro.org@nongnu.org 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 Reviewed-by: Stefan Hajnoczi Reviewed-by: Paolo Bonzini Message-Id: <20221111145529.4020801-8-alex.bennee@linaro.org> Reviewed-by: Philippe Mathieu-Daudé --- docs/devel/submitting-a-patch.rst | 75 ++++++++++++++++++++----------- 1 file changed, 49 insertions(+), 26 deletions(-) diff --git a/docs/devel/submitting-a-patch.rst b/docs/devel/submitting-a-patch.rst index 9c7c4331f3..1f2bde0625 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: Real 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 therefore 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: