From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mailman by lists.gnu.org with archive (Exim 4.43) id 1KUFol-0004K1-0b for mharc-grub-devel@gnu.org; Sat, 16 Aug 2008 03:03:19 -0400 Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1KUFoi-0004Jg-3B for grub-devel@gnu.org; Sat, 16 Aug 2008 03:03:16 -0400 Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1KUFof-0004JR-Lq for grub-devel@gnu.org; Sat, 16 Aug 2008 03:03:14 -0400 Received: from [199.232.76.173] (port=40734 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1KUFof-0004JO-GZ for grub-devel@gnu.org; Sat, 16 Aug 2008 03:03:13 -0400 Received: from mx20.gnu.org ([199.232.41.8]:45630) by monty-python.gnu.org with esmtps (TLS-1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1KUFof-00006X-1h for grub-devel@gnu.org; Sat, 16 Aug 2008 03:03:13 -0400 Received: from mta-out.inet.fi ([195.156.147.13] helo=jenni2.inet.fi) by mx20.gnu.org with esmtp (Exim 4.60) (envelope-from ) id 1KUFod-00019S-8R for grub-devel@gnu.org; Sat, 16 Aug 2008 03:03:11 -0400 Received: from [127.0.0.1] (88.193.32.97) by jenni2.inet.fi (8.5.014) id 489066C500AEEC31 for grub-devel@gnu.org; Sat, 16 Aug 2008 10:03:06 +0300 Message-ID: <48A67BB3.3020403@nic.fi> Date: Sat, 16 Aug 2008 10:03:15 +0300 From: =?UTF-8?B?VmVzYSBKw6TDpHNrZWzDpGluZW4=?= User-Agent: Thunderbird 2.0.0.16 (Windows/20080708) MIME-Version: 1.0 To: The development of GRUB 2 References: <1218684975.8757.139.camel@localhost> <48A4589D.3040902@nic.fi> <20080814180005.GB5614@thorin> <1218749362.19647.20.camel@localhost> <48A5AF50.2040906@nic.fi> <1218819798.2510.13.camel@localhost> <48A5B96D.7040209@nic.fi> <1218823154.2510.23.camel@localhost> <48A5CC71.3020508@nic.fi> <1218827894.2510.51.camel@localhost> <48A6057C.6010704@isaac.cedarswampstudios.org> In-Reply-To: <48A6057C.6010704@isaac.cedarswampstudios.org> X-Enigmail-Version: 0.95.7 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit X-detected-kernel: by mx20.gnu.org: Linux 2.6 (newer, 3) X-detected-kernel: by monty-python.gnu.org: Linux 2.6, seldom 2.4 (older, 4) Subject: Re: [RFC] Platform information services X-BeenThere: grub-devel@gnu.org X-Mailman-Version: 2.1.5 Precedence: list Reply-To: The development of GRUB 2 List-Id: The development of GRUB 2 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 16 Aug 2008 07:03:16 -0000 Isaac Dupree wrote: > if you rely on a property of the kernel, you should document it > somewhere in the kernel, and document everyone (hopefully) who relies on > that property; or the users could have some symbol in the source that > you can search for. It doesn't have to be a function that takes up any > actual kernel disk-space. Function name is kinda good symbol. Magic numbers without defines are not used really on GRUB 2 code base, if they are then there is omission and that should be fixed. Every good editor allows you to allow fast walking on source code based on symbols. But I am against documenting into kernel who use what. It is doomed to be outdated easily and that information is easily available when using decent editor. Of course you should document what code does.