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

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

[Tom de Vries]

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

Hi,

While generating gnat-style.info, we see these warnings:
...
src/gcc/doc/include/fdl.texi:33: warning: node `Index' is next for `GNU Free 
Documentation License' in menu but not in sectioning
src/gcc/doc/include/fdl.texi:33: warning: node `Top' is up for `GNU Free 
Documentation License' in menu but not in sectioning
...

Attached patch fixes these.

Ok for stage4?

Thanks,
- Tom

[-- Attachment #2: 0002-Fix-warnings-from-including-fdl.texi-into-gnat-style.patch --]
[-- Type: text/x-patch, Size: 1587 bytes --]

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 and @unnumberedsec GNU Free Documentation License locally.

---
 gcc/ada/gnat-style.texi  | 3 +++
 gcc/doc/include/fdl.texi | 2 ++
 2 files changed, 5 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..55aa498 100644
--- a/gcc/doc/include/fdl.texi
+++ b/gcc/doc/include/fdl.texi
@@ -30,9 +30,11 @@ of this license document, but changing it is not allowed.
 @end ifset
 @c man begin DESCRIPTION
 @ifclear gfdlhtml
+@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

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

[Arnaud Charlet]

> While generating gnat-style.info, we see these warnings:
> ...
> src/gcc/doc/include/fdl.texi:33: warning: node `Index' is next for
> `GNU Free Documentation License' in menu but not in sectioning
> src/gcc/doc/include/fdl.texi:33: warning: node `Top' is up for `GNU
> Free Documentation License' in menu but not in sectioning
> ...
> 
> Attached patch fixes these.
> 
> Ok for stage4?

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

Arno

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

[Tom de Vries]

On 22-02-15 18:37, Arnaud Charlet wrote:
>> While generating gnat-style.info, we see these warnings:
>> ...
>> src/gcc/doc/include/fdl.texi:33: warning: node `Index' is next for
>> `GNU Free Documentation License' in menu but not in sectioning
>> src/gcc/doc/include/fdl.texi:33: warning: node `Top' is up for `GNU
>> Free Documentation License' in menu but not in sectioning
>> ...
>>
>> Attached patch fixes these.
>>
>> Ok for stage4?
>
> The gnat-style.texi part is OK. I cannot approve the fdl part though.
>

Gerald,

Can you approve the fdl part?

Thanks,
- Tom

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

[Gerald Pfeifer]

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.

Gerald

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

[Tom de Vries]

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

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?

Thanks,
- Tom


[-- Attachment #2: 0001-Fix-warnings-from-including-fdl.texi-into-gnat-style.patch --]
[-- Type: text/x-patch, Size: 1992 bytes --]

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

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

[Tom de Vries]

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
>

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

[Arnaud Charlet]

The Ada part is ok.

Arno

> On 24 Aug 2015, at 11:16, Tom de Vries <Tom_deVries@mentor.com> wrote:
> 
>> 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
> 

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

[Tom de Vries]

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.
>

Gerald,

was the 'Okay' above:
- a figure of speech (as I read it), or
- an actual approval (conditional on the adding of the comment)
?

Thanks,
- Tom

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

[Gerald Pfeifer]

Hi Tom,

On Tue, 8 Dec 2015, Tom de Vries wrote:
>>> Can you approve the fdl part?
>> Let's assume I can.  Okay.
> was the 'Okay' above:
> - a figure of speech (as I read it), or
> - an actual approval (conditional on the adding of the comment)
> ?

I should have written this as "Let's assume I can: Okay." or
better "Let's assume I can. -> Okay."

Yes, please consider this approved.

Sorry if you have been waiting due to this!

Gerald

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

[Mike Stump]

On Dec 8, 2015, at 10:10 AM, Gerald Pfeifer <gerald@pfeifer.com> wrote:
> On Tue, 8 Dec 2015, Tom de Vries wrote:
>>>> Can you approve the fdl part?
>>> Let's assume I can.  Okay.
>> was the 'Okay' above:
>> - a figure of speech (as I read it), or
>> - an actual approval (conditional on the adding of the comment)
>> ?
> 
> I should have written this as "Let's assume I can: Okay." or
> better "Let's assume I can. -> Okay.”

Ok.  Is the canonical spelling.  :-)   [ ducks ]

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

[Tom de Vries]

On 08/12/15 19:10, Gerald Pfeifer wrote:
> Hi Tom,
>
> On Tue, 8 Dec 2015, Tom de Vries wrote:
>>>> Can you approve the fdl part?
>>> Let's assume I can.  Okay.
>> was the 'Okay' above:
>> - a figure of speech (as I read it), or
>> - an actual approval (conditional on the adding of the comment)
>> ?
>
> I should have written this as "Let's assume I can: Okay." or
> better "Let's assume I can. -> Okay."
>
> Yes, please consider this approved.
>
> Sorry if you have been waiting due to this!
>

Np :) , and thanks for the review.

- Tom