From owner-freebsd-doc@FreeBSD.ORG Sat Feb 8 17:04:42 2014 Return-Path: Delivered-To: doc@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 BD8622ED; Sat, 8 Feb 2014 17:04:42 +0000 (UTC) Received: from homiemail-a54.g.dreamhost.com (caiajhbdcagg.dreamhost.com [208.97.132.66]) by mx1.freebsd.org (Postfix) with ESMTP id 981651C84; Sat, 8 Feb 2014 17:04:42 +0000 (UTC) Received: from homiemail-a54.g.dreamhost.com (localhost [127.0.0.1]) by homiemail-a54.g.dreamhost.com (Postfix) with ESMTP id 36C854012241C; Sat, 8 Feb 2014 09:04:36 -0800 (PST) Received: from dreadnaught (ip68-100-185-59.dc.dc.cox.net [68.100.185.59]) (Authenticated sender: trhodes@fbsdsecure.org) by homiemail-a54.g.dreamhost.com (Postfix) with ESMTPA id 8FA954012241B; Sat, 8 Feb 2014 09:04:35 -0800 (PST) Date: Sat, 8 Feb 2014 12:04:34 -0500 From: Tom Rhodes To: Warren Block Subject: Re: [WIP]: Splitting up the porters handbook Message-Id: <20140208120434.213635b2.trhodes@FreeBSD.org> In-Reply-To: References: <20140208105726.3e1b52d8.trhodes@FreeBSD.org> X-Mailer: Sylpheed version 1.0.6 (GTK+ 1.2.10; x86_64-unknown-freebsd9.2) Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Cc: port-mngr@FreeBSD.org, doc@FreeBSD.org, doceng@FreeBSD.org X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.17 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 08 Feb 2014 17:04:42 -0000 On Sat, 8 Feb 2014 09:47:09 -0700 (MST) Warren Block wrote: > On Sat, 8 Feb 2014, Tom Rhodes wrote: > > > Hi, > > > > So - today I spent a few moments (and a few for loops) splitting > > up the porters-handbook into several sections. Here is the WIP > > patch: > > > > http://people.freebsd.org/~trhodes/NEW-PH.diff > > > > Please note it DOES NOT BUILD just yet. Before I actually go > > through the trouble of finishing this, is there going to be > > a lot of push back? Can I continue and commit (a version that > > builds of course) and then the team can work together to polish > > off the rough edges with me or should I just not bother? Thanks, > > > > I'm going to not work on this anymore today while I wait for > > feedback - if it's generally positive, I'll try to finish it > > up tonight/tomorrow morning and start the commits. Cheers, > > Can't speak for others, but I agree. It's something that has needed to > be done for a while now. Based on experience from the Handbook, I > suggest fixing the titles in the sections that will become chapters, > then using those actual titles for the chapter directory names. With > the Handbook, the names don't match and it is difficult to find > sections for editing. > > So: > > The title of "Making a New Port Yourself" becomes "Making a New Port" > (or "Creating a New Port"), and then the chapter directory is > making-a-new-port, or creating-a-new-port. The length of these is not > as critical as making them consistent with the title. > > "Testing Your Port" becomes "Testing the Port". > "Upgrading an Individual Port" becomes "Upgrading a Port". > "Ports Security" becomes just "Security". > > The chapter entries in SRCS should be in the order they appear in the > book. All good points - thanks! I'll put that in the list of things to do before commit. Most of what I did was automated, from creating a Makefile template to using csplit to divide up the chapters. The more manual stuff, things I can't do in a few moments, well, that's waiting for feedback. I'll wait for more and then continue, cheers! -- Tom Rhodes