From owner-freebsd-doc@FreeBSD.ORG Tue Nov 27 21:03:46 2012 Return-Path: Delivered-To: doc@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [69.147.83.52]) by hub.freebsd.org (Postfix) with ESMTP id 489E5FAC for ; Tue, 27 Nov 2012 21:03:46 +0000 (UTC) (envelope-from r.c.ladan@gmail.com) Received: from mail-bk0-f54.google.com (mail-bk0-f54.google.com [209.85.214.54]) by mx1.freebsd.org (Postfix) with ESMTP id C1BA18FC13 for ; Tue, 27 Nov 2012 21:03:45 +0000 (UTC) Received: by mail-bk0-f54.google.com with SMTP id je9so5230122bkc.13 for ; Tue, 27 Nov 2012 13:03:44 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=sender:message-id:date:from:user-agent:mime-version:to:subject :x-enigmail-version:content-type:content-transfer-encoding; bh=Rku9emUwifYGLgrlxniEIa8JONnxX14hgoYXQlFUOvc=; b=rI4ubgyfHbJdPGe2Kh4ami1uchcEJcArvodYmmkMKyKQcr4vyRSKPoVd5fp/SCAvrY 9mcvw41HcHredMxt3pOgOeo/8D7m4LIjHrCeXGp2mztzrCCTPx2+Qa8eqQ3FGvZbgfrw 0NeelZz6JeQKjyQP7Pni6UsmpOc37eAkALhA+oPsogcSOLbkVJsJXtw9zh0KhSEZnpXp k4EKKLzqhmqUPCppZ/30mngwJpFL/N7TV0c6wxcmfMogbOOOS4YCz4fsJ3y6biv7WVRi 0vsCxcYLLq/F+up1bUMEtS+4K45PLzeYsNmzl45wxAFasrVlzQe2WiHdRWU8gbEd1dsw jfUQ== Received: by 10.204.149.26 with SMTP id r26mr4960104bkv.71.1354050224650; Tue, 27 Nov 2012 13:03:44 -0800 (PST) Received: from ?IPv6:2001:980:d7ed:1:c521:a3f5:b505:8a2a? ([2001:980:d7ed:1:c521:a3f5:b505:8a2a]) by mx.google.com with ESMTPS id l17sm11374673bkw.12.2012.11.27.13.03.42 (version=SSLv3 cipher=OTHER); Tue, 27 Nov 2012 13:03:43 -0800 (PST) Sender: =?UTF-8?Q?Ren=C3=A9_Ladan?= Message-ID: <50B52AAD.7030004@freebsd.org> Date: Tue, 27 Nov 2012 22:03:41 +0100 From: =?ISO-8859-1?Q?Ren=E9_Ladan?= User-Agent: Mozilla/5.0 (X11; FreeBSD amd64; rv:17.0) Gecko/17.0 Thunderbird/17.0 MIME-Version: 1.0 To: FBSD Doc project Subject: [RFC] (partial) patch to clean up authors.ent / developers.ent duplication X-Enigmail-Version: 1.4.6 Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: 8bit 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, 27 Nov 2012 21:03:46 -0000 Hi, we currently have two files in our documentation tree for committer entries (i.e., &a.committer-name; ): share/xml/authors.ent and share/xml/developers.ent, as indicated at [1]. Worse, in authors.ent the entities have an email address included hile in developers.ent they do not. I have a (partial) patch at [2] to merge these two files and unify the meaning of these entities. Currently it: - merges developers.ent into authors.ent (some names changed slightly, e.g., "Simon L. Nielsen" to "Simon L. B. Nielsen", because they differed between these two files); - redefine &a.committer-name; not having an email address and &a.committer-name.email; to have one; - replace (Docbook) references to developers.ent with authors.ent; - removes developers.ent; - add some people with @FreeBSD.org addresses and a FreeBSD account to authors.ent, and use these in the English articles instead; - removes the instruction to add your entity to developers.ent from the Committer's Guide article; - renames some team entities to avoid conflicts resulting in unexpected output; - updates all English articles to ensure their output does not change otherwise (mostly changing &a.committer-name; to &a.committer-name.email; ); - updates instructions in addkey.sh and README and the key listings in share/pgpkeys; - replaces (most) web pages to use the more readable form to list teams as proposed in [1]; - remove a duplicate and out of date team.re entity from share/xml/teams.ent. Todo: - fix the WWW build, currently there is no DSL code to transform tags into some href code (maybe this can be copied from the doc build); - modify the English books to make sure their output remains the same; - make sure the translations still build; - agree on what to do about the translations, their output will change until their XML sources are resynchronized with their English counterparts. Personally I am in favor of leaving this up to the translation teams to avoid interfering with their work; - Maybe transform some more literal names into entities; - Probably some other minor cleanups (like line rewrapping in a second commit). Not-todo: - change literal occurrences of "FreeBSD" to "&os;"; - change entities for accented letters into their literal form; - remove old content; - unrelated XML/igor/spelling fixes. Questions: - Maybe this should go in a branch first (especially when it is decided to include the translations)? - There is no ds@ , although the current documentation somewhat suggests he has an account? - The 2005 and 2006 editions of the Summer of Code pages include email addresses, while the 2007 and 2008 versions do not? [1] http://lists.freebsd.org/pipermail/freebsd-doc/2012-November/020720.html [2] http://people.freebsd.org/~rene/patches/head-entities.diff (yes, 11,120 lines and growing) René