maintenance updates
authorThomas Vander Stichele <thomas@apestaart.org>
Mon, 5 Sep 2005 11:54:55 +0000 (11:54 +0000)
committerThomas Vander Stichele <thomas@apestaart.org>
Mon, 5 Sep 2005 11:54:55 +0000 (11:54 +0000)
Original commit message from CVS:
maintenance updates

check/generic/.gitignore [new file with mode: 0644]
check/gst/.gitignore
docs/README
examples/pwg/.gitignore
tests/check/generic/.gitignore [new file with mode: 0644]
tests/check/gst/.gitignore
tests/old/examples/pwg/.gitignore

diff --git a/check/generic/.gitignore b/check/generic/.gitignore
new file mode 100644 (file)
index 0000000..b9eed5c
--- /dev/null
@@ -0,0 +1,2 @@
+.dirstamp
+states
index fe647a5..c8990c5 100644 (file)
@@ -6,6 +6,7 @@ gstbus
 gstcaps
 gstdata
 gstelement
+gstevent
 gstghostpad
 gstiterator
 gstmessage
index a8eb18e..d68c809 100644 (file)
@@ -145,15 +145,34 @@ GTK-DOC NOTES
     in the project root to find them
 
 * what happens during a gtk-doc build ?
-  - headers are scanned based on $(MODULE).types
-    $(MODULE)-scan is created
-    gtkdoc-scan is called with a sourcedir and a module name,
-    where the module name is  $(MODULE)
-    $(MODULE)-sections.txt is created if it doesn't exist yet (it should),
-    as well as $(MODULE)-decl.txt and $(MODULE)-decl-list.txt
-    and .args, .hierarchy and .signals files are created
-    gtkdoc-scan is called
-  - if it not works, try e.g. 'rm docs/gst/*.stamp'
+  - Scan step:
+    - based on a $(MODULE).types file:
+      - gtkdoc-scangobj creates a gtkdoc-scan binary
+        - using CC, LD, CFLAGS, LDFLAGS env var
+        - using --type-init-func and --module parameters
+        - gtkdoc-scan creates
+          - $MODULE.signals.new
+          - $MODULE.hierarchy.new
+          - $MODULE.interfaces.new
+          - $MODULE.prerequisites.new
+          - $MODULE.args.new
+        - generated source and objects get deleted
+        - gtkdoc-scangobj merges changes into the original files
+    - gtkdoc-scan
+      - extracts decls of functions, macros, enums, structs, unions from headers
+      - generates
+        - $MODULE-decl.txt
+        - $MODULE-decl-list.txt
+      - $MODULE-decl-list.txt then should get copied to $MODULE-sections.txt
+    - scan-build.stamp gets created
+  
+  - Template generation step:
+    - gtkdoc-mktmpl --module=$MODULE
+      - reads in tmpl/*.sgml
+      - moves them to tmpl/*.sgml.bak
+      - recreates tmpl/*.sgml according to $MODULE-sections.txt
+      - moves unused stuff to $MODULE-unused.txt
+    - tmpl-build.stamp gets generated
 
 * Possible errors and how to fix them
   - Warning: multiple "IDs" for constraint linkend: gst-tag-register.
@@ -186,3 +205,4 @@ RANDOM THINGS I'VE LEARNED
   resolves single files to $(specified_path)/$(srcdir)/$(file)
   For now, we need to hack around it by copying xml to the build dir.
 
+
index f52094c..14c2d7a 100644 (file)
@@ -1,8 +1,8 @@
 boilerplate.c
 caps.func
+chain2.c
 chain.c
 chain.func
-chain2.c
 convertcaps.c
 filter.h
 forwardcaps.c
@@ -10,7 +10,9 @@ getcaps.c
 init.func
 pads.c
 properties.c
+range.c
 register.func
 state.c
 state.func
+task.c
 test.c
diff --git a/tests/check/generic/.gitignore b/tests/check/generic/.gitignore
new file mode 100644 (file)
index 0000000..b9eed5c
--- /dev/null
@@ -0,0 +1,2 @@
+.dirstamp
+states
index fe647a5..c8990c5 100644 (file)
@@ -6,6 +6,7 @@ gstbus
 gstcaps
 gstdata
 gstelement
+gstevent
 gstghostpad
 gstiterator
 gstmessage
index f52094c..14c2d7a 100644 (file)
@@ -1,8 +1,8 @@
 boilerplate.c
 caps.func
+chain2.c
 chain.c
 chain.func
-chain2.c
 convertcaps.c
 filter.h
 forwardcaps.c
@@ -10,7 +10,9 @@ getcaps.c
 init.func
 pads.c
 properties.c
+range.c
 register.func
 state.c
 state.func
+task.c
 test.c