From owner-cvs-all@FreeBSD.ORG Sun May 28 02:14:11 2006 Return-Path: X-Original-To: cvs-all@freebsd.org Delivered-To: cvs-all@freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 4A0D316AB96 for ; Sun, 28 May 2006 02:06:16 +0000 (UTC) (envelope-from minimarmot@gmail.com) Received: from ug-out-1314.google.com (ug-out-1314.google.com [66.249.92.168]) by mx1.FreeBSD.org (Postfix) with ESMTP id B6BA143D6E for ; Sun, 28 May 2006 02:06:09 +0000 (GMT) (envelope-from minimarmot@gmail.com) Received: by ug-out-1314.google.com with SMTP id m3so50093uge for ; Sat, 27 May 2006 19:06:08 -0700 (PDT) DomainKey-Signature: a=rsa-sha1; q=dns; c=nofws; s=beta; d=gmail.com; h=received:message-id:date:from:to:subject:cc:in-reply-to:mime-version:content-type:content-transfer-encoding:content-disposition:references; b=od/cYLwbNHBdq5KMbFzFYWA1sbdxktlRp9dcSJJP0usXn/0FOs4DU+qnJs+iL9QFNUZaFsEbbEkItZiZRUO82KUdrn5aFgjWekIqHo+iCji8wGJwUqSjJSVG96vG7WNFU0CKKFG7vl+26gfjbMgxHg08avjyQh4awQ5cDysXO5c= Received: by 10.66.216.20 with SMTP id o20mr747212ugg; Sat, 27 May 2006 19:06:08 -0700 (PDT) Received: by 10.67.87.3 with HTTP; Sat, 27 May 2006 19:06:08 -0700 (PDT) Message-ID: <47d0403c0605271906r5a618490k750c85d5a148150@mail.gmail.com> Date: Sat, 27 May 2006 21:06:08 -0500 From: "Ben Kaduk" To: "Alexander Leidinger" In-Reply-To: <20060527190751.3628e119@Magellan.Leidinger.net> MIME-Version: 1.0 Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: quoted-printable Content-Disposition: inline References: <20060527104539.1f4c0738@Magellan.Leidinger.net> <13817.1148720224@critter.freebsd.dk> <20060527123344.355119b8@Magellan.Leidinger.net> <47d0403c0605270827n665ccd5ved9ba0effccf248b@mail.gmail.com> <20060527190751.3628e119@Magellan.Leidinger.net> Cc: cvs-src@freebsd.org, Poul-Henning Kamp , src-committers@freebsd.org, cvs-all@freebsd.org Subject: Re: cvs commit: src/sys/doc/subsys Dependencies Doxyfile-cam Doxyfile-crypto Doxyfile-dev_pci Doxyfile-dev_sound Doxyfile-dev_usb Doxyfile-geom Doxyfile-i4b Doxyfile-kern Doxyfile-libkern Doxyfile-linux Doxyfile-net80211 ... X-BeenThere: cvs-all@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: CVS commit messages for the entire tree List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 28 May 2006 02:14:23 -0000 On 5/27/06, Alexander Leidinger wrote: > Quoting "Ben Kaduk" (Sat, 27 May 2006 10:27:05 -05= 00): > > > > At http://www.leidinger.net/FreeBSD/doxygen_notreviewed.png I have a > > > screenshot of the the index page of the HTML documentation. It shows > > > the following text in a very prominent position: > > > ---snip--- > > > > I have a few comments about the wording of this disclaimer. > > > > > > > IMPORTANT: This API documentation may contain functions which are > > > either public or for internal use only. Since we have not reviewed > > > > Do you mean "not public" here? > > No. I want to say that we not only have public function there, but also > functions for internal use only. I don't know if this is needed. It's > also ok for me if someone changes this disclaimer completely. Probably the phrase "this API documentation may contain both functions which are public and functions that are for internal use only" will better express this sentiment. > [snip] > > Thanks for putting in the work to generate Doxygen documentation. I > > am just starting to read the kernel code, and I feel that the call > > graphs, etc. that it generates will be quite helpful. > > And the HTML version is even better to browse than the PDF version I > have on my website. > > Bye, > Alexander. > > -- > Selling GoodYear Eagle F1 235/40ZR18, 2x 4mm + 2x 5mm, ~150 EUR > you have to pick it up between Germany/Saarland and Luxembourg/Capellen > http://www.Leidinger.net Alexander @ Leidinger.net: PGP ID =3D B0063FE= 7 > http://www.FreeBSD.org netchild @ FreeBSD.org : PGP ID =3D 7207713= 7 > That is true -- html is more friendly to switching back and forth. I think I will follow the discussion in this thread and perhaps make further suggestions to the disclaimer as necessary. -Ben Kaduk