From patchwork Sat Dec 17 22:23:38 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Finucane X-Patchwork-Id: 706727 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from mail.linuxfoundation.org (mail.linuxfoundation.org [140.211.169.12]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 3th1tV4jGYz9vFF for ; Sun, 18 Dec 2016 09:24:01 +1100 (AEDT) Authentication-Results: ozlabs.org; dkim=fail reason="key not found in DNS" (0-bit key; unprotected) header.d=that.guru header.i=@that.guru header.b="J1qicWje"; dkim-atps=neutral Received: from mail.linux-foundation.org (localhost [127.0.0.1]) by mail.linuxfoundation.org (Postfix) with ESMTP id 8FFB9596; Sat, 17 Dec 2016 22:23:57 +0000 (UTC) X-Original-To: dev@openvswitch.org Delivered-To: ovs-dev@mail.linuxfoundation.org Received: from smtp1.linuxfoundation.org (smtp1.linux-foundation.org [172.17.192.35]) by mail.linuxfoundation.org (Postfix) with ESMTPS id 220A69C for ; Sat, 17 Dec 2016 22:23:56 +0000 (UTC) X-Greylist: from auto-whitelisted by SQLgrey-1.7.6 Received: from caracal.maple.relay.mailchannels.net (caracal.maple.relay.mailchannels.net [23.83.214.30]) by smtp1.linuxfoundation.org (Postfix) with ESMTPS id A0EAF185 for ; Sat, 17 Dec 2016 22:23:55 +0000 (UTC) X-Sender-Id: mxroute|x-authuser|stephen@that.guru Received: from relay.mailchannels.net (localhost [127.0.0.1]) by relay.mailchannels.net (Postfix) with ESMTP id C71F3A0E3E for ; Sat, 17 Dec 2016 22:23:54 +0000 (UTC) Received: from one.mxroute.com (ip-10-220-3-24.us-west-2.compute.internal [10.220.3.24]) by relay.mailchannels.net (Postfix) with ESMTPA id 30269A0BF8 for ; Sat, 17 Dec 2016 22:23:54 +0000 (UTC) X-Sender-Id: mxroute|x-authuser|stephen@that.guru Received: from one.mxroute.com ([UNAVAILABLE]. [10.25.23.62]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384) by 0.0.0.0:2500 (trex/5.7.8); Sat, 17 Dec 2016 22:23:54 +0000 X-MC-Relay: Neutral X-MailChannels-SenderId: mxroute|x-authuser|stephen@that.guru X-MailChannels-Auth-Id: mxroute X-MC-Loop-Signature: 1482013434395:612115020 X-MC-Ingress-Time: 1482013434395 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=that.guru; s=default; h=References:In-Reply-To:Message-Id:Date:Subject:Cc:To:From: Sender:Reply-To:MIME-Version:Content-Type:Content-Transfer-Encoding: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=4RHW5mMCoCI2R4k8wjp+dUxlTNBZAQHzAFhlkbcaIu4=; b=J1qicWje5rWXL59I4Wa7NpZeSW ftUDbLGUZPiJ6ivkS24DGHcT9KR2FyQGj9/BNKa5gk8kU8YvVmLzhDxdY3VTcGAY1pCqWfvtL4Usx ky6pQLqa3zyx2+OkjFpYec5Qr7b+2t3McqWDD9k2Dm5/ubPu/7LvkXXxIKvk25SoGIymQXNvwOMJ4 5uwhzIABdrwDAzHyLp8GotDrgrv9gKkIXDozEz1uxUtdXEHAdxURnwQrMo3e0aXQhr4vxxcoOvjNo xoETL4q8hkie2JD62sd4BHVQ0faXWaPy4RNTPvWmjvRLYbcy41BFCAJYvkVuD8EmGMdstmHZqa9hT u12Evc8A==; From: Stephen Finucane To: dev@openvswitch.org Date: Sat, 17 Dec 2016 22:23:38 +0000 Message-Id: <20161217222342.21653-2-stephen@that.guru> X-Mailer: git-send-email 2.9.3 In-Reply-To: <20161217222342.21653-1-stephen@that.guru> References: <20161217222342.21653-1-stephen@that.guru> X-AuthUser: stephen@that.guru X-Spam-Status: No, score=-1.8 required=5.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_NONE,T_DKIM_INVALID autolearn=no version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on smtp1.linux-foundation.org Subject: [ovs-dev] [PATCH 2/6] doc: Misc fixes to 'documentation-style' X-BeenThere: ovs-dev@openvswitch.org X-Mailman-Version: 2.1.12 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Sender: ovs-dev-bounces@openvswitch.org Errors-To: ovs-dev-bounces@openvswitch.org The table headers are unnecessary and make the doc harder to read, while the headers guide was not displaying very well. Signed-off-by: Stephen Finucane --- .../internals/contributing/documentation-style.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/Documentation/internals/contributing/documentation-style.rst b/Documentation/internals/contributing/documentation-style.rst index 02a8d50..60ef248 100644 --- a/Documentation/internals/contributing/documentation-style.rst +++ b/Documentation/internals/contributing/documentation-style.rst @@ -94,11 +94,11 @@ Titles - Use the following headers levels. - | ======= Heading 0 (reserved for the title in a document) - | ------- Heading 1 - | ~~~~~~~ Heading 2 - | +++++++ Heading 3 - | ''''''' Heading 4 + | ``=======`` Heading 0 (reserved for the title in a document) + | ``-------`` Heading 1 + | ``~~~~~~~`` Heading 2 + | ``+++++++`` Heading 3 + | ``'''''''`` Heading 4 .. note:: @@ -279,7 +279,7 @@ vSwitch documentation. These guidelines are based on the `IBM Style Guide Commonly used terms like CPU or RAM are allowed. - .. list-table:: Example + .. list-table:: :header-rows: 1 * - Do not use @@ -293,7 +293,7 @@ vSwitch documentation. These guidelines are based on the `IBM Style Guide The subject should do the verb's action, rather than be acted upon. - .. list-table:: Example + .. list-table:: :header-rows: 1 * - Do not use @@ -303,7 +303,7 @@ vSwitch documentation. These guidelines are based on the `IBM Style Guide - Write in the present tense - .. list-table:: Example + .. list-table:: :header-rows: 1 * - Do not use @@ -313,7 +313,7 @@ vSwitch documentation. These guidelines are based on the `IBM Style Guide - Write in second person - .. list-table:: Example + .. list-table:: :header-rows: 1 * - Do not use