bug#31725: Mysterious file in lispref manual's example(emacs-26.1)

bug#31725: Mysterious file in lispref manual's example(emacs-26.1)

[Takesi Ayanokoji]

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

Hi, Emacs developers.

In doc/lispref/files.texi: 1671-1674, example says about "foo1".

>>> start here
@group
(add-name-to-file "foo1" "foo3")
     @result{} nil
@end group
<<< end here

 But I could not find meaning of this file in this example's context.

Is this @group-block necessary?

Thanks.

ayatakesi <ayanokoji.takesi@gmail.com>

[-- Attachment #2: Type: text/html, Size: 893 bytes --]

bug#31725: Mysterious file in lispref manual's example(emacs-26.1)

[Eli Zaretskii]

> From: Takesi Ayanokoji <ayanokoji.takesi@gmail.com>
> Date: Wed, 6 Jun 2018 00:37:28 +0900
> 
> In doc/lispref/files.texi: 1671-1674, example says about "foo1".
> 
> >>> start here
> @group
> (add-name-to-file "foo1" "foo3")
>      @result{} nil
> @end group
> <<< end here
> 
>  But I could not find meaning of this file in this example's context.

It's just a file name.  It has no meaning beyond that.  the example
shows how to create a hard link to a file.

> Is this @group-block necessary? 

It prevents a multi-line example from being split between pages, see
the Texinfo manual for the details of @group.

Thanks.