From patchwork Tue Nov 15 13:34:36 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: 624831 Delivered-To: patch@linaro.org Received: by 2002:a17:522:c983:b0:460:3032:e3c4 with SMTP id kr3csp2978028pvb; Tue, 15 Nov 2022 05:36:46 -0800 (PST) X-Google-Smtp-Source: AA0mqf7DjWfuT4sYbrxM3RkxHfcPNFT4l1B3+dKvxqXFORs3+PwYzjybtFHgJdmf+7jwCqsm7qyV X-Received: by 2002:a05:622a:4297:b0:3a5:9e4f:9d91 with SMTP id cr23-20020a05622a429700b003a59e4f9d91mr16421789qtb.624.1668519406570; Tue, 15 Nov 2022 05:36:46 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1668519406; cv=none; d=google.com; s=arc-20160816; b=cK4svNJlF9YYoIFeUu/SRf4UBqTZkrYdj4nsF6W0cR6+EJzJvG7lV3YeHeORI48HEw SCYePIZtUECt/0Azh4lqf/vYhoiU72H/il8uxp9iKmMYUDKjguxX1n86v/UseQNShHot 5DC3EmbHyX2v1fTGTd3Xye4Nd9bxbhn0gLXK58UB+PWbAegbpS1h6FU/eTSc3zZmxwp6 P14tpLfjsPzjsnkY39SA4zptvPJWWhK5eB0SgusI6BDzJp9TyVD8wYCNLwb2aAm3/UNY uyguZWGLHDXP4iYnN0maWPwvMSgbP9hD1ZsaQfBpNYEJGPIRvigZsGczvHS45qgRm33h laFA== 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=vFHZHnJKPSci7uDkM2NVwinZ5Gudl28BkgH8YMFGrRU=; b=aKlx5UgdNO3nFMlYNSNhL0RMYphBVICr1BtxUMitHNwgvi81wZGFG3Hfr4lk5xrMT3 U4+WR8d8nHyxjypu/9Vu8tCKayziVTN1RrOQBL/xWYUFJ9rXiIH1IaDlC8AtIf3xqTPt hWEFY9LBJ5ARaoFyjtoV/H6TqXsLnsnp+7ZoyTmaxWaTPJSdEdI59iqhOCd1R9SqvOj8 D/pE+6eY/LYBP16iDTMRIrJrMkQLXcS/1GWCoj0IVPiBhDJ4Szneydt310OxWFAnNCl6 NE7xycxh5nKfQ41lXiZRXw1RwG7IBhcIFymjEuf0X3oPAIwMksWsVtvgPB2Yz99xGGxj cqkg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=ZVL59jkO; 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 br20-20020a05622a1e1400b0039a1d73d2dcsi7202950qtb.226.2022.11.15.05.36.46 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Tue, 15 Nov 2022 05:36:46 -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=ZVL59jkO; 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 1ouw6d-0006XF-6H; Tue, 15 Nov 2022 08:36:06 -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 1ouw5U-0006IX-KL for qemu-devel@nongnu.org; Tue, 15 Nov 2022 08:34:54 -0500 Received: from mail-wr1-x431.google.com ([2a00:1450:4864:20::431]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ouw5S-0004LA-EX for qemu-devel@nongnu.org; Tue, 15 Nov 2022 08:34:52 -0500 Received: by mail-wr1-x431.google.com with SMTP id d9so19575102wrm.13 for ; Tue, 15 Nov 2022 05:34:50 -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=vFHZHnJKPSci7uDkM2NVwinZ5Gudl28BkgH8YMFGrRU=; b=ZVL59jkOKVkXnx6SEWK9U9dTL40k22JvWICIao1xXW6z+SemjxzwUhTL3Q6HefH5sX pK5W3I/0LyFDiXjSDCoup3qQ+yV5Lp4Le/kZgk8Z8kX4ClVGgAyhMOLiCZVW8KUdZBqj PPfP34F4KOaDRCbMZ4PvnzRtb75cPgmss8EvH6/TjvNI7T2QPs8LyhGpgTkEjNNXwF/Y 2oXBijRQ1rqjStQkn/9ZxUqdJHqFdi2w52T9xt+btOXiM79rJTb/Q8QyE1cZXvVweXZq KS2eIQoCZN9R5TDGpbP9PM5uauT3xvsbOZiO4PJYJmoG1tT3cnNz9GODjHDSXw9XiZIJ 6rRA== 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=vFHZHnJKPSci7uDkM2NVwinZ5Gudl28BkgH8YMFGrRU=; b=mgqQuTjAmcGcPFGuSxVKBOCImz7b0+oY7Nw5XUo1mpWYsHkc6CVQ7xFSDntyrYIdE9 IssgUGEfoxBcrIQSALMP1AqeUyb4i6PffcLrSvOBV1VNpjl7GXKMfATjedwl5Y7XTbUU Wtkgwc+SYrvgQ84RNCRAOZaMa2+bYPuRSqrr+y8kB/JIwRge0Glch6tEAfwfuqrmvJU/ Vr/CnFvVaZis4I5CR0V0v8l0SttglfMqaK7EFKtcn4OEZ5yX+clmXEmFQjHi/0iqR6v3 VyWKqHwx/qyw3ic0fQnOjoE1di7lq6G0BzICesj9cRn2fIeihixDDy6ZcauQQYALHWTY sqdw== X-Gm-Message-State: ANoB5pminho0tBb8IlJfizoy0oHBdMxcWxWisCqK/TjO4di82eAD3yub Po8vvp/ti1IAirhnkgLXUeoG4nMX98ZMOA== X-Received: by 2002:a5d:4c44:0:b0:236:c45d:e268 with SMTP id n4-20020a5d4c44000000b00236c45de268mr11225596wrt.74.1668519289028; Tue, 15 Nov 2022 05:34:49 -0800 (PST) Received: from zen.linaroharston ([185.81.254.11]) by smtp.gmail.com with ESMTPSA id p5-20020a05600c358500b003c6b9749505sm24354238wmq.30.2022.11.15.05.34.41 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 15 Nov 2022 05:34:43 -0800 (PST) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id ED98E1FFBF; Tue, 15 Nov 2022 13:34:39 +0000 (GMT) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: stefanha@redhat.com, =?utf-8?q?Alex_Benn=C3=A9e?= , Paolo Bonzini Subject: [PULL 07/10] docs/devel: simplify the minimal checklist Date: Tue, 15 Nov 2022 13:34:36 +0000 Message-Id: <20221115133439.2348929-8-alex.bennee@linaro.org> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20221115133439.2348929-1-alex.bennee@linaro.org> References: <20221115133439.2348929-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::431; envelope-from=alex.bennee@linaro.org; helo=mail-wr1-x431.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> 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: