Commit Graph

17 Commits

Author SHA1 Message Date
Martin Olsson
fc0c2e04c5 doc: fix some typos in documentation 2012-07-09 18:03:56 -04:00
Kristian Høgsberg
94bb47020a doc: Update docs to refer to wl_seat instead of wl_input_device 2012-05-16 14:25:45 -04:00
Darxus
6d1902b85c Add missing alt attributes in publican docs.
Haven't figured out how to regenerate the html, so it's not tested.
Looks like remaining html errors will be fixed in the next publican
release:  https://bugzilla.redhat.com/show_bug.cgi?id=788576
2012-05-15 11:02:13 -04:00
Kristian Høgsberg
5b72fc7528 docs: Touch ouput dir Wayland to update timestamp
Prevents rebuild every time.
2012-03-29 14:11:16 -04:00
Peter Hutterer
f68e156b8f doc: consistently indent the xml files by 2 spaces
2 spaces is enough for xml, otherwise we end up with too little room for the
actual text.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-03-28 23:05:45 -04:00
Peter Hutterer
966e8ec9c0 doc: rename Procotol to ProtocolSpec and WaylandProtocol to Protocol
The former is the actual specification, the latter notes about the protocol.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-03-28 23:05:32 -04:00
Peter Hutterer
adf300dc13 doc: remove unused example files
These files were left in as examples, we have real-world examples now.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-03-28 23:05:14 -04:00
Peter Hutterer
3d7f7e2f4a doc: move documentation from the tex file to docbook
And remove the .tex file

Minor changes:
- where the .tex file had some interface descriptions, the docbook source
  now links to the actual protocol. The exception here is the shared object
  cache which is simply a <programlisting> until the protocol spec exists.
- "Implementation" section skipped, this seems in need of an update anyway
  and may be better documented elsewhere (wiki?)

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-03-28 23:04:25 -04:00
Kristian Høgsberg
ccb78667b9 doc: Don't list directories in list of files to install
The find expression was listing the xml_tmp directory, because it matched
the -prune rule.
2012-03-16 09:26:05 -04:00
Gaetan Nadon
7ee21abef0 publican: support out-of-source tree build
When srcdir!=builddir, there is no way to tell publican that the source
is in srcdir rather than builldir. The workaround is to copy the source
files from srcdir to builddir. To retain the en-US final destination
name, the source directory is renamed to en_US.

Tested-by: Peter Hutterer <peter.hutterer@who-t.net>
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2012-03-04 15:02:43 -05:00
Peter Hutterer
1070579d4b Hack up distcheck for publican
Publican requires a read-write source tree, see
http://bugzilla.redhat.com/show_bug.cgi?id=798484

And it currently cannot build out-of-tree, so we need to copy the sources
into the _build tree and generate Protocol.xml into that tree too (we'd have
to do this anyway since automake creates a read-only source tree, so we
can't just link).

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-02-29 12:46:01 +10:00
Peter Hutterer
a678fd53e1 Generate the docbook description for the protocol from wayland.xml
Convert the wayland.xml protocol description to a docbook-compatible format
and hook it up to the publican sources.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-02-29 12:46:00 +10:00
Peter Hutterer
c3d56a05c6 Hook up autotools for publican
automake doesn't seem to provide a sensible method to install a directory of
stuff in $(docdir). Do it manually then.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-02-29 12:46:00 +10:00
Peter Hutterer
f48355cad3 doc: Comment out some of the default chapters
I'll leave them in for now as a template for how things looked originally,
this can be removed later.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-02-29 12:46:00 +10:00
Peter Hutterer
125289a0d7 doc: Add architecture from the website
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-02-29 12:46:00 +10:00
Peter Hutterer
6071b7da94 doc: Fix up title page with logo and author information
Abstract taken from http://wayland.freedesktop.org

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-02-29 12:46:00 +10:00
Peter Hutterer
fcddfbb769 doc: add publican-created doctree
$> publican create --name=Wayland
unmodified otherwise

To build the tree to target formats, use
$> publican build --langs=en-US --formats=html,pdf

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-02-29 12:45:57 +10:00