gegl r2300 - trunk/docs

[ok svn gnome org]

Author: ok
Date: Sat May 17 14:04:22 2008
New Revision: 2300
URL: http://svn.gnome.org/viewvc/gegl?rev=2300&view=rev

Log:
* index-static.txt.in: updated directory overview with examples and
tests directories also tagged other directories using wildcards with â
and documentating the autoinclusion of files to the build.
* hello-world-video.c: moved to examples.
* hello-world.c: moved to examples.
* Makefile.am: updated to no longer depend on the moved files.


Removed:
   trunk/docs/hello-world-video.c
   trunk/docs/hello-world.c
Modified:
   trunk/docs/ChangeLog
   trunk/docs/Makefile.am
   trunk/docs/index-static.txt.in

Modified: trunk/docs/Makefile.am
==============================================================================
--- trunk/docs/Makefile.am	(original)
+++ trunk/docs/Makefile.am	Sat May 17 14:04:22 2008
@@ -34,8 +34,6 @@
 	gegl.css  		\
 	gegl.devhelp		\
 	devhelp.css		\
-	hello-world.c		\
-	hello-world-video.c	\
 	index-static.txt.in	\
 	$(HTML_FILES)
 
@@ -80,9 +78,9 @@
 	  $(top_srcdir)/gegl/operation/gegl-operation.h\
 	  $(top_srcdir)/tools/create-reference.rb
 if HAVE_RUBY
-	$(top_srcdir)/tools/create-reference.rb \
-	    $(top_srcdir)/gegl/gegl.h\
-	    $(top_srcdir)/gegl/buffer/gegl-buffer.h\
+	$(top_srcdir)/tools/create-reference.rb 	\
+	    $(top_srcdir)/gegl/gegl.h			\
+	    $(top_srcdir)/gegl/buffer/gegl-buffer.h	\
 	    $(top_srcdir)/gegl/operation/gegl-operation.h $@
 endif
 
@@ -90,9 +88,9 @@
 	$(top_srcdir)/AUTHORS		\
 	gegl.css			\
 	$(top_srcdir)/NEWS		\
+	$(top_srcdir)/examples/hello-world.c \
 	$(top_builddir)/bin/gegl	\
-	Makefile.am			\
-	$(srcdir)/hello-world.c
+	Makefile.am
 if HAVE_ASCIIDOC
 	@echo "HTML: $@"
 	cp $< $@ 
@@ -112,8 +110,8 @@
 	$(INSTALL) -d $(help_dir)
 if HAVE_ENSCRIPT
 	$(INSTALL) $(srcdir)/brightness-contrast.c.html \
-	    $(srcdir)/gegl.h.html \
-	    $(srcdir)/gegl-operation.h.html \
+	    $(srcdir)/gegl.h.html 			\
+	    $(srcdir)/gegl-operation.h.html 		\
 	    $(srcdir)/gegl-plugin.h.html $(help_dir)
 endif
 if HAVE_RUBY
@@ -132,13 +130,6 @@
 endif
 	rm -f $(help_dir)/gegl.devhelp $(help_dir)/gegl.css
 
-hello-world: hello-world.c
-	$(CC) $< -o $@ `pkg-config --cflags --libs gegl`
-
-hello-world-video: hello-world-video.c
-	$(CC) $< -o $@ `pkg-config --cflags --libs gegl`
-
-
 # require asciidoc when making dist
 #
 dist-check-asciidoc:

Modified: trunk/docs/index-static.txt.in
==============================================================================
--- trunk/docs/index-static.txt.in	(original)
+++ trunk/docs/index-static.txt.in	Sat May 17 14:04:22 2008
@@ -196,7 +196,7 @@
 fractal
 
 ---------------------------
-sys::[cat hello-world.c]
+sys::[cat ../examples/hello-world.c]
 ---------------------------
 
  $ gcc hello-world.c `pkg-config --libs --cflags gegl` -o hello-world
@@ -386,6 +386,9 @@
 GEGL dirs
 ^^^^^^^^^
 
+Directories marked with â use GNU make extensions to include any .c file
+dropped into the directory in the build.
+
  gegl-dist-root
   â
   â
@@ -409,23 +412,32 @@
   â   âââproperty-types specialized classes/paramspecs for GeglOperation
   â                     properties.
   â
+  âââexamples â        hello-world and other example uses of the GEGL API.
+  â
+  âââtests             various tests used to maintain stability when developing
+  â                    GEGL.
+  â
   âââoperations        Runtime loaded plug-ins for image processing operations.
   â   â
-  â   âââcore          Basic operations tightly coupled with GEGL.
+  â   âââcore â        Basic operations tightly coupled with GEGL.
   â   âââaffine        Transforming operations (rotate/scale/translate)
-  â   âââgenerated     Operations generated from scripts (currently
+  â   âââgenerated â   Operations generated from scripts (currently
   â   âââexternal      Operations with external dependencies.
-  â   âââcommon        Other operations (drop .c files in here and they are built.)
-  â   âââworkshop      Works in progress, (you must pass --enable-workshop to configure
-  â       â            for the ops in here to be built.
+  â   âââcommon â      Other operations. 
+  â   âââworkshop â    Works in progress, (you must pass --enable-workshop 
+  â       â            when configurig to build these by default, you can enter
+  â       â            the directory manually and type make && sudo make install
+  â       â            as well.
   â       â
   â       âââexternal  operations in the workshop with external dependencies.
   â       âââgenerated generated operations that are in the workshop.
   â
   â
-  âââdocs              A website for GEGL
+  âââdocs              The GEGL website (this documentation), built for your
+  â   â                the corresponding sourcetree with correct documentation
+  â   â                etc.
   â   â
-  â   âââgallery       A gallery of sample GEGL compositions, using the
+  â   âââgallery â     A gallery of sample GEGL compositions, using the
   â       â            (not yet stabilized) XML format.
   â       â
   â       âââdata      Image data used by the sample compositions.