From e126aa34c312ff3bd502ec15347fcf98ed0b3689 Mon Sep 17 00:00:00 2001 From: Vincent Torri Date: Thu, 9 Feb 2006 23:40:43 +0000 Subject: [PATCH] docs/pwg/building-boiler.xml: Original commit message from CVS: * docs/pwg/building-boiler.xml: PWG patch from #326800 (Patch by Vincent Torri) --- ChangeLog | 5 +++++ docs/pwg/building-boiler.xml | 33 ++++++++++++++++++--------------- 2 files changed, 23 insertions(+), 15 deletions(-) diff --git a/ChangeLog b/ChangeLog index 36e0e01f7f..3c4936f9e3 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2006-02-10 Jan Schmidt + + * docs/pwg/building-boiler.xml: + PWG patch from #326800 (Patch by Vincent Torri) + 2006-02-09 Tim-Philipp Müller * configure.ac: diff --git a/docs/pwg/building-boiler.xml b/docs/pwg/building-boiler.xml index ee9240875b..b98de37d76 100644 --- a/docs/pwg/building-boiler.xml +++ b/docs/pwg/building-boiler.xml @@ -80,18 +80,16 @@ U gst-template/gst-app/src/Makefile.am The standard way of defining the boilerplate is simply to write some code, and fill in some structures. As mentioned in the previous section, the easiest way to do this is to copy a template and add functionality - according to your needs. To help you do so, there are some tools in the + according to your needs. To help you do so, there is a tool in the ./gst-plugins/tools/ directory. - One tool, gst-quick-stamp, is a quick command line - tool. The other, gst-project-stamp, is a full GNOME - druid application that takes you through the steps of creating a new - project (either a plugin or an application). + This tool, make_element, is a quick command line + tool. - To use pluginstamp.sh, first open up a terminal window. - Change to the gst-template - directory, and then run the pluginstamp.sh command. The - arguments to the pluginstamp.sh are: + To use make_element, first open up a terminal window. + Change to the gst-template/gst-plugin/src + directory, and then run the make_element command. The + arguments to the make_element are: @@ -99,8 +97,8 @@ U gst-template/gst-app/src/Makefile.am - the directory that should hold a new subdirectory for the source tree - of the plugin. + the source file that the tool will use. By default, + gstplugin.{c,h} is used. @@ -109,13 +107,18 @@ U gst-template/gst-app/src/Makefile.am some operating systems, capitalization is also important when specifying directory names. For example, the following commands create the ExampleFilter plugin based on the plugin template and put the output files - in a new directory called ~/src/examplefilter/: + in the gst-template/gst-plugin/src + directory: -shell $ cd gst-template -shell $ tools/pluginstamp.sh ExampleFilter ~/src +shell $ cd gst-template/gst-plugin/src +shell $ ../tools/make_element ExampleFilter + + The last command creates two files: + gstexamplefilter.c and + gstexamplefilter.h. +