all messages for Guix-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
* bug#31652: Use of ‘keymap’ vs. ‘layout’ in manual
@ 2018-05-30  3:49 Tobias Geerinckx-Rice
  2018-05-30  9:05 ` Alex Kost
  0 siblings, 1 reply; 4+ messages in thread
From: Tobias Geerinckx-Rice @ 2018-05-30  3:49 UTC (permalink / raw)
  To: 31652

Guix,

Grepping the manual for ‘keyboard layout’ will get you to section 
6.1.4.1 (setting the layout temporarily during installation using 
loadkeys), but not 6.2.7.1 where you might learn about using 
console-keymap-service to make the change permanent.

This bug is a reminder to myself to replace at least one 
occurrence of ‘keymap’ with the common term.

Kind regards,

T G-R

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

* bug#31652: Use of ‘keymap’ vs. ‘layout’ in manual
  2018-05-30  3:49 bug#31652: Use of ‘keymap’ vs. ‘layout’ in manual Tobias Geerinckx-Rice
@ 2018-05-30  9:05 ` Alex Kost
  2018-05-30 11:27   ` Ricardo Wurmus
  0 siblings, 1 reply; 4+ messages in thread
From: Alex Kost @ 2018-05-30  9:05 UTC (permalink / raw)
  To: Tobias Geerinckx-Rice; +Cc: 31652

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

Tobias Geerinckx-Rice (2018-05-30 05:49 +0200) wrote:

> Guix,
>
> Grepping the manual for ‘keyboard layout’ will get you to section
> 6.1.4.1 (setting the layout temporarily during installation using
> loadkeys), but not 6.2.7.1 where you might learn about using
> console-keymap-service to make the change permanent.
>
> This bug is a reminder to myself to replace at least one occurrence of
> ‘keymap’ with the common term.

Do you mean ‘layout’ is the common term?  "man loadkeys" mentions
"layout" only once, and "keymap" a lot.

I think we can just put a reference to that section.  Maybe like this:


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: doc-keymap.diff --]
[-- Type: text/x-patch, Size: 500 bytes --]

diff --git a/doc/guix.texi b/doc/guix.texi
index 09749b15e..02425e791 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -8418,7 +8418,9 @@ loadkeys dvorak
 
 See the files under @file{/run/current-system/profile/share/keymaps} for
 a list of available keyboard layouts.  Run @command{man loadkeys} for
-more information.
+more information.  After installing GuixSD, you can set your default
+keyboard layout with @code{console-keymap-service} (@pxref{Base
+Services}).
 
 @subsubsection Networking
 

[-- Attachment #3: Type: text/plain, Size: 10 bytes --]


-- 
Alex

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

* bug#31652: Use of ‘keymap’ vs. ‘layout’ in manual
  2018-05-30  9:05 ` Alex Kost
@ 2018-05-30 11:27   ` Ricardo Wurmus
  2021-09-24  0:56     ` Sarah Morgensen
  0 siblings, 1 reply; 4+ messages in thread
From: Ricardo Wurmus @ 2018-05-30 11:27 UTC (permalink / raw)
  To: Alex Kost; +Cc: 31652


Alex Kost <alezost@gmail.com> writes:

> Tobias Geerinckx-Rice (2018-05-30 05:49 +0200) wrote:
>
>> Guix,
>>
>> Grepping the manual for ‘keyboard layout’ will get you to section
>> 6.1.4.1 (setting the layout temporarily during installation using
>> loadkeys), but not 6.2.7.1 where you might learn about using
>> console-keymap-service to make the change permanent.
>>
>> This bug is a reminder to myself to replace at least one occurrence of
>> ‘keymap’ with the common term.
>
> Do you mean ‘layout’ is the common term?  "man loadkeys" mentions
> "layout" only once, and "keymap" a lot.
>
> I think we can just put a reference to that section.  Maybe like this:
>
> diff --git a/doc/guix.texi b/doc/guix.texi
> index 09749b15e..02425e791 100644
> --- a/doc/guix.texi
> +++ b/doc/guix.texi
> @@ -8418,7 +8418,9 @@ loadkeys dvorak
>  
>  See the files under @file{/run/current-system/profile/share/keymaps} for
>  a list of available keyboard layouts.  Run @command{man loadkeys} for
> -more information.
> +more information.  After installing GuixSD, you can set your default
> +keyboard layout with @code{console-keymap-service} (@pxref{Base
> +Services}).
>  
>  @subsubsection Networking

This is fine.  We should also consider adding more @cindex entries to
cover all terms that people might search for.  The index should guide
people to the relevant places in the manual.

-- 
Ricardo

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

* bug#31652: Use of ‘keymap’ vs. ‘layout’ in manual
  2018-05-30 11:27   ` Ricardo Wurmus
@ 2021-09-24  0:56     ` Sarah Morgensen
  0 siblings, 0 replies; 4+ messages in thread
From: Sarah Morgensen @ 2021-09-24  0:56 UTC (permalink / raw)
  To: Ricardo Wurmus; +Cc: 31652-done, Alex Kost

Hello all,

I found this old bug...

Ricardo Wurmus <rekado@elephly.net> writes:

> Alex Kost <alezost@gmail.com> writes:
>
>> Tobias Geerinckx-Rice (2018-05-30 05:49 +0200) wrote:
>>
>>> Guix,
>>>
>>> Grepping the manual for ‘keyboard layout’ will get you to section
>>> 6.1.4.1 (setting the layout temporarily during installation using
>>> loadkeys), but not 6.2.7.1 where you might learn about using
>>> console-keymap-service to make the change permanent.
>>>
>>> This bug is a reminder to myself to replace at least one occurrence of
>>> ‘keymap’ with the common term.
>>
>> Do you mean ‘layout’ is the common term?  "man loadkeys" mentions
>> "layout" only once, and "keymap" a lot.
>>
>> I think we can just put a reference to that section.  Maybe like this:
>>
>> diff --git a/doc/guix.texi b/doc/guix.texi
>> index 09749b15e..02425e791 100644
>> --- a/doc/guix.texi
>> +++ b/doc/guix.texi
>> @@ -8418,7 +8418,9 @@ loadkeys dvorak
>>  
>>  See the files under @file{/run/current-system/profile/share/keymaps} for
>>  a list of available keyboard layouts.  Run @command{man loadkeys} for
>> -more information.
>> +more information.  After installing GuixSD, you can set your default
>> +keyboard layout with @code{console-keymap-service} (@pxref{Base
>> +Services}).
>>  
>>  @subsubsection Networking
>
> This is fine.  We should also consider adding more @cindex entries to
> cover all terms that people might search for.  The index should guide
> people to the relevant places in the manual.

However, it seems the manual now primarily uses "keyboard layout" with
an entry in the index for "keymap".  This seems to resolve the original
issue, so I'm closing this bug.  Please reopen if this was in error.

Note also that when there is alternate terminology, you can use

  @cindex keymap @seeentry{keyboard layout}

to put a single entry in the index which says

  keymap: see keyboard layout

See (texinfo)Advanced Indexing for more info :)

--
Sarah




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

end of thread, other threads:[~2021-09-24  0:57 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-05-30  3:49 bug#31652: Use of ‘keymap’ vs. ‘layout’ in manual Tobias Geerinckx-Rice
2018-05-30  9:05 ` Alex Kost
2018-05-30 11:27   ` Ricardo Wurmus
2021-09-24  0:56     ` Sarah Morgensen

Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/guix.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.