[Xcb] [PATCH] Add more documentation.

[Thomas Fischer]

On Sun, Sep 16, 2018 at 11:51 PM Uli Schlachter <psychon at znc.in> wrote:

> On 17.09.2018 00:36, Thomas Fischer wrote:
> > On Sun, Sep 16, 2018 at 9:33 AM Uli Schlachter <psychon at znc.in> wrote:
> >
> >> Hi Thomas,
> >>
> >> sorry for being awfully slow.
> >>
> >> On 26.08.2018 07:14, Thomas Fischer wrote:
> >> [...]> diff --git a/src/xproto.xml b/src/xproto.xml
> >>> index 9624700..f78f339 100644
> >>> --- a/src/xproto.xml
> >>> +++ b/src/xproto.xml
> >>> @@ -1828,6 +1828,10 @@ <xcb/xcb.h>
> >>>      xcb_screen_iterator_t   iter   = xcb_setup_roots_iterator (setup);
> >>>      xcb_screen_t           *screen = iter.data;
> >>>
> >>> +    uint32_t value_mask = XCB_CW_BACK_PIXEL | XCB_CW_EVENT_MASK;
> >>> +    uint32_t value_list[] = { screen->black_pixel,
> >>> +    XCB_EVENT_MASK_KEY_RELEASE | XCB_EVENT_MASK_EXPOSE
> >>> +    /* | XCB_EVENT_MASK_* ... */ };
> >> [...]
> >>
> >> What did you base your patch on? The string "xcb_setup_roots_iterator"
> >> does not appear in the current(?) version of xproto.xml. Thus, your
> >> patch does not apply here.
> >>
> >> Cheers,
> >> Uli
> >>
> >
> > Hello, it's no problem!
> >
> > The example was based on the tutorial here:
> > https://xcb.freedesktop.org/tutorial/basicwindowsanddrawing/
> >
> > The "xcb_setup_roots_iterator" function is generated in
> > libxcb/src/xproto.{h,c}
>
> Sorry if I was not clear.
>
> My problem is not the content of your patch, but that the patch does not
> apply. Your patch touches code next to an example with
> "xcb_setup_roots_iterator", but there is no such example in the current
> version of xproto.xml.
>

Sorry, I misunderstood there! It was late and I should have read the words
"based" and "apply" from a git perspective.

> I have to first apply your patch "Add documentation" from beginning of
> August and only afterwards can "Add more documentation" apply. I totally
> forgot about that first patch (or assumed that the new patch replaces
> the old one). Sorry about that.

I'm still slightly new to open source development -- in the future I'll
make sure to git commit --amend to prevent confusion.


> P.S.: And the commit messages could be improved, but I can just reword
> that while applying the patches.
>

I agree, should I have named it something like this?
"xproto: Add createWindow documentation and example"

Thanks for being patient. How does the documentation look? I'd say 70% is
from the X11 standard, the rest paraphrasing the standard or the Xlib
manuals.
If there's something I should change please let me know.

Thanks,
Thomas
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.freedesktop.org/archives/xcb/attachments/20180927/f401677d/attachment.html>