From owner-freebsd-chat@FreeBSD.ORG Tue Feb 19 08:27:03 2013 Return-Path: Delivered-To: freebsd-chat@FreeBSD.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by hub.freebsd.org (Postfix) with ESMTP id 3A310630; Tue, 19 Feb 2013 08:27:03 +0000 (UTC) (envelope-from cnst++@FreeBSD.org) Received: from Cns.Cns.SU (unknown [IPv6:2001:470:7240::]) by mx1.freebsd.org (Postfix) with ESMTP id B8ECA6B4; Tue, 19 Feb 2013 08:27:02 +0000 (UTC) Received: from Cns.Cns.SU (cnst@localhost [127.0.0.1]) by Cns.Cns.SU (8.14.5/8.14.5) with ESMTP id r1J8R17I007714; Tue, 19 Feb 2013 00:27:01 -0800 (PST) Received: (from cnst@localhost) by Cns.Cns.SU (8.14.5/8.14.5/Submit) id r1J8R1rs023311; Tue, 19 Feb 2013 00:27:01 -0800 (PST) X-Authentication-Warning: Cns.Cns.SU: cnst set sender to cnst++@FreeBSD.org using -f Date: Tue, 19 Feb 2013 00:27:01 -0800 From: "Constantine A. Murenin" To: freebsd-chat@FreeBSD.org, freebsd-current@FreeBSD.org, freebsd-doc@FreeBSD.org Subject: announcing mdoc.su, short manual page URLs Message-ID: <20130219082700.GA9938@Cns.Cns.SU> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii; format=flowed Content-Disposition: inline User-Agent: Mutt/1.5.21 (2010-09-15) X-BeenThere: freebsd-chat@freebsd.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: Non technical items related to the community List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 19 Feb 2013 08:27:03 -0000 Dear freebsd-{chat,current,doc}@, I would like to announce and introduce , a deterministic URL shortener for BSD manual pages, written entirely in nginx.conf. It supports several address schemes, for example: http://mdoc.su/f/zfs http://mdoc.su/f/zfs.8 http://mdoc.su/f/8/zfs http://mdoc.su/freebsd/zfs http://mdoc.su/FreeBSD/zfs http://mdoc.su/d/hammer.5 http://mdoc.su/d/hammer.8 etc. Source code for the whole mdoc.su.nginx.conf is available at: https://github.com/cnst/mdoc.su https://bitbucket.org/cnst/mdoc.su Specifically, the following currently controls FreeBSD rewriting: location /FreeBSD { rewrite ^/FreeBSD(/.*)?$ /f$1; } location /f { set $fb "http://www.freebsd.org/cgi/man.cgi?query="; set $fs "&sektion="; rewrite ^/freebsd(/.*)?$ /.$1; rewrite ^/./([^/.]+)/([^/]+)$ $fb$2$fs$1 redirect; rewrite ^/./([^/]+)\.([1-9])$ $fb$1$fs$2 redirect; rewrite ^/./([^/]+)$ $fb$1$fs redirect; rewrite ^/./?$ / last; return 404; } Translation: "/FreeBSD" and "/freebsd" get rewritten to "/f" internally, without any extra replies to the user, and then the rest of the URI is analysed, and a "302 Found" redirect is finally issued to the user. Pages like http://mdoc.su/f/ redirect to the main "/" page internally, without affecting the URL that's visible to the user, making it easier to keep a starting page specifically for one BSD. Questions, comments and suggestions are very welcome. Available through IPv4 and IPv6. Enjoy! Best regards, Constantine. From owner-freebsd-chat@FreeBSD.ORG Tue Feb 19 11:57:34 2013 Return-Path: Delivered-To: freebsd-chat@FreeBSD.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by hub.freebsd.org (Postfix) with ESMTP id BEBB6716; Tue, 19 Feb 2013 11:57:34 +0000 (UTC) (envelope-from des@des.no) Received: from smtp.des.no (smtp.des.no [194.63.250.102]) by mx1.freebsd.org (Postfix) with ESMTP id 7A9FB801; Tue, 19 Feb 2013 11:57:34 +0000 (UTC) Received: from ds4.des.no (smtp.des.no [194.63.250.102]) by smtp-int.des.no (Postfix) with ESMTP id 54EAA6B00; Tue, 19 Feb 2013 11:57:26 +0000 (UTC) Received: by ds4.des.no (Postfix, from userid 1001) id 2F6E69428; Tue, 19 Feb 2013 12:57:26 +0100 (CET) From: =?utf-8?Q?Dag-Erling_Sm=C3=B8rgrav?= To: "Constantine A. Murenin" Subject: Re: announcing mdoc.su, short manual page URLs References: <20130219082700.GA9938@Cns.Cns.SU> Date: Tue, 19 Feb 2013 12:57:26 +0100 In-Reply-To: <20130219082700.GA9938@Cns.Cns.SU> (Constantine A. Murenin's message of "Tue, 19 Feb 2013 00:27:01 -0800") Message-ID: <86k3q4zfbt.fsf@ds4.des.no> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.2 (berkeley-unix) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Cc: freebsd-doc@FreeBSD.org, freebsd-current@FreeBSD.org, freebsd-chat@FreeBSD.org X-BeenThere: freebsd-chat@freebsd.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: Non technical items related to the community List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 19 Feb 2013 11:57:34 -0000 "Constantine A. Murenin" writes: > I would like to announce and introduce , a > deterministic URL shortener for BSD manual pages, written entirely in > nginx.conf. [...] This looks awesome, thank you very much! DES --=20 Dag-Erling Sm=C3=B8rgrav - des@des.no From owner-freebsd-chat@FreeBSD.ORG Tue Feb 19 22:01:11 2013 Return-Path: Delivered-To: freebsd-chat@FreeBSD.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by hub.freebsd.org (Postfix) with ESMTP id CA38AB76; Tue, 19 Feb 2013 22:01:11 +0000 (UTC) (envelope-from list_freebsd@bluerosetech.com) Received: from rush.bluerosetech.com (rush.bluerosetech.com [199.48.134.58]) by mx1.freebsd.org (Postfix) with ESMTP id 9D749A32; Tue, 19 Feb 2013 22:01:11 +0000 (UTC) Received: from chombo.houseloki.net (montesse-2-pt.tunnel.tserv3.fmt2.ipv6.he.net [IPv6:2001:470:1f04:19b9::2]) by rush.bluerosetech.com (Postfix) with ESMTPSA id 630591146A; Tue, 19 Feb 2013 14:01:05 -0800 (PST) Received: from [127.0.0.1] (ivo.houseloki.net [10.9.70.20]) by chombo.houseloki.net (Postfix) with ESMTPSA id 127B012C; Tue, 19 Feb 2013 14:01:03 -0800 (PST) Message-ID: <5123F61F.40807@bluerosetech.com> Date: Tue, 19 Feb 2013 14:01:03 -0800 From: Darren Pilgrim User-Agent: Mozilla/5.0 (Windows NT 6.1; rv:17.0) Gecko/20130107 Thunderbird/17.0.2 MIME-Version: 1.0 To: "Constantine A. Murenin" Subject: Re: announcing mdoc.su, short manual page URLs References: <20130219082700.GA9938@Cns.Cns.SU> In-Reply-To: <20130219082700.GA9938@Cns.Cns.SU> Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit Cc: freebsd-doc@FreeBSD.org, freebsd-current@FreeBSD.org, freebsd-chat@FreeBSD.org X-BeenThere: freebsd-chat@freebsd.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: Non technical items related to the community List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 19 Feb 2013 22:01:11 -0000 One of the really cool things Constantine didn't mention is the entire site is just the nginx config! It's done with what some might consider slight abuses of rewrite rules, but it does mean the whole thing is completely memory resident. The full config on github is definitely worth a read. From owner-freebsd-chat@FreeBSD.ORG Wed Feb 20 14:37:31 2013 Return-Path: Delivered-To: freebsd-chat@freebsd.org Received: from mx1.freebsd.org (mx1.FreeBSD.org [8.8.178.115]) by hub.freebsd.org (Postfix) with ESMTP id 30B3D223; Wed, 20 Feb 2013 14:37:31 +0000 (UTC) (envelope-from freebsd@psconsult.nl) Received: from mx1.psconsult.nl (unknown [IPv6:2001:7b8:30f:e0::5059:ee8a]) by mx1.freebsd.org (Postfix) with ESMTP id C276985D; Wed, 20 Feb 2013 14:37:30 +0000 (UTC) Received: from mx1.psconsult.nl (mx1.hvnu.psconsult.nl [46.44.189.154]) by mx1.psconsult.nl (8.14.5/8.14.4) with ESMTP id r1KEbKCS004758 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO); Wed, 20 Feb 2013 15:37:25 +0100 (CET) (envelope-from freebsd@psconsult.nl) Received: (from paul@localhost) by mx1.psconsult.nl (8.14.5/8.14.4/Submit) id r1KEbKGU004757; Wed, 20 Feb 2013 15:37:20 +0100 (CET) (envelope-from freebsd@psconsult.nl) X-Authentication-Warning: mx1.psconsult.nl: paul set sender to freebsd@psconsult.nl using -f Date: Wed, 20 Feb 2013 15:37:20 +0100 From: Paul Schenkeveld To: "Constantine A. Murenin" Subject: Re: announcing mdoc.su, short manual page URLs Message-ID: <20130220143720.GA4368@psconsult.nl> References: <20130219082700.GA9938@Cns.Cns.SU> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20130219082700.GA9938@Cns.Cns.SU> User-Agent: Mutt/1.5.21 (2010-09-15) Cc: freebsd-doc@freebsd.org, freebsd-current@freebsd.org, freebsd-chat@freebsd.org, Darren Pilgrim X-BeenThere: freebsd-chat@freebsd.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: Non technical items related to the community List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 20 Feb 2013 14:37:31 -0000 On Tue, Feb 19, 2013 at 12:27:01AM -0800, Constantine A. Murenin wrote: > Dear freebsd-{chat,current,doc}@, > > I would like to announce and introduce , > a deterministic URL shortener for BSD manual pages, > written entirely in nginx.conf. > > It supports several address schemes, for example: > > http://mdoc.su/f/zfs > http://mdoc.su/f/zfs.8 > http://mdoc.su/f/8/zfs > http://mdoc.su/freebsd/zfs > http://mdoc.su/FreeBSD/zfs > > http://mdoc.su/d/hammer.5 > http://mdoc.su/d/hammer.8 > > etc. Very coooool! One question: is the os version accessible comewhere, i.e. can I ask for a manpage from a specific version of FreeBSD? I have to disagree with Darren Pilgrim however, this is not "slight abuse" of rewrite rules but putting rewrite rules to "better use" :-) Kind regards, Paul Schenkeveld From owner-freebsd-chat@FreeBSD.ORG Wed Feb 20 15:44:24 2013 Return-Path: Delivered-To: freebsd-chat@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by hub.freebsd.org (Postfix) with ESMTP id D6C75DB0 for ; Wed, 20 Feb 2013 15:44:24 +0000 (UTC) (envelope-from gnrp@komkon2.de) Received: from einhorn.in-berlin.de (einhorn.in-berlin.de [192.109.42.8]) by mx1.freebsd.org (Postfix) with ESMTP id 6C15CD0D for ; Wed, 20 Feb 2013 15:44:23 +0000 (UTC) X-Envelope-From: gnrp@komkon2.de X-Envelope-To: Received: from adolfputzen (laptopecke.physik-pool.tu-berlin.de [130.149.58.159]) (authenticated bits=0) by einhorn.in-berlin.de (8.13.6/8.13.6/Debian-1) with ESMTP id r1KFiGIc029118 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES128-SHA bits=128 verify=NOT) for ; Wed, 20 Feb 2013 16:44:17 +0100 Date: Wed, 20 Feb 2013 16:44:14 +0100 From: Julian Djamil Fagir To: freebsd-chat@freebsd.org Subject: Re: announcing mdoc.su, short manual page URLs Message-ID: <20130220164414.1af1147d@adolfputzen> In-Reply-To: <20130219082700.GA9938@Cns.Cns.SU> References: <20130219082700.GA9938@Cns.Cns.SU> X-Mailer: Claws Mail 3.7.10 (GTK+ 2.14.7; x86_64-unknown-linux-gnu) Mime-Version: 1.0 Content-Type: multipart/signed; boundary="Sig_/9Cb=Yp1vR=GtYUAvsEFR//_"; protocol="application/pgp-signature"; micalg=PGP-SHA1 X-Scanned-By: MIMEDefang_at_IN-Berlin_e.V. on 192.109.42.8 X-BeenThere: freebsd-chat@freebsd.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: Non technical items related to the community List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 20 Feb 2013 15:44:24 -0000 --Sig_/9Cb=Yp1vR=GtYUAvsEFR//_ Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: quoted-printable Hi, On Tue, 19 Feb 2013 00:27:01 -0800 Constantine A. Murenin wrote: > Questions, comments and suggestions are very welcome. =20 > Available through IPv4 and IPv6. =20 > Enjoy! I used your plugin as an opportunity to finish a plugin for Dokuwiki I once wrote (but only for NetBSD): https://www.dokuwiki.org/plugin:manlink It automatically exchanges manpage references like ftpd(8) by the appropria= te links, using mdoc.su. If you don't want the traffic (though I doubt anybody will use it), please tell me, and I'll try to directly link the manpage sites. Regards, Julian --Sig_/9Cb=Yp1vR=GtYUAvsEFR//_ Content-Type: application/pgp-signature; name=signature.asc Content-Disposition: attachment; filename=signature.asc -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.9 (GNU/Linux) iEYEARECAAYFAlEk704ACgkQc7h7cu1Hpp6YAwCbBzcOh+uZQvLVJ6T4T+bGem4B /10AmwTIVN0kFYR26dWdYipD7O1OTZZZ =+2cP -----END PGP SIGNATURE----- --Sig_/9Cb=Yp1vR=GtYUAvsEFR//_-- From owner-freebsd-chat@FreeBSD.ORG Wed Feb 20 15:47:24 2013 Return-Path: Delivered-To: freebsd-chat@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by hub.freebsd.org (Postfix) with ESMTP id 05AC6FB4 for ; Wed, 20 Feb 2013 15:47:24 +0000 (UTC) (envelope-from gnrp@komkon2.de) Received: from einhorn.in-berlin.de (einhorn.in-berlin.de [192.109.42.8]) by mx1.freebsd.org (Postfix) with ESMTP id 90828D54 for ; Wed, 20 Feb 2013 15:47:23 +0000 (UTC) X-Envelope-From: gnrp@komkon2.de X-Envelope-To: Received: from adolfputzen (laptopecke.physik-pool.tu-berlin.de [130.149.58.159]) (authenticated bits=0) by einhorn.in-berlin.de (8.13.6/8.13.6/Debian-1) with ESMTP id r1KFlMCp029939 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES128-SHA bits=128 verify=NOT) for ; Wed, 20 Feb 2013 16:47:22 +0100 Date: Wed, 20 Feb 2013 16:47:22 +0100 From: Julian Djamil Fagir To: freebsd-chat@freebsd.org Subject: Re: announcing mdoc.su, short manual page URLs Message-ID: <20130220164722.213f4a27@adolfputzen> In-Reply-To: <20130220164414.1af1147d@adolfputzen> References: <20130219082700.GA9938@Cns.Cns.SU> <20130220164414.1af1147d@adolfputzen> X-Mailer: Claws Mail 3.7.10 (GTK+ 2.14.7; x86_64-unknown-linux-gnu) Mime-Version: 1.0 Content-Type: multipart/signed; boundary="Sig_/vLHSwPwt3rOycM/JdIITJbZ"; protocol="application/pgp-signature"; micalg=PGP-SHA1 X-Scanned-By: MIMEDefang_at_IN-Berlin_e.V. on 192.109.42.8 X-BeenThere: freebsd-chat@freebsd.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: Non technical items related to the community List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 20 Feb 2013 15:47:24 -0000 --Sig_/vLHSwPwt3rOycM/JdIITJbZ Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: quoted-printable Hi, On Wed, 20 Feb 2013 16:44:14 +0100 Julian Djamil Fagir wrote: > On Tue, 19 Feb 2013 00:27:01 -0800 Constantine A. Murenin wrote: > > Questions, comments and suggestions are very welcome. =20 > > Available through IPv4 and IPv6. =20 > > Enjoy! >=20 > I used your plugin as an opportunity to finish a plugin for Dokuwiki I on= ce > wrote (but only for NetBSD): sorry for the noise, but one correction: The initial plugin only worked for NetBSD. manlink works for FreeBSD, DragonFlyBSD and OpenBSD as well. Regards, Julian --Sig_/vLHSwPwt3rOycM/JdIITJbZ Content-Type: application/pgp-signature; name=signature.asc Content-Disposition: attachment; filename=signature.asc -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.9 (GNU/Linux) iEYEARECAAYFAlEk8AoACgkQc7h7cu1Hpp4XwQCcClanJZ3eIswYS4sZShBXkF4d mrgAn2x+NYwn9xujNltN4UnWvZfkDCpj =muu8 -----END PGP SIGNATURE----- --Sig_/vLHSwPwt3rOycM/JdIITJbZ-- From owner-freebsd-chat@FreeBSD.ORG Thu Feb 21 21:36:44 2013 Return-Path: Delivered-To: freebsd-chat@FreeBSD.org Received: from mx1.freebsd.org (mx1.FreeBSD.org [8.8.178.115]) by hub.freebsd.org (Postfix) with ESMTP id 428027AD; Thu, 21 Feb 2013 21:36:44 +0000 (UTC) (envelope-from cnst++@FreeBSD.org) Received: from Cns.Cns.SU (unknown [IPv6:2001:470:7240::]) by mx1.freebsd.org (Postfix) with ESMTP id E3DD9DB6; Thu, 21 Feb 2013 21:36:43 +0000 (UTC) Received: from [127.0.0.1] (root@localhost [127.0.0.1]) by Cns.Cns.SU (8.14.5/8.14.5) with ESMTP id r1LLacbl018609; Thu, 21 Feb 2013 13:36:41 -0800 (PST) Message-ID: <51269360.20903@FreeBSD.org> Date: Thu, 21 Feb 2013 13:36:32 -0800 From: "Constantine A. Murenin" Organization: FreeBSD User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:16.0) Gecko/20121026 SeaMonkey/2.13.2 MIME-Version: 1.0 To: Paul Schenkeveld Subject: Re: announcing mdoc.su, short manual page URLs References: <20130219082700.GA9938@Cns.Cns.SU> <20130220143720.GA4368@psconsult.nl> In-Reply-To: <20130220143720.GA4368@psconsult.nl> Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit Cc: freebsd-doc@FreeBSD.org, freebsd-chat@FreeBSD.org X-BeenThere: freebsd-chat@freebsd.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: Non technical items related to the community List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 21 Feb 2013 21:36:44 -0000 Paul Schenkeveld wrote: > On Tue, Feb 19, 2013 at 12:27:01AM -0800, Constantine A. Murenin wrote: >> Dear freebsd-{chat,current,doc}@, >> >> I would like to announce and introduce , >> a deterministic URL shortener for BSD manual pages, >> written entirely in nginx.conf. >> >> It supports several address schemes, for example: >> >> http://mdoc.su/f/zfs >> http://mdoc.su/f/zfs.8 >> http://mdoc.su/f/8/zfs >> http://mdoc.su/freebsd/zfs >> http://mdoc.su/FreeBSD/zfs >> >> http://mdoc.su/d/hammer.5 >> http://mdoc.su/d/hammer.8 >> >> etc. > > Very coooool! > > One question: is the os version accessible comewhere, i.e. can I ask for > a manpage from a specific version of FreeBSD? Not originally; this would be the first RfE. :-) The problem is mostly UI design, consistency and the actual mappings. How would you expect to specify a specific version of FreeBSD? /f74/stat ? /f74/stat.2 ? /f74/2/stat ? hmm /f7/stat ? /f7/stat.2 ? /f7/2/stat ? that wouldn't be for 7.2, right? /FreeBSD-7.4/stat ? /FreeBSD-7.4/stat.2 ? /FreeBSD-7.4/2/stat ? hmm... /FreeBSD-7/stat ? /FreeBSD-7/stat.2 ? /FreeBSD-7/2/stat ? -- again, an ambiguity /FreeBSD/9/8/zfs ? not so bad, since the recent RE schedule, until: /FreeBSD/9/2/stat ? nope, won't do, either /FreeBSD/9/zfs ? Wait, that'd be zfs(9), not zfs from "FreeBSD 9"! So, it gets hairy rather quickly. :) ATM, none of the above are supported. Also, consider that this has to be mapped back to the options provided by man.cgi on FreeBSD.org, which only has "FreeBSD 9-current" as a single-digit-option, with all prior versions being two-number releases like "FreeBSD 4.8-RELEASE" (going back to "FreeBSD 1.0-RELEASE"), and a couple of "FreeBSD 9.1-stable" for only the latest release of the last couple of major versions, and going back to only "FreeBSD 6.4-stable" (which will probably soon itself be gone, too), so, I might have to maintain a separate mapping from "f4" to, say, "FreeBSD 4.11-RELEASE", and such fine-grained mappings is something I'd rather avoid, since the chain gets outdated fairly quickly. Also, how would you distinguish between the latest "-RELEASE" and "-stable"? Remember, this is a deterministic URL shortener, and I don't want it to become an "I'm Feeling Lucky"! :-) I want to make sure to have some realistic mappings, for FreeBSD and NetBSD, before adding any such features. OpenBSD, on the other hand, would be pretty easy, since every release is a two digit number, and DragonFly man-pages don't let you specify a release, so that's already supported. :-) Adding support for two-digit releases with a scheme like "/f91/" and "/FreeBSD-9.1/" is something that's very doable, but do you want to have to specify "/f63/" instead of a simpler (though more ambiguous) "/f6/"? What exactly is your usecase? Mapping between "f91" or "(FreeBSD|freebsd)-9.1" and "FreeBSD 9.1-RELEASE", with "9" and "1" representing all possible FreeBSD releases (except for subreleases like 5.2.1, or any releases before 4.0 in the abbreviated notation, e.g. to reserve "/f10/" for FreeBSD 10, instead of 1.0), should be very easy to add; would that be sufficient? Best regards, Constantine. > > I have to disagree with Darren Pilgrim however, this is not "slight abuse" > of rewrite rules but putting rewrite rules to "better use" :-) > > Kind regards, > > Paul Schenkeveld > From owner-freebsd-chat@FreeBSD.ORG Fri Feb 22 14:50:27 2013 Return-Path: Delivered-To: chat@freebsd.org Received: from mx1.freebsd.org (mx1.FreeBSD.org [8.8.178.115]) by hub.freebsd.org (Postfix) with ESMTP id 3A1B12D0 for ; Fri, 22 Feb 2013 14:50:27 +0000 (UTC) (envelope-from reed@reedmedia.net) Received: from c-0500.emailmediator.com (c-0500.emailmediator.com [64.85.162.118]) by mx1.freebsd.org (Postfix) with ESMTP id 1A7973F5 for ; Fri, 22 Feb 2013 14:50:26 +0000 (UTC) Received: from pool-173-74-104-132.dllstx.fios.verizon.net ([173.74.104.132] helo=reedmedia.net) by c-0500.emailmediator.com with esmtpa (Exim 4.69) (envelope-from ) id 1U8tYs-00029s-Ta for chat@freebsd.org; Fri, 22 Feb 2013 09:25:19 -0500 Received: from reed@reedmedia.net by reedmedia.net with local (mailout 0.17) id 22627-1361543118; Fri, 22 Feb 2013 08:25:19 -0600 Date: Fri, 22 Feb 2013 08:25:18 -0600 (CST) From: "Jeremy C. Reed" X-X-Sender: reed@t1.m.reedmedia.net To: chat@freebsd.org Subject: Re: including generated documentation with source In-Reply-To: <867gmdhnu9.fsf@ds4.des.no> Message-ID: References: <867gmdhnu9.fsf@ds4.des.no> User-Agent: Alpine 2.02 (NEB 1266 2009-07-14) MIME-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII X-BeenThere: freebsd-chat@freebsd.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: Non technical items related to the community List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 22 Feb 2013 14:50:27 -0000 On Tue, 12 Feb 2013, Dag-Erling Sm?rgrav wrote: > "Jeremy C. Reed" writes: > > I help maintain documentation (man pages, guides in html, pdf, and plain > > text, and api/developer docs in html). The original source of the docs > > is in docbook or doxygen. I'd prefer not to include the generated docs > > in the source tree (git repo) because slight differences in the > > documentation tool chains on each developer's system. But I also don't > > want the end-user to have to install all the many software dependencies > > for providing the documentation end results so I include them in my > > "make dist" tarballs. (I am using autoconf/automake framework.) > > Look at the OpenPAM source code, particularly > > http://www.openpam.org/browser/openpam/trunk/doc/man/Makefile.am > > Almost all of the man pages are generated at compile time. The use of > the "dist" prefix in Makefile.am ensures that they are included in the > distribution, even though they are not in the repo. Thank you for the examples. This is similar to what I already do, but has one advantage that I don't currently have: its source includes the generation tool (misc/gendoc.pl). What happens if a make clean is done and no perl is available to regenerate? I didn't try, but I think this is the same problem I currently have: we don't want to force our users to install xsltproc, docbook stylesheets or rest of our documentation toolchain. I received another suggestion about adding a doc/ directory that has the generated files. The generated docs would be in the tarball but not in the git repo. If the docs toolchain is installed and a configure switch is set, then the docs are generated and put into (or replaced in) the doc directory. A "distclean" wouldn't remove those files, an "install" would install from there. I think I have seen example of this before, but don't recall where. I may try this idea.