From patchwork Wed Oct 12 12:11:49 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: 1689126 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@legolas.ozlabs.org Authentication-Results: legolas.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=nongnu.org (client-ip=209.51.188.17; helo=lists.gnu.org; envelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org; receiver=) Authentication-Results: legolas.ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=linaro.org header.i=@linaro.org header.a=rsa-sha256 header.s=google header.b=EGlO4wBH; dkim-atps=neutral Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-ECDSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by legolas.ozlabs.org (Postfix) with ESMTPS id 4MnWkJ4xx2z23k4 for ; Wed, 12 Oct 2022 23:12:40 +1100 (AEDT) Received: from localhost ([::1]:45434 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oiabG-0006Wx-4W for incoming@patchwork.ozlabs.org; Wed, 12 Oct 2022 08:12:38 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:43470) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oiaad-0006SR-MH for qemu-devel@nongnu.org; Wed, 12 Oct 2022 08:12:01 -0400 Received: from mail-wr1-x429.google.com ([2a00:1450:4864:20::429]:42969) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1oiaab-0006TA-J5 for qemu-devel@nongnu.org; Wed, 12 Oct 2022 08:11:59 -0400 Received: by mail-wr1-x429.google.com with SMTP id bp11so13198568wrb.9 for ; Wed, 12 Oct 2022 05:11:56 -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=L/NA9YqO2FgVjXPSvc5SGYaN0q7zDb+Qmax6Cp2I/ug=; b=EGlO4wBH+HAAmelgG8hiYNOJ8fMbkHnhodu8ZzNtZXaZhq+urLSoOeKIUKcOblws+p tm8jbrjkyR+QiSofxR79ZBvQFkbC3pGZ+xXzrsIo1Hgi2drs1EKlVwe+GCB/x+w1KdTs Cxipl1UaEp9kVCXpcgWItLb+tqfQZNTDEUXopLMLFnOUgUfC8+xR0O8rrtm0YFyT+N/T CMRGpZIIzo8mn3FItolChknzIY6sJJ1E4n/cBiuoJ15bd/eNeTq753+d8miJcG73MZZA U7SDGfblhOhCwAuWeIBqREyOql7f7c4UJVbEwb5VdRCq8z8w7X1LzuQ+CgQ7ibQ6+QLt Po5w== 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=L/NA9YqO2FgVjXPSvc5SGYaN0q7zDb+Qmax6Cp2I/ug=; b=Y1K6wrufn5hfq8QnqdoWBOAMQMXzbLLXy2n0E5TKPE85p5KwGNMuVxAeok5aR2sVis 6ef7Rb4DecLl1hxAeLuzDZPm/EpoK8k//lDIGBwEwD2PIcEiXVkIkUxX5egIIiwTLM5M peYih8FeadW+vt09+MgPuqdgdAfTojw0X1t1TIpeSD7cFh2z8B06S3xMj1AGsJ5KwuQn FnCg9vD63knWIssKlsgD5xmPPcnOQ+t0Wjdc+wO7hArJVnoIbbGU4srcBE73OsT92GqH hTQOhWPIcdwyoL3pYniEQoCo6c4KDFnuhIEk/2CLw4T5oFXKjM/ckJUNZ+j4lYXlQrWT FvWg== X-Gm-Message-State: ACrzQf12ufLzl4PZYlkBI0Nm+s7Q0vNzAlJNR2JBzXLccgDuIvxaaSj9 gZUsOcqYGwKIfLvBsBFzWpjPxQ== X-Google-Smtp-Source: AMsMyM5Kmz+msSOUGkrWuPoWNcsjtqUrF1AHqjB+xfnXVnrBz8jFJgMKn8Tw2V0uCXjQzXQFu4ZnlQ== X-Received: by 2002:adf:dec3:0:b0:22e:6efe:7861 with SMTP id i3-20020adfdec3000000b0022e6efe7861mr18327375wrn.454.1665576715053; Wed, 12 Oct 2022 05:11:55 -0700 (PDT) Received: from zen.linaroharston ([185.81.254.11]) by smtp.gmail.com with ESMTPSA id co11-20020a0560000a0b00b00228d52b935asm14079089wrb.71.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 A2EB81FFB8; 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 1/4] docs/devel: add a maintainers section to development process Date: Wed, 12 Oct 2022 13:11:49 +0100 Message-Id: <20221012121152.1179051-2-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::429; envelope-from=alex.bennee@linaro.org; helo=mail-wr1-x429.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+incoming=patchwork.ozlabs.org@nongnu.org Sender: "Qemu-devel" We don't currently have a clear place in the documentation to describe the rolls and responsibilities of a maintainer. Lets create one so we can. I've moved a few small bits out of other files to try and keep everything in one place. Signed-off-by: Alex Bennée --- docs/devel/code-of-conduct.rst | 2 + docs/devel/index-process.rst | 1 + docs/devel/maintainers.rst | 84 ++++++++++++++++++++++++ docs/devel/submitting-a-pull-request.rst | 12 ++-- 4 files changed, 91 insertions(+), 8 deletions(-) create mode 100644 docs/devel/maintainers.rst diff --git a/docs/devel/code-of-conduct.rst b/docs/devel/code-of-conduct.rst index 195444d1b4..f734ed0317 100644 --- a/docs/devel/code-of-conduct.rst +++ b/docs/devel/code-of-conduct.rst @@ -1,3 +1,5 @@ +.. _code_of_conduct: + Code of Conduct =============== diff --git a/docs/devel/index-process.rst b/docs/devel/index-process.rst index d0d7a200fd..d50dd74c3e 100644 --- a/docs/devel/index-process.rst +++ b/docs/devel/index-process.rst @@ -8,6 +8,7 @@ Notes about how to interact with the community and how and where to submit patch code-of-conduct conflict-resolution + maintainers style submitting-a-patch trivial-patches diff --git a/docs/devel/maintainers.rst b/docs/devel/maintainers.rst new file mode 100644 index 0000000000..e3c7003bfa --- /dev/null +++ b/docs/devel/maintainers.rst @@ -0,0 +1,84 @@ +.. _maintainers: + +The Roll of Maintainers +======================= + +Maintainers are a critical part of the projects contributor ecosystem. +They come from a wide range of backgrounds from unpaid hobbyists +working in their spare time to employees who work on the project as +part of their job. Maintainer activities include: + + - reviewing patches and suggesting changes + - preparing pull requests for their subsystems + - participating other project activities + +They are also human and subject to the same pressures as everyone else +including overload and burn out. Like everyone else they are subject +to projects :ref:`code_of_conduct`. + +The MAINTAINERS file +-------------------- + +The `MAINTAINERS +`__ +file contains the canonical list of who is a maintainer. The file +is machine readable so an appropriately configured git (see +:ref:`cc_the_relevant_maintainer`) can automatically Cc them on +patches that touch their area of code. + +The file also describes the status of the area of code to give an idea +of how actively that section is maintained. + +.. list-table:: Meaning of support status in MAINTAINERS + :widths: 25 75 + :header-rows: 1 + + * - Status + - Meaning + * - Supported + - Someone is actually paid to look after this. + * - Maintained + - Someone actually looks after it. + * - Odd Fixes + - It has a maintainer but they don't have time to do + much other than throw the odd patch in. + * - Orphan + - No current maintainer. + * - Obsolete + - Old obsolete code, should use something else. + +Please bare in mind that even if someone is paid to support something +it does not mean they are paid to support you. This is open source and +the code comes with no warranty and the project makes no guarantees +about dealing with bugs or features requests. + +Becoming a maintainer +--------------------- + +Maintainers are volunteers who put themselves forward to keep an eye +on an area of code. They are generally accepted by the community to +have a good understanding of the subsystem and able to make a positive +contribution to the project. + +The process is simple - simply sent a patch to the list that updates +the ``MAINTAINERS`` file. Sometimes this is done as part of a larger +series when a new sub-system is being added to the code base. This can +also be done by a retiring maintainer who nominates their replacement +after discussion with other contributors. + +Once the patch is reviewed and merged the only other step is to make +sure your GPG key is signed. + +.. _maintainer_keys: + +Maintainer GPG Keys +~~~~~~~~~~~~~~~~~~~ + +GPG is used to sign pull requests so they can be identified as really +coming from the maintainer. If your key is not already signed by +members of the QEMU community, you should make arrangements to attend +a `KeySigningParty `__ (for +example at KVM Forum) or make alternative arrangements to have your +key signed by an attendee. Key signing requires meeting another +community member **in person** so please make appropriate +arrangements. diff --git a/docs/devel/submitting-a-pull-request.rst b/docs/devel/submitting-a-pull-request.rst index c9d1e8afd9..a4cd7ebbb6 100644 --- a/docs/devel/submitting-a-pull-request.rst +++ b/docs/devel/submitting-a-pull-request.rst @@ -53,14 +53,10 @@ series) and that "make check" passes before sending out the pull request. As a submaintainer you're one of QEMU's lines of defense against bad code, so double check the details. -**All pull requests must be signed**. If your key is not already signed -by members of the QEMU community, you should make arrangements to attend -a `KeySigningParty `__ (for -example at KVM Forum) or make alternative arrangements to have your key -signed by an attendee. Key signing requires meeting another community -member \*in person\* so please make appropriate arrangements. By -"signed" here we mean that the pullreq email should quote a tag which is -a GPG-signed tag (as created with 'gpg tag -s ...'). +**All pull requests must be signed**. By "signed" here we mean that +the pullreq email should quote a tag which is a GPG-signed tag (as +created with 'gpg tag -s ...'). See :ref:`maintainer_keys` for +details. **Pull requests not for master should say "not for master" and have "PULL SUBSYSTEM whatever" in the subject tag**. If your pull request is From patchwork Wed Oct 12 12:11:50 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: 1689124 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@legolas.ozlabs.org Authentication-Results: legolas.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=nongnu.org (client-ip=209.51.188.17; helo=lists.gnu.org; envelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org; receiver=) Authentication-Results: legolas.ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=linaro.org header.i=@linaro.org header.a=rsa-sha256 header.s=google header.b=rqjXHfQ6; dkim-atps=neutral Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-ECDSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by legolas.ozlabs.org (Postfix) with ESMTPS id 4MnWkJ5JMKz23k5 for ; Wed, 12 Oct 2022 23:12:39 +1100 (AEDT) Received: from localhost ([::1]:45422 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oiabE-0006Ui-TN for incoming@patchwork.ozlabs.org; Wed, 12 Oct 2022 08:12:36 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:43468) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oiaad-0006SN-GK for qemu-devel@nongnu.org; Wed, 12 Oct 2022 08:11:59 -0400 Received: from mail-wr1-x436.google.com ([2a00:1450:4864:20::436]:33356) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1oiaab-0006TP-Jg for qemu-devel@nongnu.org; Wed, 12 Oct 2022 08:11:58 -0400 Received: by mail-wr1-x436.google.com with SMTP id a3so26000781wrt.0 for ; Wed, 12 Oct 2022 05:11:57 -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=ZdaI4XzCxbrqNtaz9+Qc63wwXrtLcrr5DtfukOI3M2E=; b=rqjXHfQ6WaQXh+b956oOSVtHuSZ46wi2wR2gvxTVsWKOz8hWceTQb76956gPF6lN2E GJmDGuhbcKb+XDp+ht5sc5Dcpa/Sue8JyM/uDdtc1eia7hsMfSIYRSLV2K430y8zKoYm +35XtA8QT1S/r94xQUI+MqgxG/3S2dC++MSWGUpsYW8H5W8ijqeJg8BiqUrnXs1S+0pF ezZlCckaZlMmMU+OMeLUyslxJauj5GWCpkQxKUOEHvVvgakMsMoFbfOrYLQrmDpW4l10 yr5KDsJ5sUi/ApFDJXf5hYdLbQ8v0bSkyv+YsqNViBOfqxO5NLmSvPGZjhbMIzB6I5hp y3Mw== 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=ZdaI4XzCxbrqNtaz9+Qc63wwXrtLcrr5DtfukOI3M2E=; b=aYML/q90G429FrOawvbVETSIq9abqUZ00/0xLdwzluUjyHYTRrS6wWH5SKHY2mEbhB w6GHgK14s/7lgahzqU2WM+iGe0xAtWCj92S6jkqtulqHHozW3nv4Y0ffX5wmGwsZSAZ1 /XsqS6MQyJuC54d69R9gHATDqejhFkeLD3YxxmjcYVGkRh0e+3qq51s3W0nn95CzO/iP Fgc1Hun8YRDyOh7gP5rAZkJ3j7TqE4/dqJ3pYd7cXDXAk+w0xJ1WcqwxpQOTfQNDwgT3 VZf8jSxA2IjHCPDgk1FCNO9061ZX0pcQnSqtibmtnxYB3c7IclqYdqDjkb1QraWpyiwp P6tg== X-Gm-Message-State: ACrzQf1bGI9ZSI3UnbY7XkEeLu3s1QFdWIHmUz0q0p3NV1mMiSzgEGG4 QwWoshaPQOSg85O0XMvp6z9emg== X-Google-Smtp-Source: AMsMyM62jCTJ0KanFPRf2XoacB6KpKBi/E1IQQq9F5xgvvhl93jWqTSi+BoA5xNuhTemLkLWyaauPw== X-Received: by 2002:a5d:5148:0:b0:22e:53bd:31c5 with SMTP id u8-20020a5d5148000000b0022e53bd31c5mr17508353wrt.241.1665576716096; Wed, 12 Oct 2022 05:11:56 -0700 (PDT) Received: from zen.linaroharston ([185.81.254.11]) by smtp.gmail.com with ESMTPSA id j37-20020a05600c1c2500b003c6b874a0dfsm2049871wms.14.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 B936E1FFBA; 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 2/4] docs/devel: make language a little less code centric Date: Wed, 12 Oct 2022 13:11:50 +0100 Message-Id: <20221012121152.1179051-3-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::436; envelope-from=alex.bennee@linaro.org; helo=mail-wr1-x436.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+incoming=patchwork.ozlabs.org@nongnu.org Sender: "Qemu-devel" We welcome all sorts of patches. Signed-off-by: Alex Bennée --- docs/devel/submitting-a-patch.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/devel/submitting-a-patch.rst b/docs/devel/submitting-a-patch.rst index fec33ce148..fb1673e974 100644 --- a/docs/devel/submitting-a-patch.rst +++ b/docs/devel/submitting-a-patch.rst @@ -3,11 +3,11 @@ Submitting a Patch ================== -QEMU welcomes contributions of code (either fixing bugs or adding new -functionality). However, we get a lot of patches, and so we have some -guidelines about submitting patches. If you follow these, you'll help -make our task of code review easier and your patch is likely to be -committed faster. +QEMU welcomes contributions to fix bugs, add functionality or improve +the documentation. However, we get a lot of patches, and so we have +some guidelines about submitting patches. If you follow these, you'll +help make our task of code review easier and your patch is likely to +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: 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: 1689125 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@legolas.ozlabs.org Authentication-Results: legolas.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=nongnu.org (client-ip=209.51.188.17; helo=lists.gnu.org; envelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org; receiver=) Authentication-Results: legolas.ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=linaro.org header.i=@linaro.org header.a=rsa-sha256 header.s=google header.b=KIJjR0yw; dkim-atps=neutral Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-ECDSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by legolas.ozlabs.org (Postfix) with ESMTPS id 4MnWkJ4wD4z23k3 for ; Wed, 12 Oct 2022 23:12:39 +1100 (AEDT) Received: from localhost ([::1]:45430 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oiabD-0006W8-Be for incoming@patchwork.ozlabs.org; Wed, 12 Oct 2022 08:12:35 -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-Google-Smtp-Source: AMsMyM6dWhX2GekLGyaJOqOcmRIhmSLLmaJNL3IJkL7xeUQiCK/nvea2qsMsYMoR7hkrkcTgIFwDdA== 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+incoming=patchwork.ozlabs.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 From patchwork Wed Oct 12 12:11:52 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: 1689128 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@legolas.ozlabs.org Authentication-Results: legolas.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=nongnu.org (client-ip=209.51.188.17; helo=lists.gnu.org; envelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org; receiver=) Authentication-Results: legolas.ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=linaro.org header.i=@linaro.org header.a=rsa-sha256 header.s=google header.b=DpgVk8Rv; dkim-atps=neutral Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-ECDSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by legolas.ozlabs.org (Postfix) with ESMTPS id 4MnWsp3pcrz23k1 for ; Wed, 12 Oct 2022 23:19:10 +1100 (AEDT) Received: from localhost ([::1]:47290 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oiahY-0002iy-61 for incoming@patchwork.ozlabs.org; Wed, 12 Oct 2022 08:19:08 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:43474) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oiaaf-0006UP-QG for qemu-devel@nongnu.org; Wed, 12 Oct 2022 08:12:02 -0400 Received: from mail-wr1-x42d.google.com ([2a00:1450:4864:20::42d]:35334) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1oiaae-0006Tz-0r for qemu-devel@nongnu.org; Wed, 12 Oct 2022 08:12:01 -0400 Received: by mail-wr1-x42d.google.com with SMTP id u10so25958753wrq.2 for ; Wed, 12 Oct 2022 05:11:59 -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=DlsvyOz6lGN+SY7b4A4nzZ2KHrnChjwcQ+AUZzWn5OY=; b=DpgVk8RvrdeLB3StjEXzw9opncXA1s/nVQgAXkLYWjDciqo8IlXRNiKCGAmDuMxNRP 05UpOaaYaGxhM2z2CuQuRZOjrYmhjwrXCboAb1pjXF5B5XoUgut8rXXpUiMcnhwQ3fQy juKHEXXmfM7vfJcKN/Rhbi7Mh9fOn04fLbefJeiNsjppxzch7sY70r8AfASO6zDBBpdS lPmanWh6HIwOn2czfzs4vsJywxZtXeRTw5GSeVEEMAL0yyUYOAJIZB3p8bSoN4WTn6gv Vys2hIxePQTgSXAXtF0RZ20UQ5Z6W5jF4qcp4R8AzhMI2UG7w3s1UfUBGklWRYm0IQbv QqLg== 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=DlsvyOz6lGN+SY7b4A4nzZ2KHrnChjwcQ+AUZzWn5OY=; b=XJVAJCkSpDzmCm51st4zDD5f3uExAhmTud/JaV/8AOt4U1x7q56adxdCHFiMOgwgcY Xp706J827FdvLkxbPX/Oz5NYpKEmjT0/o2fKkTH2hL52Bz8j/8UC1qqRqibB5SrlNdZc l5NV3qRXi2jqJ5+4mkyTtTnU1aP0GPH8WJ30AgBn9GPfQ9YhmMQym/GOHddDK7kRSVmG tfK+qkbZW+EKT5X1/IkZGBAHzrJ+KxhGTwyDS7rD2x9trBgyqgPH4NUnis2V4Of6AHy3 euyIxPi9Q0ePLWeIHaUoC5Iy7rYr9l7grApS71LE49JLgqvOEDhg/XDvzd2Uv2Tec688 fHew== X-Gm-Message-State: ACrzQf2odGQhtUSTihwV+1rwy01KsOHaUuCds7kxPErxlc2u67ZyhojJ LrC0yvgLNQRujoaksA/PQFtc5A== X-Google-Smtp-Source: AMsMyM6fLGGR6iSpUumojm5bH/GpgoM0PeULRshVLumr+woqV+YactV5aFJm4Fi7SvrKRFPotLJghA== X-Received: by 2002:a05:6000:68d:b0:22e:4484:cd4b with SMTP id bo13-20020a056000068d00b0022e4484cd4bmr17509833wrb.524.1665576718727; Wed, 12 Oct 2022 05:11:58 -0700 (PDT) Received: from zen.linaroharston ([185.81.254.11]) by smtp.gmail.com with ESMTPSA id l6-20020a05600c1d0600b003a5f3f5883dsm1796374wms.17.2022.10.12.05.11.53 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 12 Oct 2022 05:11:56 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id E61DA1FFBC; 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 4/4] docs/devel: try and improve the language around patch review Date: Wed, 12 Oct 2022 13:11:52 +0100 Message-Id: <20221012121152.1179051-5-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::42d; envelope-from=alex.bennee@linaro.org; helo=mail-wr1-x42d.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+incoming=patchwork.ozlabs.org@nongnu.org Sender: "Qemu-devel" It is important that contributors take the review process seriously and we collaborate in a respectful way while avoiding personal attacks. Try and make this clear in the language. Signed-off-by: Alex Bennée Reviewed-by: Markus Armbruster --- docs/devel/submitting-a-patch.rst | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/devel/submitting-a-patch.rst b/docs/devel/submitting-a-patch.rst index 41771501bf..5b6dc7ddf1 100644 --- a/docs/devel/submitting-a-patch.rst +++ b/docs/devel/submitting-a-patch.rst @@ -434,14 +434,20 @@ developers will identify bugs, or suggest a cleaner approach, or even just point out code style issues or commit message typos. You'll need to respond to these, and then send a second version of your patches with the issues fixed. This takes a little time and effort on your part, but -if you don't do it then your changes will never get into QEMU. It's also -just polite -- it is quite disheartening for a developer to spend time -reviewing your code and suggesting improvements, only to find that -you're not going to do anything further and it was all wasted effort. +if you don't do it then your changes will never get into QEMU. + +Remember that a maintainer is under no obligation to take your +patches. If someone has spent the time reviewing your code and +suggesting improvements and you simply re-post without either +addressing the comment directly or providing additional justification +for the change then it becomes wasted effort. You cannot demand others +merge and then fix up your code after the fact. When replying to comments on your patches **reply to all and not just the sender** -- keeping discussion on the mailing list means everybody -can follow it. +can follow it. Remember the spirit of the :ref:`code_of_conduct` and +keep discussions respectful and collaborative and avoid making +personal comments. .. _pay_attention_to_review_comments: