* [RFA/doco] Fix missing title in HTML documentation
@ 2009-11-07 18:34 Joel Brobecker
2009-11-07 19:38 ` Eli Zaretskii
0 siblings, 1 reply; 5+ messages in thread
From: Joel Brobecker @ 2009-11-07 18:34 UTC (permalink / raw)
To: gdb-patches
[-- 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
^ permalink raw reply [flat|nested] 5+ messages in thread* Re: [RFA/doco] Fix missing title in HTML documentation
2009-11-07 18:34 [RFA/doco] Fix missing title in HTML documentation Joel Brobecker
@ 2009-11-07 19:38 ` Eli Zaretskii
2009-11-07 19:42 ` Joel Brobecker
0 siblings, 1 reply; 5+ messages in thread
From: Eli Zaretskii @ 2009-11-07 19:38 UTC (permalink / raw)
To: Joel Brobecker; +Cc: gdb-patches
> Date: Sat, 7 Nov 2009 10:34:07 -0800
> From: Joel Brobecker <brobecker@adacore.com>
>
> 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?
OK, assuming that you ran all the other targets in doc/Makefile.in and
verified that there are no adverse effects.
Thanks.
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [RFA/doco] Fix missing title in HTML documentation
2009-11-07 19:38 ` Eli Zaretskii
@ 2009-11-07 19:42 ` Joel Brobecker
2009-11-07 19:46 ` Eli Zaretskii
0 siblings, 1 reply; 5+ messages in thread
From: Joel Brobecker @ 2009-11-07 19:42 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: gdb-patches
> OK, assuming that you ran all the other targets in doc/Makefile.in and
> verified that there are no adverse effects.
I did. But it becomes a lot harder to verify the differences for the
files other than HTML. The PDFs for instances are reported as binary
files, and so it's hard to get diffs. I just looked at the PDF, and
it looked fine. I ran all other targets (pdf, dvi, ps), and it ran
fine too.
Thanks,
--
Joel
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [RFA/doco] Fix missing title in HTML documentation
2009-11-07 19:42 ` Joel Brobecker
@ 2009-11-07 19:46 ` Eli Zaretskii
2009-11-07 19:52 ` Joel Brobecker
0 siblings, 1 reply; 5+ messages in thread
From: Eli Zaretskii @ 2009-11-07 19:46 UTC (permalink / raw)
To: Joel Brobecker; +Cc: gdb-patches
> Date: Sat, 7 Nov 2009 11:42:04 -0800
> From: Joel Brobecker <brobecker@adacore.com>
> Cc: gdb-patches@sourceware.org
>
> > OK, assuming that you ran all the other targets in doc/Makefile.in and
> > verified that there are no adverse effects.
>
> I did. But it becomes a lot harder to verify the differences for the
> files other than HTML. The PDFs for instances are reported as binary
> files, and so it's hard to get diffs. I just looked at the PDF, and
> it looked fine.
Info, HTML, and plain-text outputs can be compared with Diff. For the
rest, visual verification is fine with me.
Thanks.
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [RFA/doco] Fix missing title in HTML documentation
2009-11-07 19:46 ` Eli Zaretskii
@ 2009-11-07 19:52 ` Joel Brobecker
0 siblings, 0 replies; 5+ messages in thread
From: Joel Brobecker @ 2009-11-07 19:52 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: gdb-patches
> Info, HTML, and plain-text outputs can be compared with Diff. For the
> rest, visual verification is fine with me.
OK, there was no plain-text target, but I cheated by passing
MAKEHTMLFLAGS=--plaintext. On all 3 targets, the only target where
there were differences is the HTML, and I had already verified that
the differences where the desired ones.
Patch now checked in.
--
Joel
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2009-11-07 19:52 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2009-11-07 18:34 [RFA/doco] Fix missing title in HTML documentation Joel Brobecker
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
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox