From patchwork Fri Nov 11 14:55:24 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: 623738 Delivered-To: patch@linaro.org Received: by 2002:a17:522:c983:b0:460:3032:e3c4 with SMTP id kr3csp827450pvb; Fri, 11 Nov 2022 06:57:14 -0800 (PST) X-Google-Smtp-Source: AA0mqf4DPySeqr76/DcNgXhg8QIvQ6mFZtNmCJsOUbW+ecgRd4GITeL9KNkGAoVDM607pmt1tWlB X-Received: by 2002:a05:622a:4808:b0:3a5:be2:9a04 with SMTP id fb8-20020a05622a480800b003a50be29a04mr1583638qtb.402.1668178634547; Fri, 11 Nov 2022 06:57:14 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1668178634; cv=none; d=google.com; s=arc-20160816; b=X0DRmN2KBonjmgDbflRBsiqErY78+BE7jFHuXBLCEKxoGXsUpjGgek3+zRcIP5DYZU oKyg7AZpsMYgqW+ukOvsCzNyyx5pOcR96Idg7IvvLAJ73LVMJMLYRDLwiY9gRrFf2Ef1 b6tc6PSZ7Q5Hh7WvAMN6T41BMoKqu/97oLKOJpbLW2ejY2mE05wVLG+/i5FF+b2R7pNA S7gU1Lg8XeRtuQkQjt499yzh/P6+7goYPX5r3sfrUm46FSZiukNF4JcJm/z0UdYOr4YU ZXW8e3uOflBqn+2/mS1r8VPhfTzMAajXJu/ErraQfemGKgxy7YTALL5TdJgamJIavTL+ hp9g== 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=Tx51MAAfbml8CiT50HNaT+ihFTBqcLj/nxt/MFriuNA=; b=OziyjNgAlS4HDprqI6z5U6m99vfr4SaQcDiOumAuNEIMTYaofcfpVq2+ZMkh66mCvy MjWsmrHzmQTHt+yAsSAgIIAE2ERC0fYBhLDgrF0HxtQw7TbrH42t0Mmb+gXelPb5pH7w MIproeFlF+6GGWTzNqW+tgVaTz+wdfEbEUKCeTjvdKNqy3Pxskw2BuR0WFXBzYP0YTJg l3jlXMAevzheQof0EMhwrYp9kxJ8FpWipTL1S7IE7Dp6pysJGRVpV0o+ubXtfAw/gSWn RsTrPsFlwndC6pF7ArJn8FKY2NgIzOxUuQNhwMzWJfRTBEe72H9oVfbgfspw1D4AVXAq VZnA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=zHIJYHDP; 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 d15-20020ac851cf000000b003984706c7c4si1023769qtn.356.2022.11.11.06.57.14 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Fri, 11 Nov 2022 06:57:14 -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=zHIJYHDP; 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 1otVRb-00075B-OO; Fri, 11 Nov 2022 09:55:47 -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 1otVRW-00072w-QG for qemu-devel@nongnu.org; Fri, 11 Nov 2022 09:55:42 -0500 Received: from mail-wm1-x334.google.com ([2a00:1450:4864:20::334]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1otVRT-0007xS-IS for qemu-devel@nongnu.org; Fri, 11 Nov 2022 09:55:42 -0500 Received: by mail-wm1-x334.google.com with SMTP id m7-20020a05600c090700b003cf8a105d9eso3285052wmp.5 for ; Fri, 11 Nov 2022 06:55:38 -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=Tx51MAAfbml8CiT50HNaT+ihFTBqcLj/nxt/MFriuNA=; b=zHIJYHDPPlQgEPEMWsPKCWMwdePRvj8e9G/sTzxGSX7YrSxB4BeED0NVQBkerYmpJr BSTY5Je18CIP7suUj0MbbvUX0+o5z4s3OBRTSnmelnBZjMQUzhw0TCGRGIVFPyc+KNuD pc+BIh2/IKr4GWN/i3GkgMJkK4A1moCbDrDnek9/fCAIe2MMeofHGjxm4X+bkRliVT23 LvfLwRha4pM6gwCYHXc1Ix5MA/ZyOEoOfVPaEmtQp8tzUhrNbwQ6Qq+lOV0sveggb0bp Nz6/fmGoS8wPGUOJrFzjzvcxJVHuScEbml1IwT1yXbzTtN6Xx0FQDmVtQYhfjrL8f1ll HEjw== 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=Tx51MAAfbml8CiT50HNaT+ihFTBqcLj/nxt/MFriuNA=; b=npTB5aDBDHNqx3NJ0ByIDdoD5IsljuJDww+jVCF9ErK6tCLk8hHMfNlvaMrPebqRus Wc942aY8ubUXwXIuxv1bHfwcrYdAcQfer3yV6ctcaTDNb9l45r80qHQlgmZgTK4VWjVM PBdr2tIXNGwHDvSUk085IILzhMPsPEXbUi8/gm2w9pETHHLgUjqDA7TzyfP/L/vVLz/2 7kMqftK0X8FgYfH8uvNKsqcPLyhdfIuVWOK09GkEdUII4gZtNHEQ8SGaXrDDLqzBGw6Y 4WvjjZxNVnskHF+7yiJ9IkgVvbjuaKAtS7Nm7W++AtSdDQTGUmOs0KPyTj1sdr6RpES4 emTg== X-Gm-Message-State: ANoB5pncf0Lbjf8tmyuFuqYz9j86FwDlqbfPiCQ9YvXBRbIKLh23+NS5 t4UtcY7tz28hTUjD14Mgypipfw== X-Received: by 2002:a7b:c04a:0:b0:3cf:a5b8:2a09 with SMTP id u10-20020a7bc04a000000b003cfa5b82a09mr1473816wmc.125.1668178537379; Fri, 11 Nov 2022 06:55:37 -0800 (PST) Received: from zen.linaroharston ([185.81.254.11]) by smtp.gmail.com with ESMTPSA id y15-20020a5d614f000000b0022ae401e9e0sm2126489wrt.78.2022.11.11.06.55.31 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 11 Nov 2022 06:55:32 -0800 (PST) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id A78B41FFBF; Fri, 11 Nov 2022 14:55:30 +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 v2 07/12] docs/devel: simplify the minimal checklist Date: Fri, 11 Nov 2022 14:55:24 +0000 Message-Id: <20221111145529.4020801-8-alex.bennee@linaro.org> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20221111145529.4020801-1-alex.bennee@linaro.org> References: <20221111145529.4020801-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::334; envelope-from=alex.bennee@linaro.org; helo=mail-wm1-x334.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: <20221012121152.1179051-4-alex.bennee@linaro.org> --- v2 - emphasise a Real Name should be used - s/therefor/therefore/ --- 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: