From c802bc7c26f98a9c74c0680ddce0b0ce3ad2bf2a Mon Sep 17 00:00:00 2001
From: reynaldo <reynaldo@opendot.cl>
Date: Tue, 9 Nov 2010 23:27:17 -0300
Subject: [PATCH] docs: some small fixes to the plugin writer's guide

Fix wrongly placed example and weirdly phrased 'note' lacking proper
formatting. Fix missing hint for autogen.sh location and rephrase
'built and installed' sentence. Fix wrongly phrased and redundant
paragraph in PWG

https://bugzilla.gnome.org/show_bug.cgi?id=634921
---
 docs/pwg/building-boiler.xml | 27 ++++++++++++++++-----------
 1 file changed, 16 insertions(+), 11 deletions(-)

diff --git a/docs/pwg/building-boiler.xml b/docs/pwg/building-boiler.xml
index ef0fb01aed..49da6c86fd 100644
--- a/docs/pwg/building-boiler.xml
+++ b/docs/pwg/building-boiler.xml
@@ -95,17 +95,22 @@ Resolving deltas: 100% (240/240), done.
       </listitem>
     </orderedlist>
     <para>
-      Note that capitalization is important for the name of the plugin. Under
-      some operating systems, capitalization is also important when specifying
-      directory names. For example, the following commands create the
-      MyFilter plugin based on the plugin template and put the output files
-      in the <filename class="directory">gst-template/gst-plugin/src</filename>
+      For example, the following commands create the MyFilter plugin based on
+      the plugin template and put the output files in the
+      <filename class="directory">gst-template/gst-plugin/src</filename>
       directory:
     </para>
     <screen>
 <prompt>shell $ </prompt><userinput>cd gst-template/gst-plugin/src</userinput>
 <prompt>shell $ </prompt><userinput>../tools/make_element MyFilter</userinput>
     </screen>
+    <note>
+      <para>
+        Capitalization is important for the name of the plugin. Keep in mind
+        that under some operating systems, capitalization is also important
+        when specifying directory and file names in general.
+      </para>
+    </note>
     <para>
       The last command creates two files:
       <filename>gstexamplefilter.c</filename> and
@@ -120,9 +125,10 @@ Resolving deltas: 100% (240/240), done.
     </note>
     <para>
       Now one needs to adjust the <filename>Makefile.am</filename> to use the
-      new filenames and run <filename>autogen.sh</filename> to bootstrap the
-      build environment. After that the project can be built using the well
-      known <userinput>make &amp;&amp; sudo make install</userinput>. 
+      new filenames and run <filename>autogen.sh</filename> from the parent
+      directory to bootstrap the build environment. After that, the project
+      can be built and installed using the well known
+      <userinput>make &amp;&amp; sudo make install</userinput> commands.
     </para>
     <note>
       <para>
@@ -209,9 +215,8 @@ GST_BOILERPLATE (GstMyFilter, gst_my_filter, GstElement, GST_TYPE_ELEMENT);
   <sect1 id="section-boiler-details">
     <title>GstElementDetails</title>
     <para>
-      The GstElementDetails structure gives a hierarchical type for the element,
-      a human-readable description of the element, as well as author and version
-      data. The entries are:
+      The GstElementDetails structure provides a hierarchical type for element
+      information. The entries are:
     </para>
     <itemizedlist>
       <listitem><para>