From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 11301 invoked by alias); 16 Oct 2013 21:41:02 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Received: (qmail 11291 invoked by uid 89); 16 Oct 2013 21:41:02 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-2.4 required=5.0 tests=AWL,BAYES_00,RP_MATCHES_RCVD,SPF_HELO_PASS,SPF_PASS autolearn=ham version=3.3.2 X-HELO: mx1.redhat.com Received: from mx1.redhat.com (HELO mx1.redhat.com) (209.132.183.28) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Wed, 16 Oct 2013 21:41:01 +0000 Received: from int-mx02.intmail.prod.int.phx2.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) by mx1.redhat.com (8.14.4/8.14.4) with ESMTP id r9GLdIvU008455 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Wed, 16 Oct 2013 17:39:18 -0400 Received: from [127.0.0.1] (ovpn01.gateway.prod.ext.ams2.redhat.com [10.39.146.11]) by int-mx02.intmail.prod.int.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id r9GLdF2o003789; Wed, 16 Oct 2013 17:39:16 -0400 Message-ID: <525F0783.5000907@redhat.com> Date: Wed, 16 Oct 2013 21:41:00 -0000 From: Pedro Alves User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:17.0) Gecko/20130625 Thunderbird/17.0.7 MIME-Version: 1.0 To: Paul_Koning@Dell.com CC: eliz@gnu.org, dje@google.com, gdb-patches@sourceware.org, stan@codesourcery.com Subject: Re: gdb.texinfo is getting too big References: <83ob6rpqa5.fsf@gnu.org> <83mwmbp80v.fsf@gnu.org> <83zjq9nipu.fsf@gnu.org> <525EEE89.9060907@redhat.com> <83txghnfpe.fsf@gnu.org> In-Reply-To: Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: 7bit X-SW-Source: 2013-10/txt/msg00503.txt.bz2 On 10/16/2013 09:10 PM, Paul_Koning@Dell.com wrote: > > On Oct 16, 2013, at 4:06 PM, Eli Zaretskii wrote: > >>> Date: Wed, 16 Oct 2013 20:52:41 +0100 >>> From: Pedro Alves >>> CC: Doug Evans , gdb-patches@sourceware.org, >>> stan@codesourcery.com >>> >>> Maybe it'd be easier to think in terms of things that would make >>> sense to split out of the main file. E.g., the RSP chapter is useful >>> for GDB and stub developers, but not for regular users -- split that >>> one out. Python scripting API stuff is useful for advanced users >>> that want to extend GDB, but it's not really the same class of manual >>> as the other chapters, so split that one out as another file too. >>> MI is useful for frontend writers, not for regular users, so out it >>> goes too. Whatever other identifiable logic units we find, split >>> them out. Then I suspect we'll end up with the core manual for >>> regular users that describes GDB's main features/CLI/commands, >>> and it'll be lean enough to be manageable. >> >> You are talking about splitting the manual, whereas Doug was talking >> about splitting the sources while keeping a single manual as output. >> >> I'm not sure I see a good reason to split the manual. For starters, >> the size of that doesn't hurt as much as the size of the source file >> when you need to edit it. > > Agreed. There are plenty of examples of large manuals (GCC, GCCint, Emacs). Divide them into as many source files as is convenient, that doesn't bother any user. But having the manual (what users read) split into multiple parts is not a good change. > > If we ever hit 5000 pages I might change my tune, but no GDB documentation is even close to that big. I was not suggesting to split the resulting produced manual. Sorry if I wasn't clear. I guess I should have said "core file" where it reads "core manual". I don't see a need to for a user visible split either. My response was in response to "The worry I have with any kind of grouping not based on the doc itself is that it introduces a potentially non-intuitive layer that someone has to learn in order to know which file contains the text one wants to edit." and I was presenting a rationale for splitting around logical grouping units. -- Pedro Alves