Received: from list by lists.gnu.org with archive (Exim 4.90_1) id 1jP6bh-0006id-6W for mharc-grub-devel@gnu.org; Thu, 16 Apr 2020 11:39:13 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:51478) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jP6be-0006hu-Jk for grub-devel@gnu.org; Thu, 16 Apr 2020 11:39:11 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1jP6bd-0003Bd-BG for grub-devel@gnu.org; Thu, 16 Apr 2020 11:39:10 -0400 Received: from mailout01.mx.bawue.net ([193.7.176.62]:35056) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1jP6bd-0003B1-1L for grub-devel@gnu.org; Thu, 16 Apr 2020 11:39:09 -0400 Received: from infty.fritz.box (p5B0825D9.dip0.t-ipconnect.de [91.8.37.217]) (Authenticated sender: pdim@bawue.de) by smtp.bawue.net (Postfix) with ESMTPSA id E8F192047F for ; Thu, 16 Apr 2020 17:39:03 +0200 (CEST) Date: Thu, 16 Apr 2020 17:39:02 +0200 From: Hans Ulrich Niedermann To: grub-devel@gnu.org Subject: Re: [PATCH 0/1] docs: Fix numerous minor mistakes in grub.info Message-ID: <20200416173902.02e3ddf3@infty.fritz.box> In-Reply-To: <20200416142702.gnocfs5rfmsfru25@tomti.i.net-space.pl> References: <20200416130344.182637-1-hun@n-dimensional.de> <20200416142702.gnocfs5rfmsfru25@tomti.i.net-space.pl> X-Mailer: Claws Mail 3.17.5 (GTK+ 2.24.32; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit X-Virus-Scanner: SAV Dynamic Interface 2.6.0, Engine: 3.77.1, SAV: 5.74 (23A484EE) on relay01.mx.bawue.net using milter-sssp 0.1.0 X-Virus-Scan: Found to be clean. X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 193.7.176.62 X-BeenThere: grub-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: The development of GNU GRUB List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 16 Apr 2020 15:39:11 -0000 On Thu, 16 Apr 2020 16:27:02 +0200 Daniel Kiper wrote: > On Thu, Apr 16, 2020 at 03:03:43PM +0200, Hans Ulrich Niedermann > wrote: > > This patch does not change the intended meaning of the text > > and only touches about the first 1300 of about 7000 lines > > in docs/grub.texi. If there is interest in picking up this > > patch, I intend to read through the rest of grub.texi as > > well to find more of these easy fixes while adding remarks > > for bigger issues which require actual text changes. > > > > Then, I can start (with some help) addressing the issues > > pointed to by these remarks like undocumented commands, > > renamed commands, wrong and outdated instructions, remarks > > about a future which has become present a long time ago, etc. > > It sounds like very interesting project! Nice to hear that you are > taking a stab at it. I have a few comments. > First of all, I will ask > a few native speakers to make a review of your work. While I have noticed and fixed a number of mistakes non-native speakers make relatively frequently (such as the missing articles). However, I am *not* a native speaker myself and will doubtlessly make some mistakes of my own. My goal is for the text to contain fewer mistakes after my changes, while hoping for zero. > Then I want to > ask you to continue your work on docs/grub.texi. docs/grub.texi is what I want to start with. > If you want to go > deeper in this I would like to ask you to take a look at additional > documents like docs/grub-dev.texi or Multiboot and Multiboot2 > specifications (you can find both of them in multiboot and multiboot > branches of the GRUB git repository). I already have multiboot and multiboot2 in my sights, as writing a bit of an example kernel for multiboot and multiboot2 is what made me notice the current deficiencies in grub.texi (such as missing documentation for @command{module2}). Regarding grub-dev.texi, I would not have the faintest idea about what to change there apart from simple language fixes. grub-dev.texi looks to me to be very much something to be written by the core maintainers, describing what they want. I am really new to grub development, so I have no idea whatsoever about that. Being a grub user for a decade going on two does not help here at all. > Of course I would prefer if you > work on one document at a time. This should ease our cooperation. It should also ease the load on my brain. > Last but not least, some lines in these documents are very long. I > would like to have them wrapped at around 80th column to ease > reading. If you could do that in separate patch that would be > perfect. I think that this should be last step in doing docs cleanups. I'll try to remember that for the last patch. > ...and if you could finish this work, at least for docs/grub.texi and > docs/grub-dev.texi, before the 2.06 release that would be fantastic... I have no idea what the grub release schedule is, what "2.06 release" might mean when translated to a calendar date (2020-05-01? some time in autumn 2020? some time in 2021?), and when and what a next release might be. However, I am certain this will take a few weeks at the very least to finish. Uli