[patch] sln.8: wfix

[patch] sln.8: wfix

[Peter Lafreniere]

The description for the second form of sln(8) can be taken at a first
reading as saying that `filelist' is a list of paths passed via the
command line, when it is really a path to a file containing that list.

Although the confusion can be resolved from the surrounding context, it
is better to be explicit about filelist being a path.

Signed-off-by: Peter Lafreniere <peter@n8pjl.ca>
---
 man8/sln.8 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/man8/sln.8 b/man8/sln.8
index 448d0bf07..2a7ed13e5 100644
--- a/man8/sln.8
+++ b/man8/sln.8
@@ -29,7 +29,7 @@ as a new symbolic link to
 .PP
 In the second form,
 .I filelist
-is a list of space-separated pathname pairs,
+points to a list of space-separated pathname pairs,
 and the effect is as if
 .B sln
 was executed once for each line of the file,
-- 
2.42.0

Re: [patch] sln.8: wfix

[Štěpán Němec]

On Sat,  2 Sep 2023 19:04:58 -0400
Peter Lafreniere wrote:

> The description for the second form of sln(8) can be taken at a first
> reading as saying that `filelist' is a list of paths passed via the
> command line, when it is really a path to a file containing that list.
>
> Although the confusion can be resolved from the surrounding context, it
> is better to be explicit about filelist being a path.
>
> Signed-off-by: Peter Lafreniere <peter@n8pjl.ca>
> ---
>  man8/sln.8 | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/man8/sln.8 b/man8/sln.8
> index 448d0bf07..2a7ed13e5 100644
> --- a/man8/sln.8
> +++ b/man8/sln.8
> @@ -29,7 +29,7 @@ as a new symbolic link to
>  .PP
>  In the second form,
>  .I filelist
> -is a list of space-separated pathname pairs,
> +points to a list of space-separated pathname pairs,
>  and the effect is as if
>  .B sln
>  was executed once for each line of the file,

I find your version more confusing than the original (or rather, I
didn't really find the original confusing).

If you want to be explicit, why don't you say "names a file containing a
list of..."?

-- 
Štěpán

Re: [patch] sln.8: wfix

[Alejandro Colomar]

[-- Attachment #1.1: Type: text/plain, Size: 1372 bytes --]

On 2023-09-03 13:00, Štěpán Němec wrote:
> On Sat,  2 Sep 2023 19:04:58 -0400
> Peter Lafreniere wrote:
> 
>> The description for the second form of sln(8) can be taken at a first
>> reading as saying that `filelist' is a list of paths passed via the
>> command line, when it is really a path to a file containing that list.
>>
>> Although the confusion can be resolved from the surrounding context, it
>> is better to be explicit about filelist being a path.
>>
>> Signed-off-by: Peter Lafreniere <peter@n8pjl.ca>
>> ---
>>  man8/sln.8 | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/man8/sln.8 b/man8/sln.8
>> index 448d0bf07..2a7ed13e5 100644
>> --- a/man8/sln.8
>> +++ b/man8/sln.8
>> @@ -29,7 +29,7 @@ as a new symbolic link to
>>  .PP
>>  In the second form,
>>  .I filelist
>> -is a list of space-separated pathname pairs,
>> +points to a list of space-separated pathname pairs,
>>  and the effect is as if
>>  .B sln
>>  was executed once for each line of the file,
> 
> I find your version more confusing than the original (or rather, I
> didn't really find the original confusing).
> 
> If you want to be explicit, why don't you say "names a file containing a
> list of..."?

+1

> 

-- 
<http://www.alejandro-colomar.es/>
GPG key fingerprint: A9348594CE31283A826FBDD8D57633D441E25BB5


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]