From patchwork Fri May 27 15:36:03 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: 576502 Delivered-To: patch@linaro.org Received: by 2002:a05:7000:8607:0:0:0:0 with SMTP id bb7csp779299mab; Fri, 27 May 2022 09:18:02 -0700 (PDT) X-Google-Smtp-Source: ABdhPJwcJ+q+dqXowpNkAw1Rt8qeMmpUStakN/1fiqdLTOdAX3O8IjG3yXcTMInNXImOy/usyWF5 X-Received: by 2002:a37:6141:0:b0:6a3:4c9c:ed69 with SMTP id v62-20020a376141000000b006a34c9ced69mr23942093qkb.755.1653668282266; Fri, 27 May 2022 09:18:02 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1653668282; cv=none; d=google.com; s=arc-20160816; b=jV+8TbAE1CeKlbihSgkW/Ld0U+9xerLMA3RrI5/dDqgJZs4RmRrLfk28TgxBiS4RCp bq98zS2f00UG6Pt18lNHYV2OR+DAK/UwfUtjakwkRmSpKhDsnUMPMI3g0HjbTMCXH62j 2cRy28j+c575A/QXk52Sb+JoNHfyNZkp1o+YA+Z9iSevpCtjHezx/fO1Ij4V9kGnRz2o 2Lw07oOSJFWN+JOmKvo2FfORbeBJId8s3k9HWIoahvqhZMqrPxXgJu7YGDByU2bOFVQw 0K/ZvQ3uz8CfL3aUSsQPi7Jres9xzTzUm3BS9HywIXZfKLCA+bZ7B/+z4knNpTxly6Zn mHwQ== 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=dowmkd6o4OYW0pvXlQuxuJkXABZKayFcBX57LMSByIc=; b=iC3V/htIqJfoRhwTWBzkPfGzhubx/eqSrbyf9hYp9zKVrLbJ3NihH65TSFM7Wdsaee ilTMW/+r30ATAgAf6kMbV9U0D2KgKSIFOFQkL82xhyqRvCxjWJGiiCyzct+51pPQC67O jYWrqVwQ2D1OlOdFAx31sZNwXjhCkHAn3Wu6232JS/ykUdBhkI05w7xbSRngB5MdAiQU 1GM+0mcdyVw6A7FW+OzKNef31ac05OKpXOS0wil6VKgKGeY9IM3WRD/VKwYM28/+0nBT F7EXZBivJXxNWLIRoZCQBNGKRyYWkMT51fsq7VlVaTIl56mx4ltwHG5MKDFpX+r/JGCB pCig== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b="wlFfXH4/"; 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 h67-20020a37b746000000b006a03e39acc6si2788691qkf.629.2022.05.27.09.18.02 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Fri, 27 May 2022 09:18:02 -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="wlFfXH4/"; 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]:35762 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nucf3-0000Ui-Q3 for patch@linaro.org; Fri, 27 May 2022 12:18:01 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:39978) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nuc8Q-0003AK-20 for qemu-devel@nongnu.org; Fri, 27 May 2022 11:44:18 -0400 Received: from mail-wr1-x432.google.com ([2a00:1450:4864:20::432]:42677) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nuc8N-0003t2-Uf for qemu-devel@nongnu.org; Fri, 27 May 2022 11:44:17 -0400 Received: by mail-wr1-x432.google.com with SMTP id t13so6356819wrg.9 for ; Fri, 27 May 2022 08:44:15 -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=dowmkd6o4OYW0pvXlQuxuJkXABZKayFcBX57LMSByIc=; b=wlFfXH4/pThehDcgoXW1x/lM/LDvTlvF3CRPj5etyxl1XWfBwOPF2Ym9S/c+6odN0n 5VLtCeE+fIEgxg5+c3EieJ1HKLffSXSfN4MSefPQ/P2NnxW1SvUSvtAv8tIMQhZXpwIS jb663iOSVVyVXLTwUKnmAM8kOfhInPRwj4Btu+09FC+1Wekm+OBp8nINSoVh97aXYwFM 4IuKkC5IRsWRoWytqiao6ErMT9GRYzw8LhmhOdbBlInKIcJNEN81CAOlhb6qoyRKO/YH gityS2x3eFQFjAwkqbU8xNx88EJvGMkPr9PklXCPdO3Y7X9ObMhkkRyIEcEM/VHAX93I 8p0w== 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=dowmkd6o4OYW0pvXlQuxuJkXABZKayFcBX57LMSByIc=; b=8BjfyafcqUxtizzkJZvVlOGtxwNREV8hi3Q7FFxbIDICSX2ylmA4HqACMhl5KCN905 //jIM7wQGT+6RcWaIPM5j7IX3iloLJKT8Rf6NJdXZSs7u0XyY8xB8r3nYY1Pajqlzaic wLc7gn8NqnC2gBijpNQQqOJeGt0QTD2HFSKhSRxJHpRxuq5FYzmzwj/itPBdRTdHlW+Q w3MNZ/qGr+oQabDYxmgdM4wzQyR6U7/zvJZt2IZevK9LiF/80D4Q4LvDeLPOcxU8T+D/ dmkMT5cHhbgPMG3tXmYISF/0PbXut1QFNyKFu3CF4C80wVx/gD49sL/pYC762Nr5aXJO OAEg== X-Gm-Message-State: AOAM531/JW9QylRE2H8RL19n2YLtcDBTnchZUDsM8LlOFr6PJTlo3l7w xZSCavWwJ6hn3AGOIYtHxRJDDg== X-Received: by 2002:a5d:6782:0:b0:20f:dd3a:3edf with SMTP id v2-20020a5d6782000000b0020fdd3a3edfmr22159638wru.517.1653666254563; Fri, 27 May 2022 08:44:14 -0700 (PDT) Received: from zen.linaroharston ([51.148.130.216]) by smtp.gmail.com with ESMTPSA id 10-20020a056000154a00b0020ff4b8efc6sm2088537wry.80.2022.05.27.08.44.02 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 27 May 2022 08:44:06 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id D4EB41FFD8; Fri, 27 May 2022 16:36:06 +0100 (BST) 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 v1 33/33] docs/devel: clean-up the CI links in the docs Date: Fri, 27 May 2022 16:36:03 +0100 Message-Id: <20220527153603.887929-34-alex.bennee@linaro.org> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220527153603.887929-1-alex.bennee@linaro.org> References: <20220527153603.887929-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::432; envelope-from=alex.bennee@linaro.org; helo=mail-wr1-x432.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 --- docs/devel/ci-jobs.rst.inc | 2 ++ docs/devel/ci.rst | 11 +++++----- docs/devel/submitting-a-patch.rst | 36 ++++++++++++++++--------------- docs/devel/testing.rst | 2 ++ 4 files changed, 29 insertions(+), 22 deletions(-) diff --git a/docs/devel/ci-jobs.rst.inc b/docs/devel/ci-jobs.rst.inc index 13d448b54d..6d88449250 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..8f4a28fbdf 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 ===============