From patchwork Wed Oct 3 16:25:59 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Matthew DeVore X-Patchwork-Id: 10625071 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 1D4AE14BD for ; Wed, 3 Oct 2018 16:26:27 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 10EC328F37 for ; Wed, 3 Oct 2018 16:26:27 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 03F2328F4A; Wed, 3 Oct 2018 16:26:27 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.5 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI, USER_IN_DEF_DKIM_WL autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 743AC28F37 for ; Wed, 3 Oct 2018 16:26:26 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727251AbeJCXPa (ORCPT ); Wed, 3 Oct 2018 19:15:30 -0400 Received: from mail-it1-f202.google.com ([209.85.166.202]:52612 "EHLO mail-it1-f202.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726811AbeJCXPa (ORCPT ); Wed, 3 Oct 2018 19:15:30 -0400 Received: by mail-it1-f202.google.com with SMTP id e9-v6so7623589itf.2 for ; Wed, 03 Oct 2018 09:26:24 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20161025; h=date:in-reply-to:message-id:mime-version:references:subject:from:to :cc; bh=rV4wWJ305XRANArpdyUjd2wCKftpX5xdjpdSTQOJncU=; b=sjhHmNEiwBRkocCQU5kCiDyQhtxhuxTqkEvsKQUiIu7a8MzOKx/tqYLySONtB/nTIW WdY8SO963vQYRIJ0RidjI9WzWCdbsKj51pt0BXRdJIn2/OJ+mK3Dhk5oUuDXQ8Pv/vBz mdzzgT+L35PgYPZP1mdFLvkCEVEnnUhXJfckOHbgSyRjX7HbujIH8BhD+xzS/oP2H4PM m93xadStyq4k2HYMmSwKu7GND8ZbT8N/nXCl9E+ceEgwitoXpL7IGrbeKnsYEUKbyTJp H5vAuXma+Qqq+miPQhtDj5tnI1zRjIYMcZzTY4O1Mmifb6o5DX5ulDeTbAagUQ7fS3Gi 4+6A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:in-reply-to:message-id:mime-version :references:subject:from:to:cc; bh=rV4wWJ305XRANArpdyUjd2wCKftpX5xdjpdSTQOJncU=; b=n43BOiYpjZEovvQZy61EU4R7xP3x5Mdhk1lyJjg/5fdrUgq3RaJFFMmYVQj6W60RfO VPyZeROPsmC4xmzhDuFN/1YTV3E98yKJFeqn6/neoMN7PYHY+Cjny9lR0T0RuaE8/Elh wcxeefBGd/H8dB4YNoAnUPPmsd9dvNiShFRCGcqUDaX6SjVOlgHc6xZ/dvcKOYvtoTWI iX7KU/lYPqPY1dOiWziKThiUN82fu/R3K+/zC79oEuQwUdNB5qkVLo4fx6VXsQsuXMQI 8feXs/g+IHQdiKjU0AssUUWEbUmTQ3utyOC6gb947jOT5Pn1nn22EE1NsAavrepay4Rf ODGg== X-Gm-Message-State: ABuFfoj1JSFxuGxvWxSyndLewL/0nU91RUmQhv+vogh/OzOaSL3yl+W/ fPwQUIb+kNNJq0aL1xMFGtTka1ta7LTkZAK3RbCQCjfPrkFyRltpdNEUdxw4oNYkNWiMyfa+z1H Oo1Kirer03GSKploOiNWJv5GxIqW149xJaMTlRbFuTzX5PmMnjsHzQ5KwYf0= X-Google-Smtp-Source: ACcGV62VKkQX6BFUFBgVSTaOe1hvrCaSmU4o1kK3+UMuwctOAUiG8oyP7/UIdIQ3CZX0IIP90LbkLL1JX5pf X-Received: by 2002:a24:2752:: with SMTP id g79-v6mr1837204ita.4.1538583983922; Wed, 03 Oct 2018 09:26:23 -0700 (PDT) Date: Wed, 3 Oct 2018 09:25:59 -0700 In-Reply-To: Message-Id: <32f6f14f8d3323468b4255927cca028a82f64b39.1538581868.git.matvore@google.com> Mime-Version: 1.0 References: X-Mailer: git-send-email 2.19.0.605.g01d371f741-goog Subject: [PATCH v4 1/7] t/README: reformat Do, Don't, Keep in mind lists From: Matthew DeVore To: git@vger.kernel.org Cc: Matthew DeVore , peff@peff.net, jonathantanmy@google.com, gitster@pobox.com, jrn@google.com, sunshine@sunshineco.com, szeder.dev@gmail.com Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP The list of Don'ts for test writing has grown large such that it is hard to see at a glance which section an item is in. In other words, if I ignore a little bit of surrounding context, the "don'ts" look like "do's." To make the list more readable, prefix "Don't" in front of every first sentence in the items. Also, the "Keep in mind" list is out of place and awkward, because it was a very short "list" beneath two very long ones, and it seemed easy to miss under the list of "don'ts," and it only had one item. So move this item to the list of "do's" and phrase as "Remember..." Signed-off-by: Matthew DeVore --- t/README | 40 +++++++++++++++++++--------------------- 1 file changed, 19 insertions(+), 21 deletions(-) diff --git a/t/README b/t/README index 9028b47d9..85024aba6 100644 --- a/t/README +++ b/t/README @@ -393,13 +393,13 @@ This test harness library does the following things: consistently when command line arguments --verbose (or -v), --debug (or -d), and --immediate (or -i) is given. -Do's, don'ts & things to keep in mind +Do's & don'ts ------------------------------------- Here are a few examples of things you probably should and shouldn't do when writing tests. -Do: +Here are the "do's:" - Put all code inside test_expect_success and other assertions. @@ -444,16 +444,21 @@ Do: Windows, where the shell (MSYS bash) mangles absolute path names. For details, see the commit message of 4114156ae9. -Don't: + - Remember that inside the