From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.1 (2015-04-28) on archive.lwn.net X-Spam-Level: X-Spam-Status: No, score=-5.8 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI, RCVD_IN_DNSWL_HI,UNPARSEABLE_RELAY autolearn=ham autolearn_force=no version=3.4.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by archive.lwn.net (Postfix) with ESMTP id 149947D082 for ; Thu, 4 Oct 2018 04:19:24 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726852AbeJDLKm (ORCPT ); Thu, 4 Oct 2018 07:10:42 -0400 Received: from userp2130.oracle.com ([156.151.31.86]:59310 "EHLO userp2130.oracle.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726998AbeJDLKm (ORCPT ); Thu, 4 Oct 2018 07:10:42 -0400 Received: from pps.filterd (userp2130.oracle.com [127.0.0.1]) by userp2130.oracle.com (8.16.0.22/8.16.0.22) with SMTP id w944Ir0m134777; Thu, 4 Oct 2018 04:19:21 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=subject : from : to : cc : date : message-id : in-reply-to : references : mime-version : content-type : content-transfer-encoding; s=corp-2018-07-02; bh=aof8g+q23z29hTD9UcJQoanshpWXccCn/tYlU8uaCVI=; b=TLgSbh0J7DMkGHkuIK9iq+FHZ8g7X07VQuLY/fQkwjnC7INTA57SlMoCJzljQaxGPn+N FL2/up+NbyytE0z8XlC8I5B3pueDUzoSLIrdaplHibdt/8xikU0e8mC+9bptKIb3ee2Q TJIzRnc0IUlYxlZmQPgcELJ9BTtFgAvqMEsQQ5NM+AXnUJjrwGRiNAywNgyWwHcaUYhy wdqxW2cltVgcaiBTB/BkI5xRJbj+UhyCnhvZFWAQttB4fUrEgLX6bDkGZKvT7b16qlkB jPGI9qpunmDjb73zWj5Ua3CweXaOSwl6M2uWk7KwbliPJa8Wav1xydXF8AbGWFcZiavB Tw== Received: from userv0022.oracle.com (userv0022.oracle.com [156.151.31.74]) by userp2130.oracle.com with ESMTP id 2mt0tu1mv3-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Thu, 04 Oct 2018 04:19:21 +0000 Received: from userv0122.oracle.com (userv0122.oracle.com [156.151.31.75]) by userv0022.oracle.com (8.14.4/8.14.4) with ESMTP id w944JGr5030647 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Thu, 4 Oct 2018 04:19:16 GMT Received: from abhmp0019.oracle.com (abhmp0019.oracle.com [141.146.116.25]) by userv0122.oracle.com (8.14.4/8.14.4) with ESMTP id w944JGDm028319; Thu, 4 Oct 2018 04:19:16 GMT Received: from localhost (/10.159.235.87) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Thu, 04 Oct 2018 04:19:15 +0000 Subject: [PATCH 08/22] docs: add XFS testing chapter to the DS&A book From: "Darrick J. Wong" To: darrick.wong@oracle.com Cc: linux-xfs@vger.kernel.org, linux-doc@vger.kernel.org, corbet@lwn.net Date: Wed, 03 Oct 2018 21:19:14 -0700 Message-ID: <153862675482.26427.4160924036723844450.stgit@magnolia> In-Reply-To: <153862669110.26427.16504658853992750743.stgit@magnolia> References: <153862669110.26427.16504658853992750743.stgit@magnolia> User-Agent: StGit/0.17.1-dirty MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 8bit X-Proofpoint-Virus-Version: vendor=nai engine=5900 definitions=9035 signatures=668707 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 suspectscore=1 malwarescore=0 phishscore=0 bulkscore=0 spamscore=0 mlxscore=0 mlxlogscore=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1807170000 definitions=main-1810040044 Sender: linux-doc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org From: Darrick J. Wong Signed-off-by: Darrick J. Wong --- .../filesystems/xfs-data-structures/overview.rst | 1 + .../filesystems/xfs-data-structures/testing.rst | 25 ++++++++++++++++++++ 2 files changed, 26 insertions(+) create mode 100644 Documentation/filesystems/xfs-data-structures/testing.rst diff --git a/Documentation/filesystems/xfs-data-structures/overview.rst b/Documentation/filesystems/xfs-data-structures/overview.rst index 23eb71d65c93..d6711dc653d8 100644 --- a/Documentation/filesystems/xfs-data-structures/overview.rst +++ b/Documentation/filesystems/xfs-data-structures/overview.rst @@ -49,3 +49,4 @@ latency. .. include:: reconstruction.rst .. include:: common_types.rst .. include:: magic.rst +.. include:: testing.rst diff --git a/Documentation/filesystems/xfs-data-structures/testing.rst b/Documentation/filesystems/xfs-data-structures/testing.rst new file mode 100644 index 000000000000..3d3386854408 --- /dev/null +++ b/Documentation/filesystems/xfs-data-structures/testing.rst @@ -0,0 +1,25 @@ +.. SPDX-License-Identifier: CC-BY-SA-4.0 + +Testing Filesystem Changes +-------------------------- + +People put a lot of trust in filesystems to preserve their data in a reliable +fashion. To that end, it is very important that users and developers have +access to a suite of regression tests that can be used to prove correct +operation of any given filesystem code, or to analyze failures to fix problems +found in the code. The XFS regression test suite, xfstests, is hosted at +``git://git.kernel.org/pub/scm/fs/xfs/xfstests-dev.git``. Most tests apply to +filesystems in general, but the suite also contains tests for features +specific to each filesystem. + +When fixing bugs, it is important to provide a testcase exposing the bug so +that the developers can avoid a future re-occurrence of the regression. +Furthermore, if you’re developing a new user-visible feature for XFS, please +help the rest of the development community to sustain and maintain the whole +codebase by providing generous test coverage to check its behavior. + +When altering, adding, or removing an on-disk data structure, please remember +to update both the in-kernel structure size checks in xfs\_ondisk.h and to +ensure that your changes are reflected in xfstest xfs/122. These regression +tests enable us to detect compiler bugs, alignment problems, and anything else +that might result in the creation of incompatible filesystem images.