From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mailman by lists.gnu.org with archive (Exim 4.33) id 1BdcHv-0005uA-BC for mharc-grub-devel@gnu.org; Thu, 24 Jun 2004 18:01:43 -0400 Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.33) id 1BdcHt-0005u4-O7 for grub-devel@gnu.org; Thu, 24 Jun 2004 18:01:41 -0400 Received: from exim by lists.gnu.org with spam-scanned (Exim 4.33) id 1BdcHq-0005tW-8w for grub-devel@gnu.org; Thu, 24 Jun 2004 18:01:41 -0400 Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.33) id 1BdcHq-0005tT-6h for grub-devel@gnu.org; Thu, 24 Jun 2004 18:01:38 -0400 Received: from [212.43.237.68] (helo=kotoba.storever.com) by monty-python.gnu.org with esmtp (Exim 4.34) id 1BdcG2-0002kf-Au for grub-devel@gnu.org; Thu, 24 Jun 2004 17:59:46 -0400 Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by kotoba.storever.com (Postfix) with ESMTP id B4EAEF0D47A1 for ; Thu, 24 Jun 2004 17:59:45 -0400 (EDT) From: "Yoshinori K. Okuji" Organization: enbug.org To: The development of GRUB 2 Date: Fri, 25 Jun 2004 00:03:53 +0200 User-Agent: KMail/1.6.1 References: <20040624171029.GA19940@artax.karlin.mff.cuni.cz> In-Reply-To: <20040624171029.GA19940@artax.karlin.mff.cuni.cz> MIME-Version: 1.0 Content-Disposition: inline Content-Type: text/plain; charset="iso-8859-1" Content-Transfer-Encoding: 7bit Message-Id: <200406250003.53439.okuji@enbug.org> Subject: Re: Documentation. X-BeenThere: grub-devel@gnu.org X-Mailman-Version: 2.1.4 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: Thu, 24 Jun 2004 22:01:41 -0000 On Thursday 24 June 2004 19:10, Tomas Ebenlendr wrote: > So here is the question: what format? (and what names?). Use plain text. It's good enough for this purpose. If you need a more complex one, use texinfo. Texinfo is the standard documentation tool for GNU, and many GNU programmers are used to it. Regardless of whatever tool you use, the most important thing in documentation is "not to make it out of dated". This is really difficult. Indeed, I gave up keeping information on internals of GRUB Legacy in the manual. Maintaining good documentation costs the same as maintaining good code. So, I'd recommend that you keep your documentation as simple as you can. Okuji