[PATCH] doc: Remove @code wrapping of fortran option names [PR116801]

Mikael Morin morin-mikael@orange.fr
Mon Sep 23 08:20:51 GMT 2024


Le 23/09/2024 à 00:01, Andreas Schwab a écrit :
> On Sep 22 2024, Arsen Arsenović wrote:
> 
>> Andreas Schwab <schwab@linux-m68k.org> writes:
>>
>>> On Sep 22 2024, Jakub Jelinek wrote:
>>>
>>>> On Sun, Sep 22, 2024 at 10:52:37PM +0200, Andreas Schwab wrote:
>>>>> On Sep 22 2024, Mikael Morin wrote:
>>>>>
>>>>>> @@ -370,7 +370,7 @@ Set the default accessibility of module entities to @code{PRIVATE}.
>>>>>>   Use-associated entities will not be accessible unless they are explicitly
>>>>>>   declared as @code{PUBLIC}.
>>>>>>   
>>>>>> -@opindex @code{ffixed-line-length-}@var{n}
>>>>>> +@opindex ffixed-line-length-@var{n}
>>>>>
>>>>> Shouldn't all the @var{...} parts be dropped as well, throughout?
>>>>
>>>> We have it all over the other manuals:
>>>
>>> But it causes them to not show up in the urls files.
>>
>> That seems like a defect of the regen script rather than of the manuals.
>> They're there for a reason (signifying that something is not a fixed
>> string).
> 
> It's only about the @opindex.  The vast majority have those variable
> parts removed from the index entry.
> 
For options where the variable is not a separate argument, I think it's 
preferable to keep the variable.

For example, -ffree-line-length-@var{n} looks better on the index page 
as "-ffree-line-length-n" (with the n having a different formatting), 
than as "-free-line-length-".  It makes it clear that there is a suffix 
to the option.


More information about the Fortran mailing list