maintenance updates

Original commit message from CVS:
maintenance updates
This commit is contained in:
Thomas Vander Stichele 2005-09-05 11:54:55 +00:00
parent 84eff26876
commit e7164d4b1e
7 changed files with 41 additions and 11 deletions

2
check/generic/.gitignore vendored Normal file
View file

@ -0,0 +1,2 @@
.dirstamp
states

View file

@ -6,6 +6,7 @@ gstbus
gstcaps gstcaps
gstdata gstdata
gstelement gstelement
gstevent
gstghostpad gstghostpad
gstiterator gstiterator
gstmessage gstmessage

View file

@ -145,15 +145,34 @@ GTK-DOC NOTES
in the project root to find them in the project root to find them
* what happens during a gtk-doc build ? * what happens during a gtk-doc build ?
- headers are scanned based on $(MODULE).types - Scan step:
$(MODULE)-scan is created - based on a $(MODULE).types file:
gtkdoc-scan is called with a sourcedir and a module name, - gtkdoc-scangobj creates a gtkdoc-scan binary
where the module name is $(MODULE) - using CC, LD, CFLAGS, LDFLAGS env var
$(MODULE)-sections.txt is created if it doesn't exist yet (it should), - using --type-init-func and --module parameters
as well as $(MODULE)-decl.txt and $(MODULE)-decl-list.txt - gtkdoc-scan creates
and .args, .hierarchy and .signals files are created - $MODULE.signals.new
gtkdoc-scan is called - $MODULE.hierarchy.new
- if it not works, try e.g. 'rm docs/gst/*.stamp' - $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 * Possible errors and how to fix them
- Warning: multiple "IDs" for constraint linkend: gst-tag-register. - 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) resolves single files to $(specified_path)/$(srcdir)/$(file)
For now, we need to hack around it by copying xml to the build dir. For now, we need to hack around it by copying xml to the build dir.

View file

@ -1,8 +1,8 @@
boilerplate.c boilerplate.c
caps.func caps.func
chain2.c
chain.c chain.c
chain.func chain.func
chain2.c
convertcaps.c convertcaps.c
filter.h filter.h
forwardcaps.c forwardcaps.c
@ -10,7 +10,9 @@ getcaps.c
init.func init.func
pads.c pads.c
properties.c properties.c
range.c
register.func register.func
state.c state.c
state.func state.func
task.c
test.c test.c

2
tests/check/generic/.gitignore vendored Normal file
View file

@ -0,0 +1,2 @@
.dirstamp
states

View file

@ -6,6 +6,7 @@ gstbus
gstcaps gstcaps
gstdata gstdata
gstelement gstelement
gstevent
gstghostpad gstghostpad
gstiterator gstiterator
gstmessage gstmessage

View file

@ -1,8 +1,8 @@
boilerplate.c boilerplate.c
caps.func caps.func
chain2.c
chain.c chain.c
chain.func chain.func
chain2.c
convertcaps.c convertcaps.c
filter.h filter.h
forwardcaps.c forwardcaps.c
@ -10,7 +10,9 @@ getcaps.c
init.func init.func
pads.c pads.c
properties.c properties.c
range.c
register.func register.func
state.c state.c
state.func state.func
task.c
test.c test.c