aboutsummaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* doc: fix typosEric Engestrom2016-05-022-6/+6
| | | | | | Signed-off-by: Eric Engestrom <eric@engestrom.ch> Reviewed-by: Armin Krezović <krezovic.armin@gmail.com> Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: Hyphenate compound adjectives window-local, surface-localYong Bakos2016-04-292-3/+3
| | | | | | | See https://lists.freedesktop.org/archives/wayland-devel/2016-April/028249.html. Signed-off-by: Yong Bakos <ybakos@humanoriented.com> Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: Ignore html subdirectory.Yong Bakos2016-03-101-0/+1
| | | | | Signed-off-by: Yong Bakos <ybakos@humanoriented.com> Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: Note strong recommendation to use S-o-b in contributionsBryce Harrington2016-03-071-0/+9
| | | | | Signed-off-by: Bryce Harrington <bryce@osg.samsung.com> Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* doc: link between client and server doc and to the wayland bookPeter Hutterer2016-03-072-0/+10
| | | | | | | | And insert "client" or "server" into the PROJECT_NAME to know which one we have. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: generate doxygen html output from the scannerPeter Hutterer2016-03-073-2/+44
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This switches the scanner to generate doxygen-compatible tags for the generated protocol headers, and hooks up the doxygen build to generate server and client-side API documentation. That documentation is now in Client/ and Server/, respectively. GENERATE_HTML is on by default and must be disabled for the xml/man targets to avoid messing up the new documentation. We disable all three three targets in the doxyfile (xml and man default to NO anyway) to make it obvious that they need to be set in the per-target instructions. Each protocol is a separate doxygen @page, with each interface a @subpage. Wayland only has one protocol, wayland-protocols will have these nested. Each protocol page has a list of interfaces and the copyright and description where available. All interfaces are grouped by doxygen @defgroup and @ingroups and appear in "Modules" in the generated output. Each interface subpage has the description and a link to the actual API doc. Function, struct and #defines are documented in doxygen style and associated with the matching interface. Note that pages and groups have fixed HTML file names and are directly linkable/bookmark-able. The @mainpage is a separate file that's included at build time. It doesn't contain much other than links to where the interesting bits are. It's a static file though that supports markdown, so we can extend it easily in the future. For doxygen we need the new options EXTRACT_ALL and OPTIMIZE_OUTPUT_FOR_C so it scans C code properly. EXTRACT_STATIC is needed since most of the protocol hooks are static. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: Use enum argument type to make links in protocol documentationBill Spitzak2016-02-191-7/+19
| | | | Reviewed-by: Auke Booij <auke@tulcod.com>
* doc: make the doxygen output dependent on scanner.cPeter Hutterer2015-11-161-2/+2
| | | | | | | When the scanner changes, we need to rebuild Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: output enum and bitfield attributes in the documentationAuke Booij2015-11-041-0/+9
| | | | | | Signed-off-by: Auke Booij <auke@tulcod.com> Reviewed-by: Nils Chr. Brause <nilschrbrause@googlemail.com> Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: document the enum and bitfield attributesAuke Booij2015-11-041-6/+35
| | | | | | | | | | | | | Introduce the enum and bitfield attributes, which allow you to refer to the enum you are expecting in an argument, and specify which enums are to be thought of as bitfields. Changes since v3: - Fix typo ("description" -> "descriptive") Signed-off-by: Auke Booij <auke@tulcod.com> Reviewed-by: Nils Chr. Brause <nilschrbrause@googlemail.com> Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
* Contributing: explain PatchworkPekka Paalanen2015-09-221-0/+75
| | | | | | | | | | | | | | | | | | Add general guidelines for using Patchwork, as we heavily rely on it nowadays. v2: - mention also Xwayland and libinput patch management - reword "if not found in Patchwork" - reword "Not applicable" - mention pwclient Cc: Bryce Harrington <bryce@osg.samsung.com> Cc: Olivier Fourdan <ofourdan@redhat.com> Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk> Reviewed-by: Bryce Harrington <bryce@osg.samsung.com> Reviewed-by: Olivier Fourdan <ofourdan@redhat.com>
* Revert "client: require WAYLAND_DISPLAY to be set"Pekka Paalanen2015-08-242-6/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This reverts commit fb7e13021730d0a5516ecbd3712ea4235e05d24d. Developers have been trying to reduce the number of by default required environment variables, and the mentioned commit is a step backwards in that sense. The fundamental assumption is that a user has only one main (Wayland) display server where all programs should connect to by default, and do so with an a priori known socket name. The commit also broke various use cases in the wild, some accidentally due to other causes, some intentionally. This revert allows those use cases to continue. The original problem of running Weston in a window in an existing GNOME X11 session and getting applications unintentionally launched into Weston can be circumvented by letting Weston use a non-default socket name, leaving wayland-0 unused. Discussion: http://lists.freedesktop.org/archives/wayland-devel/2015-August/023927.html http://lists.freedesktop.org/archives/wayland-devel/2015-August/023937.html Cc: Dima Ryazanov <dima@gmail.com> Cc: Giulio Camuffo <giuliocamuffo@gmail.com> Cc: Daniel Stone <daniel@fooishbar.org> Cc: Jasper St. Pierre <jstpierre@mecheye.net> Cc: Ryo Munakata <ryomnktml@gmail.com> Cc: Ray Strode <halfline@gmail.com> Cc: Peter Hutterer <peter.hutterer@who-t.net> Cc: Matthias Clasen <mclasen@redhat.com> Cc: Sjoerd Simons <sjoerd.simons@collabora.co.uk> Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk> Acked-by: Ray Strode <rstrode@redhat.com> Acked-by: Dima Ryazanov <dima@gmail.com> Reviewed-by: Bryce Harrington <bryce@osg.samsung.com> Acked-By: Sjoerd Simons <sjoerd.simons@collabora.co.uk> Acked-By: Ryo Munakata <ryomnktml@gmail.com> Acked-by: Peter Hutterer <peter.hutterer@who-t.net>
* client: require WAYLAND_DISPLAY to be setDima Ryazanov2015-08-142-7/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Although defaulting to wayland-0 seems convenient, it has an undesirable side effect: clients may unintentionally connect to the wrong compositor. Generally, it's safer to fail instead. Here's a real example: In Fedora 22, Gtk+ prefers Wayland over X11, though the default session is still a normal X11 Gnome session. When you launch a Gtk+ app, it will try Wayland, fail, then try X11, and succesfully start up. That works fine. Now suppose you launch Weston while running the Gnome session. Suddenly, all of the Gtk+ apps launched from Gnome will show up inside Weston instead. That's unexpected. There's also no good way to prevent that from happening (other than perhaps setting WAYLAND_DISPLAY to an invalid value when launching an app). Not using wayland-0 as the default will solve that problem: an app launched from the X11 Gnome session will use the X11 backend regardless of whether there's a wayland compositor running at the same time. Everything else should work as before. The compositor already sets the WAYLAND_DISPLAY when starting the session, so the lack of the default value should not make a difference to the user. Signed-off-by: Dima Ryazanov <dima@gmail.com> Acked-by: Pekka Paalanen <ppaalanen@gmail.com> Acked-by: Giulio Camuffo <giuliocamuffo@gmail.com> Acked-by: Daniel Stone <daniel@fooishbar.org> Acked-by: Jasper St. Pierre <jstpierre@mecheye.net> Reviewed-by: Ryo Munakata <ryomnktml@gmail.com> [Pekka: dropped the wayland-server.c hunk, adjusted summary] Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* publican: Update docs license from MIT "X11" to MIT "Expat" styleBryce Harrington2015-06-221-23/+23
| | | | | Signed-off-by: Bryce Harrington <bryce@osg.samsung.com> Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* doc: drop the default doxygen tagsPeter Hutterer2015-06-181-1743/+0
| | | | | Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* doc: move project-specific doxygen settings to the end of the doxygen filePeter Hutterer2015-06-181-15/+38
| | | | | | | | Rather than having the settings hidden in the file somewhere move them to the end so it's clear which settings we intentionally override. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* Contributing: Specify use of MIT Expat for new code filesBryce Harrington2015-06-121-0/+13
| | | | | Signed-off-by: Bryce Harrington <bryce@osg.samsung.com> Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* docs: remove and ignore doc/doxygen_sqlite3.dbDerek Foreman2015-06-041-0/+1
| | | | | | | | | | | Some newer versions of doxygen are generating this file now, and if we don't clean it up distcheck will fail. Known to affect doxygen 1.8.8 from debian jessie. Signed-off-by: Derek Foreman <derekf@osg.samsung.com> Reviewed-by: Jon A. Cruz <jonc@osg.samsung.com> Tested-by: Jon A. Cruz <jonc@osg.samsung.com>
* introduce new headers wayland-client-core.h and wayland-server-core.hGiulio Camuffo2015-04-301-2/+5
| | | | | | | | | | | | | | | | wayland-client.h and wayland-server.h include the protocol headers generated at build time. This means that a libwayland user cannot generate and use protocol code created from a wayland.xml newer than the installed libwayland, because it is not possible to only include the API header. Another use case is language bindings, which would generate their own protocol code and which only need to use the library ABI, not the generated C code. This commit adds wayland-client-core.h and wayland-server-core.h which do not include the protocol headers or any deprecated code. Reviewed-by: Jason Ekstrand <jason@jlekstrand.net> Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* Spelling fixes (cosmetic)Bryce Harrington2015-03-191-1/+1
| | | | | | | | | | | | | | | | A few typos in comments and protocol docs, no code changes. ./src/wayland-util.h:281: recieved ==> received ./src/wayland-client.c:115: occured ==> occurred ./src/wayland-client.c:156: occured ==> occurred ./tests/test-compositor.c:76: parallely ==> parallelly ./tests/test-compositor.c:474: recieve ==> receive ./protocol/wayland.xml:1767: layed ==> laid ./protocol/wayland.xml:2112: dependant ==> dependent ./doc/publican/sources/Client.xml:25: recieved ==> received Signed-off-by: Bryce Harrington <bryce@osg.samsung.com> Reviewed-by: Bill Spitzak <spitzak@gmail.com>
* doc: Fill in high level description for SurfacesBryce Harrington2015-02-041-3/+10
| | | | | Signed-off-by: Bryce Harrington <bryce@osg.samsung.com> Reviewed-by: Jon A. Cruz <jonc@osg.samsung.com>
* doc: Fix out-of-tree build and also distcheckJon Cruz2015-01-302-2/+9
| | | | | | | | Corrects an issue that would cause out-of-tree builds to fail and also a few items that would cause distcheck to fail. Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com> Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: Intro text for doxygen output in it's own fileBill Spitzak2015-01-295-45/+154
| | | | | | | | | | | | | | | | | (This patch has been modified to apply atop current master) This makes it considerably easier to edit the text and make it different for each library. To address previous concerns with this patch, I wrote some more complete introductory text. This is based on my understanding of these libraries, which may not be correct, and is pretty rudimentary for libwayland-server! However this intro text demonstrates how to create links to the doxygen-generated text. It looks like you cannot link to methods easily as the link name contains a hash number, but links to objects and classes work. Reviewed-by: Jon A. Cruz <jonc@osg.samsung.com> Tested-by: Jon A. Cruz <jonc@osg.samsung.com>
* doc/publican/Makefile.am: Add a missing order-only prerequisiteRui Matos2015-01-281-1/+1
| | | | | | | | Otherwise a parallel make invocation could fail due to the directory not existing. Signed-off-by: Rui Matos <tiagomatos@gmail.com> Reviewed-by: Jon A. Cruz <jonc@osg.samsung.com>
* doc: update diagrams for compatibility.Jon Cruz2015-01-282-47/+47
| | | | | | Change attribute separators for compatiblity with graphviz older than 2.30. Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com>
* doc: Create hot-linked areas in documents.Jon Cruz2015-01-284-35/+134
| | | | | | | Added xslt processing to give DocBook output diagram image maps/hot-linked areas consistent with those automatically generated by Doxygen. Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com>
* doc: Switch from static image files to generated diagrams.Jon Cruz2015-01-286-13/+124
| | | | | | | Switches diagrams from using static PNG images to instead generate them via simple graphviz DOT markup files. Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com>
* doc: Put a dash between type/enum value and descriptionBill Spitzak2015-01-261-5/+5
| | | | | | This was suggested by Derek Foreman, I think it looks better Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: Add macros and typedefs to the documentationBill Spitzak2015-01-261-1/+2
| | | | | | | | | If somebody bothered to put a doxygen comment in for a macro or typedef, make it appear in the pages. This produces documentation for wl_container_of and wl_dispatcher_func_t from the _8h files. Reviewed-by: "Jon A. Cruz" <jonc@osg.samsung.com> Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: there is no need to move the _8h filesBill Spitzak2015-01-261-8/+0
| | | | | | | | The current xslt skips all the data that is in them, so it is ok if they are included. Reviewed-by: "Jon A. Cruz" <jonc@osg.samsung.com> Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: remove redundant subtitlesBill Spitzak2015-01-231-13/+25
| | | | | | | | | Put the argument lists next to the event/message title, which I think makes it a lot easier to understand, and remove redundant "values" title from enumerations. Reviewed-by: Derek Foreman <derekf@osg.samsung.com> Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: Add object types and links to arguments int protocol documentationBill Spitzak2015-01-231-0/+35
| | | | | | | This makes it a lot easier to figure out what is going on! Reviewed-by: Derek Foreman <derekf@osg.samsung.com> Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: compress the lists in the protocol docs someBill Spitzak2015-01-231-9/+21
| | | | | | | | Use simpara to remove the blank lines, and put the type/value and the comment into the same line. Reviewed-by: Derek Foreman <derekf@osg.samsung.com> Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: make itemized lists from doxygen workBill Spitzak2014-12-191-0/+8
| | | | | | Not actually used currently but probably a good idea. Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* doc: Document structures and unions in addition to classesBill Spitzak2014-12-191-10/+15
| | | | | | | | | This provides targets for some of the doxygen links, and some of them have useful memberof function lists. Added some if/else statements to reduce validation errors. Tested-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* doc: Each class in doxygen output is a sectionBill Spitzak2014-12-191-15/+21
| | | | | | | | | | All the methods belonging to the class are listed with it, making it much easier to find them. I dumped all other functions into a section called "Functions" at the end. Tested-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* doc: removed the word "interface" from the link namesBill Spitzak2014-12-194-21/+18
| | | | | | | | Just to make it slightly shorter. Also add a dash to the doxygen links to make them look a bit more alike. Tested-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* doc: Reduce the validation errors of the docbook inputBill Spitzak2014-12-193-33/+23
| | | | | | | | | | | | | | | | | | | | | | (this is different from previous version as it removes some broken and irrelevant changes to the protocol appendix). This removes all the validation errors except for missing link targets. You can test this by removing the --skip-validation from doc/publican/Makefile.am. Main changes are to avoid nesting <para> commands. I also used <simpara> in some places to reduce the amount of blank space. And the reference id's are prefixed with the chapter name to avoid collisions between libclient and libserver. PS: it would be useful if somebody who actually knows something about xslt would come up with a way to translate a block of text makde of <para> commands unchanged, but add <para> around plain text. Most of the difficulty is that doxygen's output is rather inconsistent here. Tested-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* fixup doc: Make it easier to add a new doxygen pageBill Spitzak2014-12-181-1/+1
| | | | | | This supersedes the previous one and fixes a typo where a slash was missing. Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* doc: Make it easier to add a new doxygen pageBill Spitzak2014-12-184-41/+25
| | | | | | | | | The repetitive parts of generating the server and client documentation are merged, so it is easier to add another doxygen chapter: add a new line to $publican_sources in publican/Makefile.am, and a list of C source files to doxygen/Makefile.am. Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: fix for parallel makeBill Spitzak2014-12-181-3/+4
| | | | | | | | Move the *_8h.xml files to a per-chapter temporary file so two chapters can be converted from doxygen at the same time. Tested with make -j 9. Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
* doc: Split libwayland-client and -server into different pagesBill Spitzak2014-12-164-35/+24
| | | | | | | | | | | This was suggested before to make it clearer that things like wl_display are different objects in each of them. I made these into two appendixes because the protocol spec was already an appendix. Reviewed-by: Bryce Harrington <b.harrington@samsung.com> [Bryce requested minor changes, not yet here.] Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* doc: fix doxygen->man command lineBill Spitzak2014-12-161-2/+7
| | | | | | | | It was telling it to scan the doxyfile as well as the C source, and listing some source files more than once. Reviewed-by: Bryce Harrington <b.harrington@samsung.com> Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* doc: Minor makefile cleanup.Jon A. Cruz2014-12-161-7/+13
| | | | | | | | Split out directory creation to leverage order only prerequisites. Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com> Acked-by: Peter Hutterer <peter.hutterer@who-t.net> Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* doc: General makefile cleanup.Jon A. Cruz2014-12-161-31/+46
| | | | | | | | | | | | | | | This is a general cleanup of the makefile in order to bring it more inline with standard make practices. Cleanups included more use of automatic variables, switching AM_V_GEN to AM_V_at to have one 'GEN' visible per file, splitting copy operations to proper rules, and using order only dependencies to properly create directories on-demand. Changes also correct missing use of $(builddir) that has gone unnoticed as it defaults to the current directory ('.'). Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com> Acked-by: Peter Hutterer <peter.hutterer@who-t.net> Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
* doc: Remove duplicated descriptions of wayland objectsBill Spitzak2014-12-051-11/+5
| | | | | | | | This text is a duplicate of the text in the protocol documentation, but the converter mangled it by removing the paragraph breaks and some other errors. Instead replace it with a list of links to the protocol docs. Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: removed redundant dependencyBill Spitzak2014-12-051-2/+2
| | | | | | | The .tmp file dependency depends on the index.xml file so it does not need to be repeated. Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: Invoke doxygen via the defined make variable.Jon A. Cruz2014-12-051-3/+3
| | | | | | | | Invoke doxygen via the autoconf-defined make variable instead of directly. This brings it in line with standard makefile practices. Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com> Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: Removed redundant xslt output elements.Jon A. Cruz2014-12-012-2/+0
| | | | | | | | | Removed <xsl:output> elements that were duplicated but with attributes in a different order. Standard tools are required to ignore the order of attributes in an element. Signed-off-by: Jon A. Cruz <jonc@osg.samsung.com> Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net>
* doc: removed some unnecessary nested listing from doxygen outputBill Spitzak2014-11-251-20/+8
| | | | | This makes the lists of parameters slightly smaller and removes some bullets from see-also and since.
generated by cgit v1.2.3-70-g09d2 (git 2.52.0) at 2026-01-02 01:43:13 +0000