Skip to content

docs: Terminology updates#5523

Closed
nolade wants to merge 1 commit intoFreeRADIUS:masterfrom
nolade:docmaster
Closed

docs: Terminology updates#5523
nolade wants to merge 1 commit intoFreeRADIUS:masterfrom
nolade:docmaster

Conversation

@nolade
Copy link
Contributor

@nolade nolade commented Feb 21, 2025

First pass through all docs to modify/change/update words and terms as defined in HIVE 3149. Note - I didnt change terms/words in the coding sections of the *.c type files as defs/labels already set. Some comments were updated.

First pass through all docs to modify/change/update words and terms as defined in HIVE 3149. Note - I didnt change terms/words in the coding sections of the *.c type files as defs/labels already set. Some comments were updated.
== WPA2

WPA2 implements the mandatory elements of 802.11i. In particular, in addition to TKIP and the Michael algorithm, it introduces a new Advanced Encryption Standard based algorithm, CCMP, that is considered fully secure. Official support for WPA2 in Microsoft Windows XP was rolled out on 1 May 2005. Driver upgrades for network cards may be required. Apple Computer supports WPA2 on all AirPort Extreme-enabled Apple Macintosh, the AirPort Extreme Base Station, and the AirPort Express. Firmware upgrades needed are included in AirPort 4.2, released July 14, 2005. Note that from March 13, 2006, WPA2 certification is mandatory for all new devices wishing to be Wi-Fi certified.
WPA2 implements the required elements of 802.11i. In particular, in addition to TKIP and the Michael algorithm, it introduces a new Advanced Encryption Standard based algorithm, CCMP, that is considered fully secure. Official support for WPA2 in Microsoft Windows XP was rolled out on 1 May 2005. Driver upgrades for network cards may be required. Apple Computer supports WPA2 on all AirPort Extreme-enabled Apple Macintosh, the AirPort Extreme Base Station, and the AirPort Express. Firmware upgrades needed are included in AirPort 4.2, released July 14, 2005. Note that from March 13, 2006, WPA2 certification is required for all new devices wishing to be Wi-Fi certified.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To me these have different meanings. "required" would be the necessary bits, and "mandatory" would be the parts explicitly marked as being needed, i.e. the "MUST"s in an RFC.


Some external dependencies must be installed before building or
running FreeRADIUS. The core depends on two mandatory libraries:
running FreeRADIUS. The core depends on two required libraries:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just remove required

@alandekok
Copy link
Member

I'll pull this in after some tweaks.

  • bad words can stay in the source code. We're happy with that.
  • The directory doc/rfc is taken from external, public, standards. We just keep those as-is
  • Most of the directory doc/antora/modules/reference/raddb/ is taken from the originals in raddb/. The originals should generally be modified, not the auto-converted outputs.

@alandekok
Copy link
Member

I've merged everything else in, with tweaks as noted by Arran.

Sometimes words like "mandatory" have technical meaning, and are a required part of the specifications.

@alandekok alandekok closed this Feb 28, 2025
@nolade nolade deleted the docmaster branch March 14, 2025 18:23
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