gst/gstelement.c: Clarify the use of _release_request_pad() and _get_request_pad...

Original commit message from CVS:
* gst/gstelement.c:
Clarify the use of _release_request_pad() and
_get_request_pad() a bit better.
* libs/gst/base/gstadapter.c: (gst_adapter_peek),
(gst_adapter_take_buffer):
Fix some doc and comment typos.

diff --git a/ChangeLog b/ChangeLog
index 7923bde..07aebfd 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,13 @@
+2006-05-30  Wim Taymans  <wim@fluendo.com>
+
+       * gst/gstelement.c:
+       Clarify the use of _release_request_pad() and
+       _get_request_pad() a bit better.
+
+       * libs/gst/base/gstadapter.c: (gst_adapter_peek),
+       (gst_adapter_take_buffer):
+       Fix some doc and comment typos.
+
 2006-05-30  Thomas Vander Stichele  <thomas (at) apestaart (dot) org>
 
        * docs/gst/gstreamer-sections.txt:

diff --git a/common b/common
index 2f06c5c..b0fd90b 160000 (submodule)
--- a/common
+++ b/common
@@ -1 +1 @@
-Subproject commit 2f06c5cbc778e158d2429b09efc6740ff5281295
+Subproject commit b0fd90b1cfb51107e8a511a1f3983a06bdd18638

diff --git a/gst/gstelement.c b/gst/gstelement.c
index 0d037fb..fea7773 100644 (file)
--- a/gst/gstelement.c
+++ b/gst/gstelement.c
@@ -675,6 +675,11 @@ no_direction:
  * Removes @pad from @element. @pad will be destroyed if it has not been
  * referenced elsewhere.
  *
+ * This function is used by plugin developers and should not be used
+ * by applications. Pads that were dynamically requested from elements
+ * with gst_element_get_request_pad() should be released with the
+ * gst_element_release_request_pad() function instead.
+ *
  * Returns: TRUE if the pad could be removed. Can return FALSE if the
  * pad is not belonging to the provided element.
  *
@@ -847,7 +852,8 @@ gst_element_request_pad (GstElement * element, GstPadTemplate * templ,
  * @name: the name of the request #GstPad to retrieve.
  *
  * Retrieves a pad from the element by name. This version only retrieves
- * request pads.
+ * request pads. The pad should be released with 
+ * gst_element_release_request_pad().
  *
  * Returns: requested #GstPad if found, otherwise NULL. Unref after usage.
  */

diff --git a/libs/gst/base/gstadapter.c b/libs/gst/base/gstadapter.c
index 455a03f..30ad670 100644 (file)
--- a/libs/gst/base/gstadapter.c
+++ b/libs/gst/base/gstadapter.c
@@ -1,5 +1,6 @@
 /* GStreamer
  * Copyright (C) 2004 Benjamin Otte <otte@gnome.org>
+ *               2005 Wim Taymans <wim@fluendo.com>
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public
@@ -89,7 +90,7 @@
  * access the buffer later. The adapter will never modify the data in the
  * buffer pushed in it.
  *
- * Last reviewed on 2006-03-07 (0.10.4).
+ * Last reviewed on 2006-04-04 (0.10.6).
  */
 
 
@@ -236,7 +237,7 @@ gst_adapter_peek (GstAdapter * adapter, guint size)
   g_return_val_if_fail (size > 0, NULL);
 
   /* we don't have enough data, return NULL. This is unlikely
-   * as one usually does a _available() first instead of peeking a
+   * as one usually does an _available() first instead of peeking a
    * random size. */
   if (G_UNLIKELY (size > adapter->size))
     return NULL;