From owner-freebsd-doc@FreeBSD.ORG Tue Apr 2 01:01:20 2013 Return-Path: Delivered-To: doc@freebsd.org Received: from mx1.freebsd.org (mx1.FreeBSD.org [8.8.178.115]) by hub.freebsd.org (Postfix) with ESMTP id 49B8BBCC for ; Tue, 2 Apr 2013 01:01:20 +0000 (UTC) (envelope-from lists@eitanadler.com) Received: from mail-pb0-f48.google.com (mail-pb0-f48.google.com [209.85.160.48]) by mx1.freebsd.org (Postfix) with ESMTP id 25FBEAA8 for ; Tue, 2 Apr 2013 01:01:19 +0000 (UTC) Received: by mail-pb0-f48.google.com with SMTP id xb4so791628pbc.21 for ; Mon, 01 Apr 2013 18:01:19 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=eitanadler.com; s=0xdeadbeef; h=x-received:mime-version:in-reply-to:references:from:date:message-id :subject:to:cc:content-type; bh=N1jrzKwSpmCKbsxI3Ir78U2Ixoezx+GSes6UKdAFMiE=; b=Z+x+vOjMNfitqqZisvFrb1PjI8jmZiEkeHiYhe89ARAv9fhHnMD8GKpLhUfFAbdVpV SvHIIm+nu0Z49ApApvNFPzIXQ3e+k73C/dKcnMnqQPC1DbKoEVoMgfV0DcrXJlWVjtap TnBOXlvt0ONVNnFZjDn8bX4eWb0nsO2hDdjaU= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20120113; h=x-received:mime-version:in-reply-to:references:from:date:message-id :subject:to:cc:content-type:x-gm-message-state; bh=N1jrzKwSpmCKbsxI3Ir78U2Ixoezx+GSes6UKdAFMiE=; b=m3XaGbREA/OH7FR3u3QtHEoyVFMtfOIOyObeMj8/ZAeAO3QZcaMZmz3/IiyHOCVhj4 4hKgn4gnodkYJ7rmy7KR3+nzfJAxgfuDGgcGec5f0EnRNy/8osc6VNHxB7ioKpeIK3q7 uVeNL0M0gHrvI7/jeU7Uxau7WMclJkHSdEyjmVOTF95ZGlSTrckVaHJ/cBc1eslolCu+ +nCeL1FcFUnbP63IVZVK5mb7PCl/1nPRwBTlY0bU8+8F3PrqThnI0HfXrv8IDokZCDCE GdbjNdO5imryvdYxp+z9awWBhNVvH5IdurXYjd4VCY6d3Txsg6N1jLK2+/WKEs+iGEav 4yRw== X-Received: by 10.68.233.74 with SMTP id tu10mr21097157pbc.57.1364864479748; Mon, 01 Apr 2013 18:01:19 -0700 (PDT) MIME-Version: 1.0 Received: by 10.66.86.34 with HTTP; Mon, 1 Apr 2013 18:00:49 -0700 (PDT) In-Reply-To: References: From: Eitan Adler Date: Mon, 1 Apr 2013 21:00:49 -0400 Message-ID: Subject: Re: Need help documenting development processes in FreeBSD To: Garrett Cooper Content-Type: text/plain; charset=UTF-8 X-Gm-Message-State: ALoCoQkqHcsRQD4vyPIjI+vJQiJqlh7+zXe5uaZ8Z8+nyd20uPKklYPdi4uYfxhNG2YecVJdmfxQ Cc: core@freebsd.org, doc@freebsd.org X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 02 Apr 2013 01:01:20 -0000 On 1 April 2013 20:57, Garrett Cooper wrote: > Hi, > In order to bring contributors up to speed on how to interact with > FreeBSD, I want to document some of the items that aren't really noted in > the FreeBSD developers or committers handbook. Some topics that come to > mind are "How do I do a precommit build?" (tinderbox, etc), "How do I test > my changes?" (there's a chapter, but it's not helpful), "How do I get > involved with the project?", "How do I build quickly?", "What are mtree > files?", etc. Awesome. I'd love to see this work. > I was wondering if a) there are any other developers interested in this > effort, b) where it should go (in the dev handbook?), and A few options http://www.freebsd.org/doc/en_US.ISO8859-1/books//dev-model/ http://www.freebsd.org/doc/en_US.ISO8859-1/books//developers-handbook/ http://www.freebsd.org/doc/en_US.ISO8859-1/articles/contributing/ My preference is #2. > c) who would be > interested in reviewing the work? I'd like to put it up on the wiki first > (as I'm not an SGML wizard) and put it in SGML eventually, but I need > feedback on whether or not this is doable. I'll be happy to review, and I'll also be happy to make sure the final work gets into the tree. FWIW we use XML, not SGML, now, though there is little difference for the author. -- Eitan Adler