From patchwork Tue Jun 26 00:08:17 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Petr Machata X-Patchwork-Id: 10487591 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 44713602D8 for ; Tue, 26 Jun 2018 00:09:10 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 1848727FB0 for ; Tue, 26 Jun 2018 00:09:10 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 0A99A27FE4; Tue, 26 Jun 2018 00:09:10 +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=-7.8 required=2.0 tests=BAYES_00,DKIM_SIGNED, MAILING_LIST_MULTI, RCVD_IN_DNSWL_HI, T_DKIM_INVALID 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 94F3727FB0 for ; Tue, 26 Jun 2018 00:09:09 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S934844AbeFZAJI (ORCPT ); Mon, 25 Jun 2018 20:09:08 -0400 Received: from mail-eopbgr60045.outbound.protection.outlook.com ([40.107.6.45]:24992 "EHLO EUR04-DB3-obe.outbound.protection.outlook.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S934074AbeFZAJF (ORCPT ); Mon, 25 Jun 2018 20:09:05 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=Mellanox.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=/TTJjRW9qSQt5NUkckkiigI5fdIAyXS+jBe21EGW+w8=; b=fC1LwpUIqQKcyKWgmeDyUD6eQiu6dfWwOJ/pSaZ3xOIqekfj6JJ1iMw9Yg66nmGDIBgvifu76EXafSrBq7QtZArrCeKaGop8WAdozC9oReOle+GfAJbMffeS/Qb33KSXCeoP/wHdeRXXPMOZubmWYxpH8CFjPjkos3zRShBi+Lo= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=petrm@mellanox.com; Received: from t540p (89.176.83.59) by VI1PR05MB4191.eurprd05.prod.outlook.com (2603:10a6:803:4e::17) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.884.23; Tue, 26 Jun 2018 00:09:02 +0000 From: Petr Machata To: netdev@vger.kernel.org, linux-kselftest@vger.kernel.org Cc: davem@davemloft.net, shuah@kernel.org Subject: [PATCH net-next 6/6] selftests: forwarding: README: Require diagrams In-Reply-To: References: Message-Id: <4faf4eff999bf82421662f695be398579d0e572f.1529971148.git.petrm@mellanox.com> Date: Tue, 26 Jun 2018 02:08:17 +0200 User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.3 (gnu/linux) MIME-Version: 1.0 X-Originating-IP: [89.176.83.59] X-ClientProxiedBy: LNXP265CA0053.GBRP265.PROD.OUTLOOK.COM (2603:10a6:600:5d::17) To VI1PR05MB4191.eurprd05.prod.outlook.com (2603:10a6:803:4e::17) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: bb358adc-78eb-48ad-6bcc-08d5daf9063d X-MS-Office365-Filtering-HT: Tenant X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(7020095)(4652020)(8989117)(4534165)(4627221)(201703031133081)(201702281549075)(8990107)(5600026)(711020)(48565401081)(2017052603328)(7153060)(7193020); SRVR:VI1PR05MB4191; X-Microsoft-Exchange-Diagnostics: 1; VI1PR05MB4191; 3:099aPYAzLd3BO4L3fzm7xYiubrTQdI7wtH7fvwZQWY+dYNJwsYfXNZWegGn6tLNnbqOcTODKys4a+CS8s4SQ+Kiz2wg3pJDWNECPvJY0HYr6iLdvQAl2dvTmSJp0bg5XjIaxkwnsTOw1NZg8Jv1c4IUt+Oqz2h2jH+x1e6UB7mxBS1TJOhf1qJ9P35QPinqA9vzIqcJgNPnosEjRuFCD1b9GdHkBE/UwI/LdzSyVk2s+ICWMBgXOEGFCdiOtjegX; 25:FtXaIQ7gK3WsrpLllRZQXHyfXI9Kk7bR//NPrh6X//OlJv2WfaHjiSY+SpFMRJ87ARwWNn8mnttmyIhIr+1k8dTJbdkCq4DYIQzNnYwctSXPJHprqkJFz34EuBvg+jQBBIUFPIzGuBzQkBn3pET1Ztvz+zDrhPGBS8v0r6SMqCTwavuC6EmlbdN+QM/clNxRuClFPhMChu1HAkO4VGyCFSB0l7EqSJmcBCPD6KQVSSbqmYmdfTc3qeW031hdYyspafCv9jVTTjWi3DhgVzTWSNfopO/0pfAuU+c2eWHP9pkX2eF85XjlfxAcLNelVrFC95Xcp7p0qsFCG16gp8FT+w==; 31:pOS+831Pu/U+k2xzdiiQhUxS97nyPW4I59zV/gSUkaQoXpBtLLAgSGsKvJ+9siL9CuOpfC03offpnCYK+3Tu6pl9k4lLMfi86Qc669G/jdrNZylPXFrWw+8V1gNklUo4yb8//8ZZSUIWZmhxjV+mLleV6My8NlD1uutD5hVqDq9BwFiUKBOU0b1oIT8fApLE6uQDKMASCLl2+oFYqXsvBG2w1SOD/4pm8c87wBUSddQ= X-MS-TrafficTypeDiagnostic: VI1PR05MB4191: X-Microsoft-Exchange-Diagnostics: 1; VI1PR05MB4191; 20:MRMiQ9+PZhNk957BPs7sLD1Cc+Qbo7GlfutovWREt/jPOY9TBwTUDYMMTpbjZiQVAID5D3wJ34QTuNH2sEbu4Hkcc4F7Xq1kM3F69Jt5k+DOhE8LQz3yArU5T07mF9qC8hzSzQPpYim3vIJf6XyfI9FchzSkVLt9KM6PFApHM6I9a4yYVYiU99f8rSJQ+xIIHYojRgH8MyHnCiDp9ja9BxxxWiTN+raHaDXtFtBNs+Hk+81T30EBKQt8890Jn0Ze915tQYHn3VmJfijMw8LgT2a0w5s761Sh8RGBT6OxNSGOWGOPBsCvPwWHK+FNaMtCoioH865sjRLieCaeHEokuTsOE6275AiPwRl84nu3xNKfAUJDuheT2PEAv8ZSiuCHTYwxJ6dUi7xs8EtQUn4wXf2HIk5ENB7OjIBv4dZSs9I/iw5d0mS4u9BGuSkbDiM7oHEMHuwMLv17eJSlwxysi7JjJFJl+SY4tWvMAT7uOIRzq3Lypi79vgvHZId6whzu; 4:hnbQIjy52wra6/RBIcWxcLs1zpCkb8LFyO1A+cy+VnTnRqbieDR7DjM6ReuP5IH9fUylJy3T6TL4VhygQA1OuY/undTSyn2FjekzmBRQB5QO09u5U7GhgykbfhJDk4gQ+UK7Pk7XeHkbfQvebB74YS3gacP1DrhGEcGHqwHGIC09ueDWNHh64zn3tNnSx0LojQcC2pMn3h3Yhqzh3g9nW2qz/h/fpew540o88C7BSjXnJcLJUBlJGY3AZtzpV0zSqtHtvdIHcH3ZjeNtt6jYpw== X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:; X-MS-Exchange-SenderADCheck: 1 X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(8211001083)(6040522)(2401047)(8121501046)(5005006)(10201501046)(3002001)(93006095)(93001095)(3231254)(944501410)(52105095)(6055026)(149027)(150027)(6041310)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123564045)(20161123560045)(20161123558120)(20161123562045)(6072148)(201708071742011)(7699016); SRVR:VI1PR05MB4191; BCL:0; PCL:0; RULEID:; SRVR:VI1PR05MB4191; X-Forefront-PRVS: 071518EF63 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(346002)(39860400002)(396003)(376002)(366004)(136003)(189003)(199004)(446003)(6666003)(86362001)(26005)(186003)(5660300001)(97736004)(11346002)(16526019)(486006)(50466002)(36756003)(386003)(76176011)(2616005)(476003)(48376002)(956004)(2906002)(6496006)(52116002)(16586007)(316002)(6116002)(3846002)(118296001)(47776003)(6486002)(66066001)(68736007)(53936002)(106356001)(305945005)(7736002)(8936002)(51416003)(8676002)(4326008)(81166006)(81156014)(105586002)(58126008)(25786009)(478600001); DIR:OUT; SFP:1101; SCL:1; SRVR:VI1PR05MB4191; H:t540p; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; MX:1; A:1; Received-SPF: None (protection.outlook.com: mellanox.com does not designate permitted sender hosts) X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; VI1PR05MB4191; 23:lkpgyRXKwZcMr408nVMhfUG7oSsxbf+qetc+4W9l2?= =?us-ascii?Q?0LFXcAvAsYBqrO8LIwVPCtuNBEWxiBwPqnXRSf5OdP6PZsEVOvFkBVqcf2Qe?= =?us-ascii?Q?/I7Gd9PpIlg8HmgB9rll5S2X2Idishma6Wko5buzg1Rv6BQtp2CkHS0FIwJr?= =?us-ascii?Q?UiF8rUiyc1IQ2CIRQ0bMff5xHd9cVgNoxD6mSWDgSQX9sdzELWv+QDDffjVA?= =?us-ascii?Q?ytQ7Nw+SYKCXrfubzcDGOFUN3tvH5Qwmm6ut6ZbFS20W3a8DnckHMeDBW4ub?= =?us-ascii?Q?y8A1tV5oLikW0hZg3dLNB3PkIb+RN/vkP2A3HuTvueqy8MWAnLnqgHhZUJfO?= =?us-ascii?Q?dg7E9k2iXOrtIZ68ZQQc+NJQnerUlhxYAEZ3meTZPpa4zLTfUjikQ/77Hmnn?= =?us-ascii?Q?oCzS53M8KMVSiU+IATk5FjUJfbPt53wlXWrqcKM0Ln+oIh6tp8HNujdG+lhi?= =?us-ascii?Q?JcqkjlU97bASTQwHokZlacftm7o+a5ZA6ydcF1n2/aD1NtNSr3atBDGNsbTs?= =?us-ascii?Q?HR+wI0LmsogIpO3k7aym3kHp3gri4rvc8ILC79uEYfSWI8FO/my0E0g6z/0J?= =?us-ascii?Q?7RBOft7qqO1VgmwSncwguPYQN7cgOqQln8ZnM3YLi6AKLwEI2VlTNT1mvEsu?= =?us-ascii?Q?X0Q+ZR7ylKCWPahcr7zBuYkYksSwNS7tINpDAL6KoI2jcaylbghXy9nXtDN9?= =?us-ascii?Q?dtBpdOsVEj15RcAtyEQXDdn4ZNnm4RPfYoau73aIpghAKU16RLepqHKg3KhU?= =?us-ascii?Q?ODSbCvJQqBYk7/ldSP32E4JFydavjRkZan4YEPKDKPIBZ5V4oRFvWZlhZWLk?= =?us-ascii?Q?K6qghWvW8nLaOGlEIjStO3d0SZu0EdDSQzle9mjXf0GDyb5D2H31Sq2RaV7N?= =?us-ascii?Q?dm0P8We2ut+S/z/jeL2fR+ymT0MrhH5Zl1gXJgyb8r1HB60BlAA2+8iuetn6?= =?us-ascii?Q?7dxMlJXw2G84wcw4Ce/LCf9T0TmZ/Ble8ObGjn+JyKXsxqA1Uzotc1Ioax66?= =?us-ascii?Q?qGwDf+URQp+i7B3/Zfhr9Y43MvzyARsLHzEGJAytwLLbKfFehtKkpzkSegR8?= =?us-ascii?Q?eQP/wnXDIyVvFMh6Wai1699zP52HUtStTsI5w2TTDz1eFb89JR0+2qI1ghqs?= =?us-ascii?Q?vUE/EeaGHJzkOQAQGY2aQxs0f7/Jsxa?= X-Microsoft-Antispam-Message-Info: 6xDmb387azbvPl3CxrKyDxCiyjohOgwhh91Cl5fFa72MtjEDl/URDIBiXUHVkRBTJuQSnwKxR8FL5D0vaSikPEGkWMvxmnhpmpFwaWbsbcePgSpWljIajK1jL2QuYHBMBMqGRWCdQ9x4nTFSUVbbFcoOAITCIF5tS1tII7uMqp+ixsO5haYRXo19GwuIEkoHXlf3kE9ND12YQhylLZ47aL68RXnkEKS81odkNnC8Ife1MHVsFTRRq5Ttym+dV8jOjaQIGmE++qR25vjpwASxZ40rcQjiACFLkyr3Y+B78eWPl1CbX8zusQeGoRko2gjkxN95wA5ODoYm2i2JW9/EE4JZVgYGG6nNLJLkYXi2Zno= X-Microsoft-Exchange-Diagnostics: 1; VI1PR05MB4191; 6:LMM4Wc/cSE3OOX2iRfqvKafrLDCFtiazZvpMML1zS+nfU59CsgYUjNcWVlBrUC1Ob0B3x0bA6sdzqlEdC0IvFIToYhEV2PbZmf7VbmQHjir1SoaFKrpyxzbagVHXQwEO/9p1XRMwt4NKkwTmRbR3BWbXI8fZC76glmtot+mSthnInJX4bTSz44BY9oZndIlM6dT4BZMSf2nMlcpaSo2nM8z73KrknxGCPK+OGLg6/xPWh0SAGkS3UlEFApHD3DUeGf/frfa7WyThU/41tG+G/2/3duFrx/IMcv7VYAAWGkFwWJXI97ImiWXjFqzMehHbwJMwjwYwm0VcGVq2hafriLZ6dh2YqMfDY/7TyUTNvJ1HoX0LMRWR6VVi0sVxDbsWCIWT37+YBFgiiq5YAg5CUUzqU0QFSqUR5x+bC+R5gcNleEnBQWYbdT7nmbOLyO1khi0wh5uVW4w8jbW8XefMIA==; 5:J5bId00iTFULmwkjmRPy49hl9nKjmWRzkruJciWEFUs2KNokmku9DHJeAcbHxHqflpyNvsD/g0rpRU/aoPg6Qq+N35VsxjtzRRP2v/Ilw7vF5tbWmP+8kboMYh8QpCoaEUI0VRFbcyV3P9zZFUiwWTob1tGdR5tB37N/YQf3Tqc=; 24:37KCqFwZuuATiIoiHFz1bR+15PaWprenhMcN7FWcY/ASMOOTPhG0ublC+P/aSO295/zHXg4lbFePx+hn+zJV/afEtkqij56tTemhrIQbv70= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; VI1PR05MB4191; 7:eIq55yuwpz5r6M86z3cLt6GGchckiRG2T4gSPUyMrwp0sw9XngPARovw6mVi4NXOrVkv9jSRudUgg4z/G/ZXFp6Kc2oSIOIPk+wC07XrhN4jmCvKuGm9ZddNspXZdxH7ARobo0e/+G/Nq0hSLwCL4w5ye37AdvbvX6S1tU3Ymzb96UhLuMZoK7Zgya2qUfV4lO9Cqrfpe4K2eu50mEFiqJ3s6DaiaFaGT+o1AYz8GdyLWCri7miWcTWpL6iy26LF X-OriginatorOrg: Mellanox.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 26 Jun 2018 00:09:02.4974 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: bb358adc-78eb-48ad-6bcc-08d5daf9063d X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: a652971c-7d2e-4d9b-a6a4-d149256f461b X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR05MB4191 Sender: linux-kselftest-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kselftest@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP ASCII art diagrams are well suited for presenting the topology that a test uses while being easy to embed directly in the test file iteslf. They make the information very easy to grasp even for simple topologies, and for more complex ones they are almost essential, as figuring out the interconnects from the script itself proves to be difficult. Therefore state the requirement for topology ASCII art in README. Signed-off-by: Petr Machata Reviewed-by: Ido Schimmel --- tools/testing/selftests/net/forwarding/README | 2 ++ 1 file changed, 2 insertions(+) diff --git a/tools/testing/selftests/net/forwarding/README b/tools/testing/selftests/net/forwarding/README index 4a0964c42860..b8a2af8fcfb7 100644 --- a/tools/testing/selftests/net/forwarding/README +++ b/tools/testing/selftests/net/forwarding/README @@ -46,6 +46,8 @@ Guidelines for Writing Tests o Where possible, reuse an existing topology for different tests instead of recreating the same topology. +o Tests that use anything but the most trivial topologies should include + an ASCII art showing the topology. o Where possible, IPv6 and IPv4 addresses shall conform to RFC 3849 and RFC 5737, respectively. o Where possible, tests shall be written so that they can be reused by