Skip to content

Bring XKB docs in line with actual implementation

Alan Coopersmith requested to merge alanc/libx11:docs into master

Some functions documented in the spec have never been implemented, others were implemented under slightly different names. Since the man pages were created from the spec, they inherited the same mistakes.

Since no one has fixed the implementation in the past 30 years, adjust the docs to match reality instead of the other way around.

I did not do a complete audit, just handled the functions that had man pages but didn't appear in any of the XKB*h header files, after suspecting that the bug reported in issue #105 (closed) had friends.

  • docs: finish removing XkbGetBounceKeysDelay & XkbSetBounceKeysDelay
  • docs: remove XkbAllocDeviceLedInfo
  • docs: remove XkbGetAccessXTimeout & XkbSetAccessXTimeout
  • docs: remove XkbGetSlowKeysDelay & XkbSetSlowKeysDelay
  • docs: remove XkbGetStickyKeysOptions & XkbSetStickyKeysOptions
  • docs: XkbSAActionSetCtrls is really named XkbActionSetCtrls
  • docs: remove XkbChangeIndicators, XkbGetIndicatorChanges, XkbNoteIndicatorChanges
  • docs: remove XkbGetNameChanges
  • docs: remove XkbKeySymsOffset
  • docs: fix names for XkbKeyKeyType & XkbKeyKeyTypeIndex

Merge request reports