docs/README: Document that for plgin-docs we extraxt he short-desc from the element...

Original commit message from CVS:
* docs/README:
Document that for plgin-docs we extraxt he short-desc from the element
details.
* docs/design/part-states.txt:
Tell that devices should be closed in PAUSED -> READY.
* docs/manual/README:
Document how tests in the manual are handled.
* docs/manuals.mak:
Typo in comment.

diff --git a/ChangeLog b/ChangeLog
index abf23be..087cbf9 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,18 @@
+2008-06-25  Stefan Kost  <ensonic@users.sf.net>
+
+       * docs/README:
+         Document that for plgin-docs we extraxt he short-desc from the element
+         details.
+
+       * docs/design/part-states.txt:
+         Tell that devices should be closed in PAUSED -> READY.
+
+       * docs/manual/README:
+         Document how tests in the manual are handled.
+
+       * docs/manuals.mak:
+         Typo in comment.
+
 2008-06-25  Wim Taymans  <wim.taymans@collabora.co.uk>
 
        * gst/gstbin.c: (bin_query_latency_fold):
@@ -249,6 +264,7 @@
        When a buffer is writable, its metadata is also writable so we don't
        need to subbuffer (which then makes the buffer not-writable anymore).
 
+>>>>>>> 1.3935
 === release 0.10.20 ===
 
 2008-06-18  Jan Schmidt <jan.schmidt@sun.com>

diff --git a/docs/README b/docs/README
index ed6b371..c609127 100644 (file)
--- a/docs/README
+++ b/docs/README
@@ -307,6 +307,12 @@ in the various plugin packages.
   - you need to commit resulting files to CVS:
     - changes to *.signals and *.args
     - new files for your plugin created in inspect/
+  - if you get thsi warning:
+    " Documentation in template xxx for ./tmpl/element-yyy:Short_Description
+      being overridden by inline comments"
+    per-default the description from the GST_ELEMENT_DETAILS is put to the
+    Short_Description. This warning mean you have a different one in the section
+    docs as "@short_description:".
 
 - the plugin-doc-list on the gstreamer homepage is updated along with other
   web site updates.

diff --git a/docs/design/part-states.txt b/docs/design/part-states.txt
index 0d80c55..38559de 100644 (file)
--- a/docs/design/part-states.txt
+++ b/docs/design/part-states.txt
@@ -76,6 +76,7 @@ the following state changes are possible:
  PAUSED -> READY
    - sinks unblock any waits in the preroll.
    - elements unblock any waits on devices
+   - elements close devices
    - chain or get_range functions return WRONG_STATE.
    - the element pads are deactivated so that streaming becomes impossible and
      all streaming threads are stopped. 

diff --git a/docs/manual/README b/docs/manual/README
index 6e1d5bd..e2c4ea6 100644 (file)
--- a/docs/manual/README
+++ b/docs/manual/README
@@ -32,6 +32,9 @@ not trivial.
 Before anything is done, the build-system copies all xml files into the build
 subdir and this breaks including shared docs via entities.
 
+The examples should be updated in the xml. We run a perlscript in
+tests/examples/manual that extracts them.
+
 Wtay's original comments :
 --------------------------
 

diff --git a/docs/manuals.mak b/docs/manuals.mak
index 46adda2..229969c 100644 (file)
--- a/docs/manuals.mak
+++ b/docs/manuals.mak
@@ -90,7 +90,7 @@ $(BUILDDIR)/$(MAIN): $(XML) $(CSS) $(EXTRA_SRC)
 # we should switch to xsltproc
 # docbook2html aka jade can't add the encoding easily to the html meta
 # jw -f docbook -b html -d pwg.dsl -o ../html -V '%use-id-as-filename%' $(MAIN)
-# this is a startng point
+# this is a starting point
 # xsltproc --nonet /usr/share/xml/docbook/stylesheet/nwalsh/html/docbook.xsl pwg.xml
 # 
 html/index.html: $(BUILDDIR)/$(MAIN) $(PNG_BUILT) $(FIG_SRC)