From patchwork Thu Dec 22 09:54:46 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Finucane X-Patchwork-Id: 708182 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 3tkn340C8bz9sBv for ; Thu, 22 Dec 2016 20:56:00 +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="RfY8tc5Z"; dkim-atps=neutral Received: from mail.linux-foundation.org (localhost [127.0.0.1]) by mail.linuxfoundation.org (Postfix) with ESMTP id 04A8FA48; Thu, 22 Dec 2016 09:55:02 +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 DE707A5E for ; Thu, 22 Dec 2016 09:55:00 +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 7E848CB for ; Thu, 22 Dec 2016 09:55:00 +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 D0D5C1BC438 for ; Thu, 22 Dec 2016 09:54:59 +0000 (UTC) Received: from one.mxroute.com (ip-10-27-139-41.us-west-2.compute.internal [10.27.139.41]) by relay.mailchannels.net (Postfix) with ESMTPA id 68AF61BC35A for ; Thu, 22 Dec 2016 09:54:59 +0000 (UTC) X-Sender-Id: mxroute|x-authuser|stephen@that.guru Received: from one.mxroute.com ([UNAVAILABLE]. [10.90.135.124]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384) by 0.0.0.0:2500 (trex/5.7.8); Thu, 22 Dec 2016 09:54:59 +0000 X-MC-Relay: Neutral X-MailChannels-SenderId: mxroute|x-authuser|stephen@that.guru X-MailChannels-Auth-Id: mxroute X-MC-Loop-Signature: 1482400499622:564530291 X-MC-Ingress-Time: 1482400499622 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=KyqsNzzsb9bNkC6uAtFoWTHpfmDdKWdqTaxURNHzs4A=; b=RfY8tc5ZPObcTE/cAr4Xw4Ugmk 3YP0xddST/RetUqQ/aAC10se0hoPbpyYT2JrgKIDSs5NLozibpFaFPJBoQMf28l0UR9yJVzkhbgpg E0HexQMUE/m8EmJlxyGnhyYcY3Ih348hEFNcKTCLAksPjnSMOGlw6l+65Dc1mMdoAw6YVE6h9wSVE C3jRDQu402QnIgGXH+GqczvOHqv4K3JbKYlZAZ/hve34sbBYYpbi9QAR3EB6MZUggIkumiMjcMtBz Mr6KHmDX0Zc3mYpwHxWWAPl+r/9iXoRZ+pCAneDbU7kQUorCTN856HurXw9lqy7V2DvJ562YCRsnk v70VyIPg==; From: Stephen Finucane To: dev@openvswitch.org Date: Thu, 22 Dec 2016 09:54:46 +0000 Message-Id: <20161222095447.23007-5-stephen@that.guru> X-Mailer: git-send-email 2.9.3 In-Reply-To: <20161222095447.23007-1-stephen@that.guru> References: <20161222095447.23007-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 v2 5/6] doc: Recommend compressed PNG images where possible 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 ASCII images take up less space but are significantly less readable than proper images. Signed-off-by: Stephen Finucane --- .../internals/contributing/documentation-style.rst | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/Documentation/internals/contributing/documentation-style.rst b/Documentation/internals/contributing/documentation-style.rst index 3c04b86..b1b7e41 100644 --- a/Documentation/internals/contributing/documentation-style.rst +++ b/Documentation/internals/contributing/documentation-style.rst @@ -247,13 +247,22 @@ Cross-referencing Here is a cross-reference to :ref:`sample-crossref`. .. note:: - This is a Sphinx extension. Do not use this in any top-level documents. + + This is a Sphinx extension. Do not use this in any top-level documents. Figures and Other Media ~~~~~~~~~~~~~~~~~~~~~~~ -- All images should be in ASCII format and included in code-blocks to preserve - formatting. +- All images should be in PNG format and compressed where possible. For PNG + files, use OptiPNG and AdvanceCOMP's ``advpng``: + + .. code-block:: shell + + $ optipng -o7 -zm1-9 -i0 -strip all + $ advpng -z4 + +- Any ASCII text "images" should be included in code-blocks to preserve + formatting - Include other reStructuredText verbatim in a current document