From patchwork Fri Nov 13 02:18:40 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Finucane X-Patchwork-Id: 544015 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from archives.nicira.com (li376-54.members.linode.com [96.126.127.54]) by ozlabs.org (Postfix) with ESMTP id A6931141301 for ; Fri, 13 Nov 2015 13:19:02 +1100 (AEDT) Received: from archives.nicira.com (localhost [127.0.0.1]) by archives.nicira.com (Postfix) with ESMTP id CAA03109FF; Thu, 12 Nov 2015 18:19:00 -0800 (PST) X-Original-To: dev@openvswitch.org Delivered-To: dev@openvswitch.org Received: from mx3v3.cudamail.com (mx3.cudamail.com [64.34.241.5]) by archives.nicira.com (Postfix) with ESMTPS id 055CC109FE for ; Thu, 12 Nov 2015 18:19:00 -0800 (PST) Received: from bar4.cudamail.com (localhost [127.0.0.1]) by mx3v3.cudamail.com (Postfix) with ESMTPS id D6121162F11 for ; Thu, 12 Nov 2015 19:18:58 -0700 (MST) X-ASG-Debug-ID: 1447381138-03dc2138f7058d0001-byXFYA Received: from mx3-pf1.cudamail.com ([192.168.14.2]) by bar4.cudamail.com with ESMTP id 6AVc0dLVtxsujCRn (version=TLSv1 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO) for ; Thu, 12 Nov 2015 19:18:58 -0700 (MST) X-Barracuda-Envelope-From: sfinucan@ecsmtp.ir.intel.com X-Barracuda-RBL-Trusted-Forwarder: 192.168.14.2 Received: from unknown (HELO mga11.intel.com) (192.55.52.93) by mx3-pf1.cudamail.com with SMTP; 13 Nov 2015 02:18:52 -0000 Received-SPF: none (mx3-pf1.cudamail.com: domain at ecsmtp.ir.intel.com does not designate permitted sender hosts) X-Barracuda-Apparent-Source-IP: 192.55.52.93 X-Barracuda-RBL-IP: 192.55.52.93 Received: from orsmga003.jf.intel.com ([10.7.209.27]) by fmsmga102.fm.intel.com with ESMTP; 12 Nov 2015 18:18:51 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.20,285,1444719600"; d="scan'208";a="684324682" Received: from irvmail001.ir.intel.com ([163.33.26.43]) by orsmga003.jf.intel.com with ESMTP; 12 Nov 2015 18:18:50 -0800 Received: from sivswdev01.ir.intel.com (sivswdev01.ir.intel.com [10.237.217.45]) by irvmail001.ir.intel.com (8.14.3/8.13.6/MailSET/Hub) with ESMTP id tAD2Imes021421; Fri, 13 Nov 2015 02:18:48 GMT Received: from sivswdev01.ir.intel.com (localhost [127.0.0.1]) by sivswdev01.ir.intel.com with ESMTP id tAD2Im0D029836; Fri, 13 Nov 2015 02:18:48 GMT Received: (from sfinucan@localhost) by sivswdev01.ir.intel.com with id tAD2Im7c029832; Fri, 13 Nov 2015 02:18:48 GMT X-CudaMail-Envelope-Sender: sfinucan@ecsmtp.ir.intel.com From: Stephen Finucane To: dev@openvswitch.org X-CudaMail-MID: CM-V1-1111070716 X-CudaMail-DTE: 111215 X-CudaMail-Originating-IP: 192.55.52.93 Date: Fri, 13 Nov 2015 02:18:40 +0000 X-ASG-Orig-Subj: [##CM-V1-1111070716##][RFC] make: Add 'lint-docs' target Message-Id: <1447381120-29733-1-git-send-email-stephen.finucane@intel.com> X-Mailer: git-send-email 2.0.0 X-GBUdb-Analysis: 0, 192.55.52.93, Ugly c=0 p=0 Source New X-MessageSniffer-Rules: 0-0-0-4294-c X-Barracuda-Connect: UNKNOWN[192.168.14.2] X-Barracuda-Start-Time: 1447381138 X-Barracuda-Encrypted: DHE-RSA-AES256-SHA X-Barracuda-URL: https://web.cudamail.com:443/cgi-mod/mark.cgi X-Virus-Scanned: by bsmtpd at cudamail.com X-Barracuda-BRTS-Status: 1 X-ASG-Whitelist: EmailCat (corporate) Subject: [ovs-dev] [RFC] make: Add 'lint-docs' target X-BeenThere: dev@openvswitch.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: dev-bounces@openvswitch.org Sender: "dev" This provides a quick, easy way to use the 'mdl' executable provided in markdowlinter to validate documentation. This change does not resolve any of the issues this linter raises - these will need to be done in a follow up patch. Signed-off-by: Stephen Finucane --- INSTALL.md | 5 +++++ Makefile.am | 4 ++++ 2 files changed, 9 insertions(+) diff --git a/INSTALL.md b/INSTALL.md index 906825a..7311915 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -111,6 +111,11 @@ To run the unit tests, you also need: - Perl. Version 5.10.1 is known to work. Earlier versions should also work. +If you are going to modify Open vSwitch documentation, please consider +installing the following to validate your changes: + + - "markdownlint" (https://github.com/mivok/markdownlint) + The ovs-vswitchd.conf.db(5) manpage will include an E-R diagram, in formats other than plain text, only if you have the following: diff --git a/Makefile.am b/Makefile.am index 966ba27..d58cb59 100644 --- a/Makefile.am +++ b/Makefile.am @@ -377,6 +377,10 @@ dist-docs: VERSION=$(VERSION) $(srcdir)/build-aux/dist-docs $(srcdir) $(docs) .PHONY: dist-docs +lint-docs: + mdl $(docs) +.PHONY: dist-docs + include Documentation/automake.mk include m4/automake.mk include lib/automake.mk