From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 18772 invoked by alias); 9 Nov 2009 17:33:23 -0000 Received: (qmail 18763 invoked by uid 22791); 9 Nov 2009 17:33:23 -0000 X-SWARE-Spam-Status: No, hits=-2.5 required=5.0 tests=AWL,BAYES_00 X-Spam-Check-By: sourceware.org Received: from rock.gnat.com (HELO rock.gnat.com) (205.232.38.15) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Mon, 09 Nov 2009 17:33:20 +0000 Received: from localhost (localhost.localdomain [127.0.0.1]) by filtered-rock.gnat.com (Postfix) with ESMTP id B38FA2BAC4F for ; Mon, 9 Nov 2009 12:33:18 -0500 (EST) Received: from rock.gnat.com ([127.0.0.1]) by localhost (rock.gnat.com [127.0.0.1]) (amavisd-new, port 10024) with LMTP id nzT+0GZzee2v for ; Mon, 9 Nov 2009 12:33:18 -0500 (EST) Received: from joel.gnat.com (localhost.localdomain [127.0.0.1]) by rock.gnat.com (Postfix) with ESMTP id 7690D2BAC4E for ; Mon, 9 Nov 2009 12:33:18 -0500 (EST) Received: by joel.gnat.com (Postfix, from userid 1000) id 1FD3FF5905; Mon, 9 Nov 2009 09:33:00 -0800 (PST) Date: Mon, 09 Nov 2009 18:48:00 -0000 From: Joel Brobecker To: gdb@sourceware.org Subject: updates on the GDB online documentation Message-ID: <20091109173300.GQ22192@adacore.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.5.18 (2008-05-17) Mailing-List: contact gdb-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-owner@sourceware.org X-SW-Source: 2009-11/txt/msg00094.txt.bz2 Hello everyone, I am planning on committing a change that will have a slight effect on the way the HTML version of the GDB documentation is generated. Without going into too many details, the standard way of building the HTML documentation is by using makeinfo. But for some reason, we generate the documentation on our website using texi2html. Doug Evans remarked that one of the issues with the texi2html is that it uses numbers in its URLs, making the URLs unstable over time. For instance: http://www.sourceware.org/gdb/current/onlinedocs/gdb_5.html#SEC21 Switching back to using makeinfo will improve the situation, as the HTML files are now named using the node name, or the chapter/name section (not sure which): Automatic-Overlay-Debugging.html I will try to commit this change tomorrow. Regarding the lack of index/table-of-contents in the GDB documentation, it looks like an issue with the texinfo tools on the machine where the documentation is generated. I sent an email to overseers about that. Hopefully we'll get to the bottom of this. A couple of separate issues, that can be handled independenly: 1. I think that the way the online documentation is organized is confusing. More precisely, I find the location of the documentation to be confusing. HEAD docs -> gdb/current/onlinedocs BRANCH docs -> gdb/onlinedocs RELEASE docs -> download/onlinedocs How about a different organization, something like this: HEAD docs -> onlinedocs/current or onlinedocs/head BRANCH docs -> onlinedocs/branch RELEASE docs -> onlinedocs/release or onlinedocs/released or onlinedocs/last-release I don't think that the name of the directory where the docs are stored is extrement important, as long as the text that leads to them is. 2. That brings me to my next topic: Actually, I'll discuss that separately, as I think it will need a little bit of dicussion. I don't want to mix everything too much. -- Joel