[PATCH] sindex.1: Use ' for a plain quote char

[PATCH] sindex.1: Use ' for a plain quote char

[Uwe Kleine-König]

lintian (a linter for Debian packages) warns:

N:    This manual page uses the \' groff sequence. Usually, the intent to
N:    generate an apostrophe, but that sequence actually renders as a an acute
N:    accent.
N:
N:    For an apostrophe or a single closing quote, use plain '. For single
N:    opening quote, i.e. a straight downward line ' like the one used in
N:    shell commands, use \(aq.

I'm not following its advice but stick to ' as is done in other places
of sindex.1.

Signed-off-by: Uwe Kleine-König <uwe@kleine-koenig.org>
---
 sindex.1 | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/sindex.1 b/sindex.1
index e3e14ca3ad23..d7c5173a85f2 100644
--- a/sindex.1
+++ b/sindex.1
@@ -128,8 +128,8 @@ struct member
 .
 .SH MODE
 The \fBMODE\fR is dumped as a 3-letter string. The first letter denotes address
-of part, 2-nd - access by value, 3-rd - access by pointer. A special value
-\'\fIdef\fR\' means a symbol definition.
+of part, 2-nd - access by value, 3-rd - access by pointer. A special
+value '\fIdef\fR' means a symbol definition.
 .TP
 \fBr\fR
 read
-- 
2.27.0

Re: [PATCH] sindex.1: Use ' for a plain quote char

[Luc Van Oostenryck]

On Fri, Jul 31, 2020 at 11:41:25PM +0200, Uwe Kleine-König wrote:
> --- a/sindex.1
> +++ b/sindex.1
> @@ -128,8 +128,8 @@ struct member
>  .
>  .SH MODE
>  The \fBMODE\fR is dumped as a 3-letter string. The first letter denotes address
> -of part, 2-nd - access by value, 3-rd - access by pointer. A special value
> -\'\fIdef\fR\' means a symbol definition.
> +of part, 2-nd - access by value, 3-rd - access by pointer. A special
> +value '\fIdef\fR' means a symbol definition.

This looks good to me.
Thanks.

But maybe, in this case the single quotes are even not needed at all
since the symbol is already emphasized with the italic? Or the italic
is not needed because it's already between quotes?
Alexey, do you have any preferences?

-- Luc

Re: [PATCH] sindex.1: Use ' for a plain quote char

[Uwe Kleine-König]

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

Hello Luc,

On 8/1/20 2:40 PM, Luc Van Oostenryck wrote:
> On Fri, Jul 31, 2020 at 11:41:25PM +0200, Uwe Kleine-König wrote:
>> --- a/sindex.1
>> +++ b/sindex.1
>> @@ -128,8 +128,8 @@ struct member
>>  .
>>  .SH MODE
>>  The \fBMODE\fR is dumped as a 3-letter string. The first letter denotes address
>> -of part, 2-nd - access by value, 3-rd - access by pointer. A special value
>> -\'\fIdef\fR\' means a symbol definition.
>> +of part, 2-nd - access by value, 3-rd - access by pointer. A special
>> +value '\fIdef\fR' means a symbol definition.
> 
> But maybe, in this case the single quotes are even not needed at all
> since the symbol is already emphasized with the italic? Or the italic
> is not needed because it's already between quotes?

italic isn't very obvious on the console:

	$ man -l sindex.1 | grep symbol\ de
	       cial value ´def´ means a symbol definition.


Best regards
Uwe


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

Re: [PATCH] sindex.1: Use ' for a plain quote char

[Alexey Gladkov]

On Sat, Aug 01, 2020 at 02:40:04PM +0200, Luc Van Oostenryck wrote:
> On Fri, Jul 31, 2020 at 11:41:25PM +0200, Uwe Kleine-König wrote:
> > --- a/sindex.1
> > +++ b/sindex.1
> > @@ -128,8 +128,8 @@ struct member
> >  .
> >  .SH MODE
> >  The \fBMODE\fR is dumped as a 3-letter string. The first letter denotes address
> > -of part, 2-nd - access by value, 3-rd - access by pointer. A special value
> > -\'\fIdef\fR\' means a symbol definition.
> > +of part, 2-nd - access by value, 3-rd - access by pointer. A special
> > +value '\fIdef\fR' means a symbol definition.
> 
> This looks good to me.
> Thanks.
> 
> But maybe, in this case the single quotes are even not needed at all
> since the symbol is already emphasized with the italic? Or the italic
> is not needed because it's already between quotes?
> Alexey, do you have any preferences?

Nop. If you think that this will be better, then I am OK with these
changes.

-- 
Rgrds, legion

Re: [PATCH] sindex.1: Use ' for a plain quote char

[Luc Van Oostenryck]

On Sat, Aug 01, 2020 at 05:42:17PM +0200, Alexey Gladkov wrote:
> On Sat, Aug 01, 2020 at 02:40:04PM +0200, Luc Van Oostenryck wrote:
> > On Fri, Jul 31, 2020 at 11:41:25PM +0200, Uwe Kleine-König wrote:
> > > --- a/sindex.1
> > > +++ b/sindex.1
> > > @@ -128,8 +128,8 @@ struct member
> > >  .
> > >  .SH MODE
> > >  The \fBMODE\fR is dumped as a 3-letter string. The first letter denotes address
> > > -of part, 2-nd - access by value, 3-rd - access by pointer. A special value
> > > -\'\fIdef\fR\' means a symbol definition.
> > > +of part, 2-nd - access by value, 3-rd - access by pointer. A special
> > > +value '\fIdef\fR' means a symbol definition.
> > 
> > This looks good to me.
> > Thanks.
> > 
> > But maybe, in this case the single quotes are even not needed at all
> > since the symbol is already emphasized with the italic? Or the italic
> > is not needed because it's already between quotes?
> > Alexey, do you have any preferences?
> 
> Nop. If you think that this will be better, then I am OK with these
> changes.

OK, I think it's fine so.

I've applied it unchanged. Thanks to both of you.
-- Luc