From patchwork Wed Jun 1 18:05:37 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: 577831 Delivered-To: patch@linaro.org Received: by 2002:a05:7000:8f0c:0:0:0:0 with SMTP id mq12csp864336mab; Wed, 1 Jun 2022 11:37:08 -0700 (PDT) X-Google-Smtp-Source: ABdhPJzfBXfmRPIRQ8NTl7bzIMIJ87n/VWee8UM7lJNVOXepBcdztznyoRIRXqqydIBRPy4THA4/ X-Received: by 2002:a37:6804:0:b0:6a6:49ad:79ca with SMTP id d4-20020a376804000000b006a649ad79camr936128qkc.264.1654108628367; Wed, 01 Jun 2022 11:37:08 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1654108628; cv=none; d=google.com; s=arc-20160816; b=RgF9BQoBaqyLWeVlkzL4C4NdGX9eVeAjwB1RhBzmbrmSSLTkR4tA00o/U0h/hY5c70 y5yacMqjG+8jewEQKGoTejf5idws5ta/WpQHrhKI115BZHvL5RevXUYOcW1UR8tareKf V8cI/2Ziq6cBdByy99wYgbF+pduJ3G3/uh5A6fGiiXBWdvZpeZ7W7/lb6hxQL7e+Q1pB 2X5EuZd2wV3FJk5Vy9iIJsTbFzGsIW/g3BNCRb2E+GEnTZS6vrQhv4zA2GgaHLhWexUy iADSlFnPOJfuTIDrDmhMumr4GZxf+bxxZO2cNBkalnCoW7ESE+/HwGRHOs3R+jFOqFOf vvVA== 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=BGHJqDPZiBsXA4KMwayHRfHrfRJevIHycdJ2aG2O/T8=; b=hKYh/stXY+AYIG2NFQzmbmhOYtCHRq/q0pakbcTDSbTc1gi/W79LEXBoypT4HMyRNf sS71WpbfMTeTm6ssyxYjRHPUeYdZDi3bBoN2Edf+aM3I4GM86+Uj4guQIL00L+b0/4Ah YbU5OU+3sRx/Sa6djEoMBGKbvMcOo1uqSzNKjioOqVVGuCaWqI13YVvIglA9i7VCJltc l7tyJXINBHshbPq7wNToSbkal3h5Sl7miQQsMvh6mCJSXvtueWyh3FQr3M9hYUjdDuWe Uoah8JkW5UHPxFMUwPp9//kwJEGqSLYN3cJTjTNb4I4lnzM0O8M2ZPqxs2t+gv6BIxxc GeGw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=DxZeShGL; 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 h5-20020a05620a400500b006a3718d3f01si1581115qko.490.2022.06.01.11.37.08 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Wed, 01 Jun 2022 11:37:08 -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=DxZeShGL; 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]:45588 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nwTDP-0000xn-1D for patch@linaro.org; Wed, 01 Jun 2022 14:37:07 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:52868) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nwSrF-00027M-FU for qemu-devel@nongnu.org; Wed, 01 Jun 2022 14:14:13 -0400 Received: from mail-ed1-x52b.google.com ([2a00:1450:4864:20::52b]:41749) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nwSrD-0006ah-Ky for qemu-devel@nongnu.org; Wed, 01 Jun 2022 14:14:13 -0400 Received: by mail-ed1-x52b.google.com with SMTP id 25so3038430edw.8 for ; Wed, 01 Jun 2022 11:14:11 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=BGHJqDPZiBsXA4KMwayHRfHrfRJevIHycdJ2aG2O/T8=; b=DxZeShGLnpqpvMerxQeTkKBU9e8VTNADRgKgFW7u6LUFboMr9aR/u1WaLuqMHWJQBw PqJXVTEYw6yIOfuqqPYo/9M9bDdt6m/XReckuS0zsQ21gh96ogiO9fExEL+dRnltNlKj SwWD5N8ZJ1x+NsHv/g8IinIFVEbIZKOnYlLk3Wke32YXOPvWDPNEv12ReiUqCXMS1B2t dt4exus8PPQ5ZZuJXjfBfuGxbgh7iJHwD6pvEQkMCxGu6FG4olVb/holNx/70NUqRMeV jj4Fa4N0GIQsKv+qeA7CpleCaDBQJXq7K+1S4cnYIH4LE0BDIbbBIP0/w/9OrI5TL5Kc CkMg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=BGHJqDPZiBsXA4KMwayHRfHrfRJevIHycdJ2aG2O/T8=; b=ehmaCaALbTP8kl+zGRyaIMG/t6UmUFUHa4HNWek5yHxckjthHUQYTFLyHqo3il7v9n svpQGFIGnLUNA4qV7zgIe/VQN9sgkESNrrhvXrcVVganvWhyhVfpB4gssidGTXje/MuM 6x37D9PHEPaJxGId77JOrUYNnLHSU99tbDyGWhyKVl1pbbRsU8qMj1JjwpsDLV2Yna1Y H6j8RZ+7gnwJZbOlPOVKcKE70zgfsY2+AjuRiutND+Iq9lM3hu8ZBXD+duCtHCrOQRRM 5txct38ot+X7FdvR8dD8WNizm/VZo4Gk1DY69BQ8irhnS/bgWW5zA5oA8rOhhdy3c0HF ObBw== X-Gm-Message-State: AOAM530kJnJT3j+Tinb82DKAG+CDxT5s2EFAOYysoi3SEVBD5/oblQmY jH7Fu7YOqKrXvRP7nxIaVplS+g== X-Received: by 2002:a05:6402:280a:b0:42d:d562:9b01 with SMTP id h10-20020a056402280a00b0042dd5629b01mr1114337ede.290.1654107250339; Wed, 01 Jun 2022 11:14:10 -0700 (PDT) Received: from zen.linaroharston ([51.148.130.216]) by smtp.gmail.com with ESMTPSA id hz22-20020a1709072cf600b006fec4ee28d0sm952343ejc.189.2022.06.01.11.14.02 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 01 Jun 2022 11:14:03 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id E53851FFD8; Wed, 1 Jun 2022 19:05:40 +0100 (BST) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: peter.maydell@linaro.org, richard.henderson@linaro.org Cc: qemu-devel@nongnu.org, =?utf-8?q?Alex_Benn=C3=A9e?= , =?utf-8?q?Daniel_P_?= =?utf-8?q?=2E_Berrang=C3=A9?= Subject: [PULL 33/33] docs/devel: clean-up the CI links in the docs Date: Wed, 1 Jun 2022 19:05:37 +0100 Message-Id: <20220601180537.2329566-34-alex.bennee@linaro.org> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220601180537.2329566-1-alex.bennee@linaro.org> References: <20220601180537.2329566-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::52b; envelope-from=alex.bennee@linaro.org; helo=mail-ed1-x52b.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, T_SCC_BODY_TEXT_LINE=-0.01 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" There where some broken links so fix those up with proper references to the devel docs. I also did a little light copy-editing to reflect the current state and broke up a paragraph to reduce the "wall of text" effect. Signed-off-by: Alex Bennée Reviewed-by: Daniel P. Berrangé Message-Id: <20220527153603.887929-34-alex.bennee@linaro.org> diff --git a/docs/devel/ci-jobs.rst.inc b/docs/devel/ci-jobs.rst.inc index 9118a61a17..1f28fec0d0 100644 --- a/docs/devel/ci-jobs.rst.inc +++ b/docs/devel/ci-jobs.rst.inc @@ -1,3 +1,5 @@ +.. _ci_var: + Custom CI/CD variables ====================== diff --git a/docs/devel/ci.rst b/docs/devel/ci.rst index d106610096..ed88a2010b 100644 --- a/docs/devel/ci.rst +++ b/docs/devel/ci.rst @@ -1,12 +1,13 @@ +.. _ci: + == CI == -QEMU has configurations enabled for a number of different CI services. -The most up to date information about them and their status can be -found at:: - - https://wiki.qemu.org/Testing/CI +Most of QEMU's CI is run on GitLab's infrastructure although a number +of other CI services are used for specialised purposes. The most up to +date information about them and their status can be found on the +`project wiki testing page `_. .. include:: ci-definitions.rst.inc .. include:: ci-jobs.rst.inc diff --git a/docs/devel/submitting-a-patch.rst b/docs/devel/submitting-a-patch.rst index e51259eb9c..d3876ec1b7 100644 --- a/docs/devel/submitting-a-patch.rst +++ b/docs/devel/submitting-a-patch.rst @@ -204,23 +204,25 @@ log`` for these keywords for example usage. Test your patches ~~~~~~~~~~~~~~~~~ -Although QEMU has `continuous integration -services `__ that attempt to test -patches submitted to the list, it still saves everyone time if you have -already tested that your patch compiles and works. Because QEMU is such -a large project, it's okay to use configure arguments to limit what is -built for faster turnaround during your development time; but it is -still wise to also check that your patches work with a full build before -submitting a series, especially if your changes might have an unintended -effect on other areas of the code you don't normally experiment with. -See `Testing `__ for more details on what tests are available. -Also, it is a wise idea to include a testsuite addition as part of your -patches - either to ensure that future changes won't regress your new -feature, or to add a test which exposes the bug that the rest of your -series fixes. Keeping separate commits for the test and the fix allows -reviewers to rebase the test to occur first to prove it catches the -problem, then again to place it last in the series so that bisection -doesn't land on a known-broken state. +Although QEMU uses various :ref:`ci` services that attempt to test +patches submitted to the list, it still saves everyone time if you +have already tested that your patch compiles and works. Because QEMU +is such a large project the default configuration won't create a +testing pipeline on GitLab when a branch is pushed. See the :ref:`CI +variable documentation` for details on how to control the +running of tests; but it is still wise to also check that your patches +work with a full build before submitting a series, especially if your +changes might have an unintended effect on other areas of the code you +don't normally experiment with. See :ref:`testing` for more details on +what tests are available. + +Also, it is a wise idea to include a testsuite addition as part of +your patches - either to ensure that future changes won't regress your +new feature, or to add a test which exposes the bug that the rest of +your series fixes. Keeping separate commits for the test and the fix +allows reviewers to rebase the test to occur first to prove it catches +the problem, then again to place it last in the series so that +bisection doesn't land on a known-broken state. .. _submitting_your_patches: diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst index 5b60a31807..3f6ebd5073 100644 --- a/docs/devel/testing.rst +++ b/docs/devel/testing.rst @@ -1,3 +1,5 @@ +.. _testing: + Testing in QEMU ===============