From owner-freebsd-testing@FreeBSD.ORG Mon Aug 4 19:19:57 2014 Return-Path: Delivered-To: freebsd-testing@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits)) (No client certificate requested) by hub.freebsd.org (Postfix) with ESMTPS id 66247D98; Mon, 4 Aug 2014 19:19:57 +0000 (UTC) Received: from mail-ie0-x236.google.com (mail-ie0-x236.google.com [IPv6:2607:f8b0:4001:c03::236]) (using TLSv1 with cipher ECDHE-RSA-RC4-SHA (128/128 bits)) (Client CN "smtp.gmail.com", Issuer "Google Internet Authority G2" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 20F8F2D04; Mon, 4 Aug 2014 19:19:57 +0000 (UTC) Received: by mail-ie0-f182.google.com with SMTP id y20so10524638ier.41 for ; Mon, 04 Aug 2014 12:19:56 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :cc:content-type; bh=DgGYeZuKFXQWYAK+RIqwK/OP1JOfbluxtVWN2150GtI=; b=HSL/XsB6o3cD2RCXZp58+k47tGkUnzgX8cuVx5RdhOlEwfyKFYjX2P+SF2SJEq3sOd 3ZmNIn72aJ2dRI1+sJ59MslvHt/KP4U15pyVz9n0TWPP1547oO8m0ROjkBNpM0rNk1bj 9N6s7p66Uu770CKXzPTtRCYgyeDHympOrRFUP46QR8f/uda/jsL9jFRcmCKFhiMuXIPD X8V5T3Od5SWb+XZLVF4PXF0AHLdO+gE8pO0O79AiW8r8ey+gCHtGVFE4MGCI2IoQCgBX +6ls7AOiXBlmiQBuwLWuwfra0pL6TEseJ6iz6/XBPJqOBv5krrXC9SFCTOlNABnD+Npf 9vEA== MIME-Version: 1.0 X-Received: by 10.42.198.75 with SMTP id en11mr33710063icb.7.1407179996458; Mon, 04 Aug 2014 12:19:56 -0700 (PDT) Received: by 10.50.76.229 with HTTP; Mon, 4 Aug 2014 12:19:56 -0700 (PDT) In-Reply-To: References: Date: Mon, 4 Aug 2014 12:19:56 -0700 Message-ID: Subject: Re: Best place to learn how to write tests which work under kyua? From: Garrett Cooper To: Craig Rodrigues Content-Type: text/plain; charset=UTF-8 Cc: "freebsd-testing@freebsd.org" X-BeenThere: freebsd-testing@freebsd.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: Testing on FreeBSD List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 04 Aug 2014 19:19:57 -0000 On Mon, Aug 4, 2014 at 12:02 PM, Craig Rodrigues wrote: > On Mon, Aug 4, 2014 at 11:54 AM, Craig Rodrigues > wrote: > >> On Thu, Jul 24, 2014 at 1:02 PM, Julio Merino wrote: >> >>> >>> What kind of text would help you most? A step-by-step tutorial maybe? >>> Big parts of the process may be tied to the build system you use >>> though, and I only know the BSD build systems and Automake/autoconf... >>> >> >> I need a step-by-step tutorial for how to write a Kyuafile. I am >> not going to be using any of the FreeBSD Makefile infrastructure >> for running tests, so I don't need that info. I am going to be >> migrating some existing tests into a form that can be run under kyua, >> so that I can do: "kyua report-junit". >> >> In future, where is the central source for kyua documentation going to >> live? >> >> I see docs are scattered across: >> >> >> http://wiki.netbsd.org/kyua/ >> https://wiki.freebsd.org/TestingFreeBSD >> https://wiki.freebsd.org/TestSuite >> https://github.com/jmmv/kyua/wiki >> >> It doesn't matter to me where the central source for kyua documentation >> lives, >> but it is nice if a newcomer does a web search for "kyua" and within a few >> clicks >> lands on tutorials and useful documentation. The docs that are there are >> good, >> but it is hard to navigate to them from a web search. >> >> > The kyua man pages are a good place to start. Are the man pages rendered > anywhere "officially"? > > I found this: > > http://manned.org/kyuafile.5 > > which is not bad, but it is a third party service which renders man pages, > so I don't know > how reliable this service is in the long run. Hi Craig! That's a good question. I just looked and it doesn't seem like GitHub natively renders *roff, but that would be a nice feature to have; I just opened https://github.com/github/markup/issues/342 to track the feature request. Would it be a good idea to check in the rendered documentation as part of Travis CI to a doc tree under GitHub? That seems to be what some other projects do. Thanks! -Garrett