Bug 11104

Summary: [patch] misprint in xlib manual, broken example in X Toolkit intrinsics, etc.
Product: xorg Reporter: Bryce Harrington <bryce>
Component: DocumentationAssignee: Xorg Project Team <xorg-team>
Status: RESOLVED FIXED QA Contact: Xorg Project Team <xorg-team>
Severity: normal    
Priority: medium    
Version: 7.2 (2007.02)   
Hardware: Other   
OS: All   
Whiteboard:
i915 platform: i915 features:
Attachments:
Description Flags
fixes for xorg-docs none

Description Bryce Harrington 2007-05-30 08:15:32 UTC
These patches by Jochen Voss.

  There is a minor problem with the table of contents of the
  xlib manual.  The file /usr/share/doc/xspecs/xlib.txt.gz
  contains the lines (near the end, maybe lines 46417-46419)

      13.4.3.1. Required Char Set  . . . . . . . . . . . . . . 404
      >N Query Orientation . . . . . . . . . . . . . . . . . . 404
      13.4.3.3. Directional Dependent Drawing  . . . . . . . . 405

  The number "13.4.3.2" is misprinted there as ">N".

  There is a slightly broken example in the X Toolkit Intrinsics
  manual.  The file /usr/share/doc/xspecs/intrinsics.txt.gz
  contains the following lines (near line 2211) of example code:

       {
            Label WidgetClass lwc = (Label WidgetClass)XtClass(w);
            XtCheckSubclass(w, labelWidgetClass, NULL);
            *(lwc->label_class.set_text)(w, text)
       }

  Clearly the "Label WidgetClass lwc = ..." is a syntax error.
  It should be 'LabelWidgetClass' instead of 'Label WidgetClass'.

  The patch also fixes a minor issue with index file generation.

  There is a minor typo in the X Toolkit Intrinsics manual.  The file
  /usr/share/doc/xspecs/intrinsics.txt.gz contains (near line 24724) the
  sentence:

      In Release 4 there is no requirement that all composite
      widgets implement the extra functionality required to
      manage windowless children, so the accept_objects field
      allows a composite widget to declare that it is not
      prepared to do so.

  In fact the corresponding field of CompositeClassExtensionRec is
  called 'accepts_objects' instead of 'accept_objects'.
Comment 1 Bryce Harrington 2007-05-30 08:19:18 UTC
Created attachment 10137 [details] [review]
fixes for xorg-docs
Comment 2 Alan Coopersmith 2007-05-30 09:37:15 UTC
Thanks for the patch - committed to git master of xorg-docs:

commit 8f8a87978ba53597f89fde2e439f257a2bfea0b7
Author: Jochen Voss <voss@debian.org>
Date:   Wed May 30 09:35:06 2007 -0700

    Bug 11104: misprint in xlib manual, broken example in X Toolkit intrinsics,

    X.Org Bugzilla #11104 <https://bugs.freedesktop.org/show_bug.cgi?id=11104>
    Patch #10137 <https://bugs.freedesktop.org/attachment.cgi?id=10137>
    Contributed upstream from Debian's 023_specs_doc_fixes.diff

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.