This is the mail archive of the mailing list for the GDB project.

Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: gdb.texinfo is getting too big

On Wed, Oct 16, 2013 at 2:39 PM, Pedro Alves <> wrote:
> On 10/16/2013 09:10 PM, 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 <>,,
>>>> 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.

If people are ok with logical grouping units it's fine with me.
One fear I have is a protracted discussion on the groupings.

I do like the idea of splitting out pieces that are easy to split out.
  E.g., RSP, Python, maybe a few others.

How about starting with that?

Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]