From: Luc Pionchon Date: Tue, 24 Jun 2008 19:56:51 +0000 (+0000) Subject: docs/manual/: Typo and formatting fixes (#538594). X-Git-Tag: RELEASE-0_10_21~132 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=7dd35f98f723b6a069d9138535b6907c1f5bbbee;p=platform%2Fupstream%2Fgstreamer.git docs/manual/: Typo and formatting fixes (#538594). Original commit message from CVS: Patch by: Luc Pionchon * docs/manual/appendix-integration.xml: * docs/manual/appendix-licensing.xml: * docs/manual/basics-elements.xml: * docs/manual/basics-helloworld.xml: * docs/manual/basics-pads.xml: * docs/manual/highlevel-components.xml: * docs/manual/highlevel-xml.xml: * docs/manual/intro-basics.xml: * docs/manual/intro-preface.xml: Typo and formatting fixes (#538594). --- diff --git a/ChangeLog b/ChangeLog index 3671f85..3de3107 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,18 @@ +2008-06-24 Tim-Philipp Müller + + Patch by: Luc Pionchon + + * docs/manual/appendix-integration.xml: + * docs/manual/appendix-licensing.xml: + * docs/manual/basics-elements.xml: + * docs/manual/basics-helloworld.xml: + * docs/manual/basics-pads.xml: + * docs/manual/highlevel-components.xml: + * docs/manual/highlevel-xml.xml: + * docs/manual/intro-basics.xml: + * docs/manual/intro-preface.xml: + Typo and formatting fixes (#538594). + 2008-06-24 Sebastian Dröge * tests/check/gst/gstghostpad.c: (GST_START_TEST): diff --git a/docs/manual/appendix-integration.xml b/docs/manual/appendix-integration.xml index 0979601..3e764e5 100644 --- a/docs/manual/appendix-integration.xml +++ b/docs/manual/appendix-integration.xml @@ -86,7 +86,7 @@ static GOptionEntries cmd_options[] = { * example of how to add your own command line options here */ /* at the end we have a special option that collects all remaining - * command line arguments (like filenames) for us. If you don' + * command line arguments (like filenames) for us. If you don't * need this, you can safely remove it */ { G_OPTION_REMAINING, 0, 0, G_OPTION_ARG_FILENAME_ARRAY, &cmd_filenames, "Special option that collects any remaining arguments for us" }, diff --git a/docs/manual/appendix-licensing.xml b/docs/manual/appendix-licensing.xml index 57c496f..128a6cc 100644 --- a/docs/manual/appendix-licensing.xml +++ b/docs/manual/appendix-licensing.xml @@ -55,7 +55,7 @@ for wider use of free formats like the Xiph.org formats. If you do decide that you want to allow for non-free plugins to be used with your application you have a variety of choices. One of the simplest is using licenses like LGPL, MPL or BSD for your application instead of -the GPL. Or you can add a exceptions clause to your GPL license stating +the GPL. Or you can add an exception clause to your GPL license stating that you except GStreamer plugins from the obligations of the GPL. @@ -77,7 +77,7 @@ exception clause and thus code can be shared more freely. I have above outlined the practical reasons for why the GStreamer -community suggest you allow non-free plugins to be used with your +community suggests you allow non-free plugins to be used with your applications. We feel that in the multimedia arena, the free software community is still not strong enough to set the agenda and that blocking non-free plugins to be used in our infrastructure hurts us more than it diff --git a/docs/manual/basics-elements.xml b/docs/manual/basics-elements.xml index cc88d13..05e91a6 100644 --- a/docs/manual/basics-elements.xml +++ b/docs/manual/basics-elements.xml @@ -16,7 +16,7 @@ For the application programmer, elements are best visualized as black boxes. On the one end, you might put something in, the element does something with it and something else comes out at the other side. For - a decoder element, ifor example, you'd put in encoded data, and the + a decoder element, for example, you'd put in encoded data, and the element would output decoded data. In the next chapter (see ), you will learn more about data input and output in elements, and how you can set that up in your application. @@ -292,7 +292,7 @@ main (int argc, GstElement also provides various GObject signals that can be used as a flexible callback mechanism. Here, too, you can use gst-inspect - to see which signals a specific elements supports. Together, signals + to see which signals a specific element supports. Together, signals and properties are the most basic way in which elements and applications interact. diff --git a/docs/manual/basics-helloworld.xml b/docs/manual/basics-helloworld.xml index 5aa9f12..2bb1db2 100644 --- a/docs/manual/basics-helloworld.xml +++ b/docs/manual/basics-helloworld.xml @@ -30,7 +30,7 @@ audio player, we'll need a source element that reads files from a disk. &GStreamer; includes this element under the name filesrc. Next, we'll need something to parse the - file and decoder it into raw audio. &GStreamer; has two elements + file and decode it into raw audio. &GStreamer; has two elements for this: the first parses Ogg streams into elementary streams (video, audio) and is called oggdemux. The second is a Vorbis audio decoder, it's conveniently called vorbisdec. @@ -156,7 +156,7 @@ main (int argc, source, parser, decoder, conv, sink, NULL); /* link together - note that we cannot link the parser and - * decoder yet, becuse the parser uses dynamic pads. For that, + * decoder yet, because the parser uses dynamic pads. For that, * we set a pad-added signal handler. */ gst_element_link (source, parser); gst_element_link_many (decoder, conv, sink, NULL); diff --git a/docs/manual/basics-pads.xml b/docs/manual/basics-pads.xml index cad954c..be317a6 100644 --- a/docs/manual/basics-pads.xml +++ b/docs/manual/basics-pads.xml @@ -537,7 +537,7 @@ link_elements_with_filter (GstElement *element1, GstElement *element2) return link_ok; } - This will force the data flow between those two elements to a + This will force the data flow between those two elements to a certain video format, width, height and framerate (or the linking will fail if that cannot be achieved in the context of the elments involved). Keep in mind that when you use diff --git a/docs/manual/highlevel-components.xml b/docs/manual/highlevel-components.xml index 15adbe7..4f8a871 100644 --- a/docs/manual/highlevel-components.xml +++ b/docs/manual/highlevel-components.xml @@ -2,8 +2,8 @@ Components - &GStreamer; includes several higher-level components to simplify your - applications life. All of the components discussed here (for now) are + &GStreamer; includes several higher-level components to simplify an + application developer's life. All of the components discussed here (for now) are targetted at media playback. The idea of each of these components is to integrate as closely as possible with a &GStreamer; pipeline, but to hide the complexity of media type detection and several other @@ -17,7 +17,7 @@ linkend="section-components-decodebin"/>), depending on their needs. Playbin is the recommended solution for everything related to simple playback of media that should just work. Decodebin is a more flexible - autoplugger that could be used to add more advanced featuers, such + autoplugger that could be used to add more advanced features, such as playlist support, crossfading of audio tracks and so on. Its programming interface is more low-level than that of playbin, though. @@ -37,11 +37,11 @@ Setting up a playbin pipeline is as simple as creating an instance of - the playbin element, setting a file location (this has to be a valid - URI, so <protocol>://<location>, e.g. - file:///tmp/my.ogg or http://www.example.org/stream.ogg) using the + the playbin element, setting a file location using the uri property on playbin, and then setting the element - to the GST_STATE_PLAYING state. Internally, + to the GST_STATE_PLAYING state (the location has to be a valid + URI, so <protocol>://<location>, e.g. + file:///tmp/my.ogg or http://www.example.org/stream.ogg). Internally, playbin will set up a pipeline to playback the media location. diff --git a/docs/manual/highlevel-xml.xml b/docs/manual/highlevel-xml.xml index a43ff16..04cf7f9 100644 --- a/docs/manual/highlevel-xml.xml +++ b/docs/manual/highlevel-xml.xml @@ -137,8 +137,8 @@ main(int argc, char *argv[]) in the XML file. - In addition to loading a file, you can also load a from a xmlDocPtr and - an in memory buffer using gst_xml_parse_doc and gst_xml_parse_memory + In addition to loading a file, you can also load from a xmlDocPtr and + an in-memory buffer using gst_xml_parse_doc and gst_xml_parse_memory respectively. Both of these methods return a gboolean indicating success or failure of the requested action. diff --git a/docs/manual/intro-basics.xml b/docs/manual/intro-basics.xml index df50469..3d65002 100644 --- a/docs/manual/intro-basics.xml +++ b/docs/manual/intro-basics.xml @@ -31,7 +31,7 @@ A bin is a container for a collection of elements. A pipeline is a special subtype of a bin that allows execution of all of its contained child elements. Since bins are subclasses of elements - themselves, you can mostly control a bin as if it where an element, + themselves, you can mostly control a bin as if it were an element, thereby abstracting away a lot of complexity for your application. You can, for example change state on all elements in a bin by changing the state of that bin itself. Bins also forward bus messages from their diff --git a/docs/manual/intro-preface.xml b/docs/manual/intro-preface.xml index 94aee6c..c8e7992 100644 --- a/docs/manual/intro-preface.xml +++ b/docs/manual/intro-preface.xml @@ -56,9 +56,9 @@ - Who Should Read This Manual? + Who should read this manual? - This book is about &GStreamer; from a developer's point of view; it + This book is about &GStreamer; from an application developer's point of view; it describes how to write a &GStreamer; application using the &GStreamer; libraries and tools. For an explanation about writing plugins, we suggest the - Preliminary Reading + Preliminary reading In order to understand this manual, you will need to have a basic understanding of the C language. @@ -92,7 +92,7 @@ - Structure of this Manual + Structure of this manual To help you navigate through this guide, it is divided into several large parts. Each part addresses a particular broad topic concerning &GStreamer; @@ -112,7 +112,7 @@ - In , we will move on to complicated + In , we will move on to advanced subjects which make &GStreamer; stand out of its competitors. We will discuss application-pipeline interaction using dynamic parameters and interfaces, we will discuss threading and threaded pipelines,