This is the mail archive of the gcc-patches@gcc.gnu.org mailing list for the GCC 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]

[PING][PATCH] Fix warnings from including fdl.texi into gnat-style.texi

From: Tom de Vries <Tom_deVries at mentor dot com>
To: Gerald Pfeifer <gerald at pfeifer dot com>
Cc: Arnaud Charlet <charlet at adacore dot com>, GCC Patches <gcc-patches at gcc dot gnu dot org>
Date: Mon, 24 Aug 2015 17:16:51 +0200
Subject: [PING][PATCH] Fix warnings from including fdl.texi into gnat-style.texi
Authentication-results: sourceware.org; auth=none
References: <54E9F4D2 dot 9050504 at mentor dot com> <20150222173714 dot GA3798 at adacore dot com> <550BF22A dot 4060003 at mentor dot com> <alpine dot LSU dot 2 dot 11 dot 1503231556580 dot 15042 at tuna dot site> <557D8A99 dot 8000705 at mentor dot com>

On 14-06-15 16:07, Tom de Vries wrote:

On 23/03/15 16:00, Gerald Pfeifer wrote:

On Fri, 20 Mar 2015, Tom de Vries wrote:

The gnat-style.texi part is OK. I cannot approve the fdl part though.

Gerald,

Can you approve the fdl part?


Let's assume I can.  Okay.

Can you just describe the _why_ a bit in a @comment (in simple
words beyond showing the error message), that is, what the issue
is and how you avoid it?  That should help someone coming in
later, trying to understand.


Patch updated with comment.

OK for trunk?


Ping.

Original submission at https://gcc.gnu.org/ml/gcc-patches/2015-06/msg00975.html .

Thanks,
- Tom



0001-Fix-warnings-from-including-fdl.texi-into-gnat-style.patch


Fix warnings from including fdl.texi into gnat-style.texi

2015-02-22  Tom de Vries<tom@codesourcery.com>

	PR ada/65102
	* doc/include/fdl.texi: Add nodefaultgnufreedocumentationlicensenode
	ifdef to allow disabling default @node GNU Free Documentation License.

	* gnat-style.texi: Set nodefaultgnufreedocumentationlicensenode and
	define @node GNU Free Documentation License locally.
---
  gcc/ada/gnat-style.texi  | 3 +++
  gcc/doc/include/fdl.texi | 7 +++++++
  2 files changed, 10 insertions(+)

diff --git a/gcc/ada/gnat-style.texi b/gcc/ada/gnat-style.texi
index 1fa7688..50adaab 100644
--- a/gcc/ada/gnat-style.texi
+++ b/gcc/ada/gnat-style.texi
@@ -937,6 +937,9 @@ except that they are all lower case.
  @c **********************************
  @c * GNU Free Documentation License *
  @c **********************************
+@node GNU Free Documentation License,Index, Program Structure, Top
+@unnumberedsec GNU Free Documentation License
+@set nodefaultgnufreedocumentationlicensenode
  @include fdl.texi
  @c GNU Free Documentation License
  @cindex GNU Free Documentation License
diff --git a/gcc/doc/include/fdl.texi b/gcc/doc/include/fdl.texi
index 8f3d7be..4e3457f 100644
--- a/gcc/doc/include/fdl.texi
+++ b/gcc/doc/include/fdl.texi
@@ -30,9 +30,16 @@ of this license document, but changing it is not allowed.
  @end ifset
  @c man begin DESCRIPTION
  @ifclear gfdlhtml
+@comment For some cases, this default @node/@unnumbered is not applicable and
+@comment causes warnings.  In those cases, the including file can set
+@comment nodefaultgnufreedocumentationlicensenode and provide it's own version.
+@comment F.i., when this file is included in an @raisesections context, the
+@comment including file can use an @unnumberedsec.
+@ifclear nodefaultgnufreedocumentationlicensenode
  @node GNU Free Documentation License
  @unnumbered GNU Free Documentation License
  @end ifclear
+@end ifclear

  @cindex FDL, GNU Free Documentation License
  @center Version 1.3, 3 November 2008
-- 1.9.1

Follow-Ups:
- Re: [PING][PATCH] Fix warnings from including fdl.texi into gnat-style.texi
  - From: Arnaud Charlet

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