Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Joel Brobecker <brobecker@adacore.com>
To: gdb-patches@sourceware.org
Subject: [RFA/doco] Fix missing title in HTML documentation
Date: Sat, 07 Nov 2009 18:34:00 -0000	[thread overview]
Message-ID: <20091107183407.GN4557@adacore.com> (raw)

[-- Attachment #1: Type: text/plain, Size: 653 bytes --]

I noticed this while working on cleaning up the nightly generation
of the documention on the GDB web site: The gdbint and stabs manuals
get an "Untitled" title. For instance, gdbint/index.html:

    <html lang="en">
    <head>
    <title>Untitled</title>
    <meta http-equiv="Content-Type" content="text/html">
    <meta name="description" content="Untitled">

The attached patch should fix this, while making it consistent with
the order of directives used in other manuals such as gdb.texinfo.
Tested by regenerating the HTML documentation and verifying the
differences (a lot of Untitled get changed appropriately).

OK to commit?

Thanks,
-- 
Joel

[-- Attachment #2: doco.diff --]
[-- Type: text/x-diff, Size: 1478 bytes --]

commit 408ff8efa0824aa1c89bd73855bf73cecb92db2e
Author: Joel Brobecker <brobecker@adacore.com>
Date:   Sat Nov 7 10:27:34 2009 -0800

    2009-11-07  Joel Brobecker  <brobecker@adacore.com>
    
         * gdbint.texinfo, stabs.texinfo: Move the @setchapternewpage
         and @settitle directives up to help makeinfo find them.

diff --git a/gdb/doc/gdbint.texinfo b/gdb/doc/gdbint.texinfo
index 0255c02..dbe1197 100644
--- a/gdb/doc/gdbint.texinfo
+++ b/gdb/doc/gdbint.texinfo
@@ -1,6 +1,8 @@
 \input texinfo   @c -*- texinfo -*-
 @setfilename gdbint.info
 @include gdb-cfg.texi
+@settitle @value{GDBN} Internals
+@setchapternewpage off
 @dircategory Software development
 @direntry
 * Gdb-Internals: (gdbint).	The GNU debugger's internals.
@@ -27,8 +29,6 @@ This file documents the internals of the GNU debugger @value{GDBN}.
 @insertcopying
 @end ifnottex
 
-@setchapternewpage off
-@settitle @value{GDBN} Internals
 
 @syncodeindex fn cp
 @syncodeindex vr cp
diff --git a/gdb/doc/stabs.texinfo b/gdb/doc/stabs.texinfo
index d28c93d..187232f 100644
--- a/gdb/doc/stabs.texinfo
+++ b/gdb/doc/stabs.texinfo
@@ -1,5 +1,7 @@
 \input texinfo
 @setfilename stabs.info
+@setchapternewpage odd
+@settitle STABS
 
 @c @finalout
 
@@ -30,8 +32,6 @@ This document describes the stabs debugging symbol tables.
 @insertcopying
 @end ifnottex
 
-@setchapternewpage odd
-@settitle STABS
 @titlepage
 @title The ``stabs'' debug format
 @author Julia Menapace, Jim Kingdon, David MacKenzie

             reply	other threads:[~2009-11-07 18:34 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-11-07 18:34 Joel Brobecker [this message]
2009-11-07 19:38 ` Eli Zaretskii
2009-11-07 19:42   ` Joel Brobecker
2009-11-07 19:46     ` Eli Zaretskii
2009-11-07 19:52       ` Joel Brobecker

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20091107183407.GN4557@adacore.com \
    --to=brobecker@adacore.com \
    --cc=gdb-patches@sourceware.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox