Skip to content

Conversation

ghost
Copy link

@ghost ghost commented Apr 29, 2020

Clarify that this is referring to the 5GHz Wi-Fi band, not 5G mobile.

While I'm in here, fix up various other issues:

  • Correct spelling of Wi-Fi
  • Grammar fixups
  • Put 'raspi-config' inside backticks

andrum99 added 2 commits April 29, 2020 17:13
Clarify that this is referring to the 5GHz Wi-Fi band, not 5G mobile.

While I'm in here, fix up various other issues:

- Correct spelling of Wi-Fi
- Grammar fixups
- Put 'raspi-config' inside backticks
@lurch
Copy link
Contributor

lurch commented Apr 29, 2020

@JamesH65 Is #109 still relevant? Or has the "documentation style guide" changed since then? 🤷

@JamesH65
Copy link
Contributor

I avoid using the Wifi phrase completely as it's a trademark (yes indeed!) so I always use wireless or 'wireless network'.

@ghost
Copy link
Author

ghost commented Apr 29, 2020

I avoid using the Wifi phrase completely as it's a trademark (yes indeed!) so I always use wireless or 'wireless network'.

The trademark is also supposed to only be used if the device in question has undergone, and passed, specific interoperability testing, as I understand it.

@lurch
Copy link
Contributor

lurch commented Apr 30, 2020

specific interoperability testing

https://www.raspberrypi.org/documentation/hardware/raspberrypi/conformity.md ?

@ghost
Copy link
Author

ghost commented Apr 30, 2020

specific interoperability testing

https://www.raspberrypi.org/documentation/hardware/raspberrypi/conformity.md ?

The Wi-Fi alliance wants companies to test their devices to check they can successfully interoperate with other Wi-Fi devices.

@ghost
Copy link
Author

ghost commented May 1, 2020

OK, so back on topic - raspi-config uses the term 'Wi-fi' in the menu. The official trademark spelling is 'Wi-Fi'. So we need an official decision on what term to use before I proceed any further with this one. We seem to have multiple conflicting ideas:

  • Liz in 2014 said WiFi is correct
  • the Wi-Fi Alliance say Wi-Fi is correct
  • James says don't use any variant of wifi, but 'wireless', 'wireless networking' etc. instead.

If Raspberry Pi could make an official decision that would be most helpful.

@JamesH65
Copy link
Contributor

JamesH65 commented May 1, 2020

I've found the style guide and Wifi is specifically mentioned (well, rather, someone posted me a link to it when I asked where it was)

https://github.com/raspberrypilearning/style-guide/blob/master/style-guide.md

@ghost
Copy link
Author

ghost commented May 1, 2020

I've found the style guide and Wifi is specifically mentioned (well, rather, someone posted me a link to it when I asked where it was)

https://github.com/raspberrypilearning/style-guide/blob/master/style-guide.md

Thanks James - that's the one I was after. I see it solves the "how to refer to wireless networking stuff" problem as well, which is extremely useful. Buy that person a beverage of their choice 😁

@ghost
Copy link
Author

ghost commented May 1, 2020

The standardisation of how we refer to wireless network/wifi is a big change that is bogging this seemingly simple PR down a bit. I have manually reverted all my proposed changes to how wifi is referred to in this file, and would propose that this PR be integrated without touching the 'wifi' elements at all.

If there are no other objections, this PR looks ready to go.

I will address the issue of wireless/wifi in a separate PR, since it will require changes across multiple files and repos (raspi-config is currently wrong, as I read the style guide).

@JamesH65
Copy link
Contributor

JamesH65 commented May 2, 2020

Looks like quite a number of places in the SW that use it - currently in discussion internally.

@ghost
Copy link
Author

ghost commented May 2, 2020

Looks like quite a number of places in the SW that use it - currently in discussion internally.

Yes, it's a tricky one. Wi-Fi is a pretty well understood term for non-techies, "wireless networking" not so much I think. It's kind of like Americans saying "Kleenex" for "tissues" almost. I've even heard some folk call a network cable "the wifi cable".

@XECDesign
Copy link
Contributor

XECDesign commented May 4, 2020

@JamesH65 please also ping me when there's a decision.

@JamesH65
Copy link
Contributor

JamesH65 commented May 4, 2020

@XECDesign Will email you offline with internal discussion.

@JamesH65
Copy link
Contributor

JamesH65 commented May 4, 2020

Are we OK to merge this? Or shall I merge the Wifi->wireless fix up first, then this can rebased over it?

@JamesH65
Copy link
Contributor

JamesH65 commented May 4, 2020

Actually, better to merge this and the other related PR, then do the wifi change. So everyone OK for this to be merged?

@JamesH65
Copy link
Contributor

JamesH65 commented May 4, 2020

@lurch @andrum99 For final OK

@ghost
Copy link
Author

ghost commented May 4, 2020

Whatever you think is easiest. 👍

@lurch
Copy link
Contributor

lurch commented May 4, 2020

I'm still not convinced we need the specific "Note that with the latest Buster Raspbian release" callout, but lets get this merged, do the big WiFi change, and we can come back to it later.

@ghost
Copy link
Author

ghost commented May 4, 2020

I'm still not convinced we need the specific "Note that with the latest Buster Raspbian release" callout, but lets get this merged, do the big WiFi change, and we can come back to it later.

👍

@JamesH65 JamesH65 merged commit c8e5003 into raspberrypi:master May 4, 2020
@ghost ghost deleted the patch-2 branch May 14, 2020 21:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants