Bug 3882 - wayland feature should be well documented
Summary: wayland feature should be well documented
Status: VERIFIED FIXED
Alias: None
Product: General Docs
Classification: Documentation
Component: docs-general (show other bugs)
Version: 1.4
Hardware: x86 Multiple
: Medium normal
Target Milestone: 1.4.1
Assignee: Scott Rifenbark
QA Contact:
URL: http://git.yoctoproject.org/cgit.cgi/...
Whiteboard: 28 June 2013: VERIFIED AND FIXED
Depends on:
Blocks:
 
Reported: 2013-02-13 09:37 UTC by Alexandru Georgescu
Modified: 2013-06-28 06:19 UTC (History)
6 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: ---

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Alexandru Georgescu 2013-02-13 09:37:31 UTC 
Currently, the only available documentation for Wayland/Weston feature can be found on the wiki: https://wiki.yoctoproject.org/wiki/Wayland which lacks of details about the  feature.

There should be a detailed info about how an image can be created to support Wayland, how Wayland can be enabled/enabled, what BSPs are supported, known issues, configuration needed, etc.
Comment 1 Jessica 2013-02-14 15:46:03 UTC 
Alex,

Please fill info in wiki then pass the bug to Scott to incorporate into doc
Comment 2 Scott Rifenbark 2013-02-14 15:58:48 UTC 
Wiki needs to fully explain the solutions.  Please add as much detail along with general explanations as you can Alex.

Scott
Comment 3 Alexandru Damian 2013-02-22 08:29:15 UTC 
I'm still gathering data on this - getting it to run on embedded HW is a bit of pain.
Comment 4 Scott Rifenbark 2013-05-21 19:18:59 UTC 
Any progress on this?  Will we able to get this in for 1.4.1?

Scott
Comment 5 Alexandru Damian 2013-05-28 09:31:59 UTC 
The information in the wiki is updated.

Please reopen if you need more information, and please specify what information you need.
Comment 6 Paul Eggleton 2013-05-28 09:34:44 UTC 
Can we leave this open until the documentation has been completed? I'm assigning it back to Scott.
Comment 7 Scott Rifenbark 2013-05-29 07:55:35 UTC 
I am treating this topic similar to the "X32" topic, which means I am placing it in the "Technical Details" section of the YP Reference Manual.  

I have created the section to a point but am missing some key understanding in the section on how to enable wayland.  Here is the link to the section as it stands now:

http://www.yoctoproject.org/docs/1.5/ref-manual/ref-manual.html#wayland

Please look it over and comment with some information that will help me better understand how to exactly describe the enabling steps for both running under X11 (the default) and for running under KMS.  That is the information I cannot figure out from the wiki.  I have placeholder text in there that specifically asks for input.

Thanks, 
Scott
Comment 8 Scott Rifenbark 2013-06-05 09:02:04 UTC 
Please review this information.  I have developer notes currently in the text that need addressed. 

Thanks, 
Scott
Comment 9 Alexandru Damian 2013-06-07 11:18:02 UTC 
Edited, please review and let me know if the concerns are addressed.
Comment 10 Scott Rifenbark 2013-06-07 16:44:54 UTC 
The final draft is here for review.  If there are no problems let me know and I will mark as RESOLVED.

http://www.yoctoproject.org/docs/1.5/ref-manual/ref-manual.html#wayland

Scott
Comment 11 Scott Rifenbark 2013-06-11 15:08:54 UTC 
No further comments on this fix so I am marking it RESOLVED.

Scott
Comment 12 Alexandru Georgescu 2013-06-27 12:53:55 UTC 
verified as per above comments.
Comment 13 Scott Rifenbark 2013-06-28 06:19:48 UTC 
I changed the "Whiteboard" field to reflect Alexandru's verification.  

Scott