Linux-Sparse Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH] sindex.1: Use ' for a plain quote char
@ 2020-07-31 21:41 Uwe Kleine-König
  2020-08-01 12:40 ` Luc Van Oostenryck
  0 siblings, 1 reply; 5+ messages in thread
From: Uwe Kleine-König @ 2020-07-31 21:41 UTC (permalink / raw)
  To: linux-sparse

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


^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] sindex.1: Use ' for a plain quote char
  2020-07-31 21:41 [PATCH] sindex.1: Use ' for a plain quote char Uwe Kleine-König
@ 2020-08-01 12:40 ` Luc Van Oostenryck
  2020-08-01 12:44   ` Uwe Kleine-König
  2020-08-01 15:42   ` Alexey Gladkov
  0 siblings, 2 replies; 5+ messages in thread
From: Luc Van Oostenryck @ 2020-08-01 12:40 UTC (permalink / raw)
  To: Uwe Kleine-König; +Cc: linux-sparse, Alexey Gladkov

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

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] sindex.1: Use ' for a plain quote char
  2020-08-01 12:40 ` Luc Van Oostenryck
@ 2020-08-01 12:44   ` Uwe Kleine-König
  2020-08-01 15:42   ` Alexey Gladkov
  1 sibling, 0 replies; 5+ messages in thread
From: Uwe Kleine-König @ 2020-08-01 12:44 UTC (permalink / raw)
  To: Luc Van Oostenryck; +Cc: linux-sparse, Alexey Gladkov

[-- 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 --]

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] sindex.1: Use ' for a plain quote char
  2020-08-01 12:40 ` Luc Van Oostenryck
  2020-08-01 12:44   ` Uwe Kleine-König
@ 2020-08-01 15:42   ` Alexey Gladkov
  2020-08-01 16:41     ` Luc Van Oostenryck
  1 sibling, 1 reply; 5+ messages in thread
From: Alexey Gladkov @ 2020-08-01 15:42 UTC (permalink / raw)
  To: Luc Van Oostenryck; +Cc: Uwe Kleine-König, linux-sparse

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


^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] sindex.1: Use ' for a plain quote char
  2020-08-01 15:42   ` Alexey Gladkov
@ 2020-08-01 16:41     ` Luc Van Oostenryck
  0 siblings, 0 replies; 5+ messages in thread
From: Luc Van Oostenryck @ 2020-08-01 16:41 UTC (permalink / raw)
  To: Alexey Gladkov; +Cc: Uwe Kleine-König, linux-sparse

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

^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, back to index

Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-07-31 21:41 [PATCH] sindex.1: Use ' for a plain quote char Uwe Kleine-König
2020-08-01 12:40 ` Luc Van Oostenryck
2020-08-01 12:44   ` Uwe Kleine-König
2020-08-01 15:42   ` Alexey Gladkov
2020-08-01 16:41     ` Luc Van Oostenryck

Linux-Sparse Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-sparse/0 linux-sparse/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-sparse linux-sparse/ https://lore.kernel.org/linux-sparse \
		linux-sparse@vger.kernel.org
	public-inbox-index linux-sparse

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-sparse


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git