From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mailman by lists.gnu.org with archive (Exim 4.43) id 1HvctV-0001cL-GP for mharc-grub-devel@gnu.org; Tue, 05 Jun 2007 13:32:33 -0400 Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1HvctT-0001bd-DS for grub-devel@gnu.org; Tue, 05 Jun 2007 13:32:31 -0400 Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1HvctR-0001Zd-Gq for grub-devel@gnu.org; Tue, 05 Jun 2007 13:32:31 -0400 Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1HvctR-0001ZH-Bc for grub-devel@gnu.org; Tue, 05 Jun 2007 13:32:29 -0400 Received: from 245.red-80-24-127.staticip.rima-tde.net ([80.24.127.245] helo=manazas.ensanjose.net) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1HvctQ-0001Qt-CD for grub-devel@gnu.org; Tue, 05 Jun 2007 13:32:28 -0400 Received: from localhost (manazas.ensanjose.net [127.0.0.1]) by manazas.ensanjose.net (Postfix) with ESMTP id 7D28AD32AE for ; Tue, 5 Jun 2007 19:32:26 +0200 (CEST) Received: from manazas.ensanjose.net ([127.0.0.1]) by localhost (manazas.ensanjose.net [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 07911-03 for ; Tue, 5 Jun 2007 19:32:26 +0200 (CEST) Received: from [192.168.1.8] (163.Red-83-34-181.dynamicIP.rima-tde.net [83.34.181.163]) by manazas.ensanjose.net (Postfix) with ESMTP id 30B5FD321B for ; Tue, 5 Jun 2007 19:32:26 +0200 (CEST) Message-ID: <46659E28.6030304@raulete.net> Date: Tue, 05 Jun 2007 19:32:24 +0200 From: adrian15 User-Agent: Mozilla Thunderbird 1.0.7 (Windows/20050923) X-Accept-Language: en-us, en MIME-Version: 1.0 To: grub-devel@gnu.org References: <200706041604.l54G4p0v029961@correoredir01.dinaserver.com> In-Reply-To: <200706041604.l54G4p0v029961@correoredir01.dinaserver.com> Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit X-detected-kernel: Linux 2.4-2.6 Subject: Re: gcs doubt #1 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: Tue, 05 Jun 2007 17:32:31 -0000 >> > Please put a comment on each function saying what the function does, >> > what sorts of arguments it gets, and what the possible values of >> > arguments mean and are used for. >> > >> > Is it ok that the search.c and test.c (commands/ folder) do not have any >> > of these comments at all? > > The currect test.c is a dummy so the `if' expression can be > used/tested. > > If you can provide a patch for sourcecode to improve or add comments > in a sane way, I am willing to commit those patches. Just please > don't make the mistake to add useless comments. An useful comment is one that: -Describes a function algorithm -Describes what a function does (as a black box) -Boot of them ? adrian15