[gtk-doc] mkdb: add internal hack to print syms with no since:
- From: Stefan Kost <stefkost src gnome org>
- To: svn-commits-list gnome org
- Subject: [gtk-doc] mkdb: add internal hack to print syms with no since:
- Date: Tue, 14 Jul 2009 15:14:21 +0000 (UTC)
commit 75c889a6545173c188ba4ee32e714befb5d7baef
Author: Stefan Kost <ensonic users sf net>
Date: Fri Jul 10 18:47:21 2009 +0100
mkdb: add internal hack to print syms with no since:
Allow printing a list of symbols without since tags and add ideas how to figure
the needed info using git bisect.
TODO | 16 +++++++++++++++-
gtkdoc-mkdb.in | 47 ++++++++++++++++++++++++++++++++++++++++-------
2 files changed, 55 insertions(+), 8 deletions(-)
---
diff --git a/TODO b/TODO
index 353e039..7dc9979 100644
--- a/TODO
+++ b/TODO
@@ -16,7 +16,7 @@ and join discussion about future features.
Developers can also add items here :)
-= CLeanups =
+= Cleanups =
== Tracing ==
* there is a bunch of #print statements for tracing
=> add a sub Trace() to gtkdoc-common.pl
@@ -346,3 +346,17 @@ problems:
- support for xi:included examples
- updating the checkout could be slow
+= fix missing since docs =
+cd gstreamer/gstreamer/docs/gst
+gtkdoc-mkdb --module=gstreamer --source-dir=../../gst --outputsymbolswithoutsince
+cd gstreamer/gstreamer/src
+git bisect start
+git bisect good
+git bisect bad RELEASE-0_10_0
+git bisect run script.sh
+
+script:
+#!/bin/sh
+make ctags
+grep "gst_caps_is_always_compatible" tags
+
diff --git a/gtkdoc-mkdb.in b/gtkdoc-mkdb.in
index 08ef5c0..9cfd4cf 100755
--- a/gtkdoc-mkdb.in
+++ b/gtkdoc-mkdb.in
@@ -47,7 +47,6 @@ my $SOURCE_SUFFIXES = "";
my $IGNORE_FILES = "";
my $PRINT_VERSION;
my $PRINT_HELP;
-my $OUTPUT_ALL_SYMBOLS;
my $MAIN_SGML_FILE;
my $EXPAND_CONTENT_FILES = "";
my $SGML_MODE;
@@ -55,6 +54,8 @@ my $DEFAULT_STABILITY;
my $DEFAULT_INCLUDES;
my $OUTPUT_FORMAT;
my $NAME_SPACE = "";
+my $OUTPUT_ALL_SYMBOLS;
+my $OUTPUT_SYMBOLS_WITHOUT_SINCE;
my %optctl = ('module' => \$MODULE,
'source-dir' => \ SOURCE_DIRS,
@@ -66,17 +67,20 @@ my %optctl = ('module' => \$MODULE,
'help' => \$PRINT_HELP,
'main-sgml-file' => \$MAIN_SGML_FILE,
'expand-content-files' => \$EXPAND_CONTENT_FILES,
- 'outputallsymbols' => \$OUTPUT_ALL_SYMBOLS,
'sgml-mode' => \$SGML_MODE,
'default-stability' => \$DEFAULT_STABILITY,
'default-includes' => \$DEFAULT_INCLUDES,
'output-format' => \$OUTPUT_FORMAT,
- 'name-space' => \$NAME_SPACE);
+ 'name-space' => \$NAME_SPACE,
+ 'outputallsymbols' => \$OUTPUT_ALL_SYMBOLS,
+ 'outputsymbolswithoutsince' => \$OUTPUT_SYMBOLS_WITHOUT_SINCE
+ );
GetOptions(\%optctl, "module=s", "source-dir:s", "source-suffixes:s",
"ignore-files:s", "output-dir:s", "tmpl-dir:s", "version", "outputallsymbols",
- "expand-content-files:s", "main-sgml-file:s", "extra-db-files:s", "help",
- "sgml-mode", "default-stability:s", "default-includes:s", "output-format:s",
- "name-space:s");
+ "outputsymbolswithoutsince",
+ "expand-content-files:s", "main-sgml-file:s", "extra-db-files:s", "help",
+ "sgml-mode", "default-stability:s", "default-includes:s", "output-format:s",
+ "name-space:s");
if ($PRINT_VERSION) {
print "@VERSION \n";
@@ -827,6 +831,9 @@ EOF
if ($OUTPUT_ALL_SYMBOLS) {
&OutputAllSymbols;
}
+ if ($OUTPUT_SYMBOLS_WITHOUT_SINCE) {
+ &OutputSymbolsWithoutSince;
+ }
for $filename (split (' ', $EXPAND_CONTENT_FILES)) {
my $file_changed = &OutputExtraFile ($filename);
@@ -3849,7 +3856,33 @@ sub OutputAllSymbols {
|| die "Can't create $ROOT_DIR/$MODULE-symbols.txt: $!";
foreach $symbol (sort (keys (%AllSymbols))) {
- print SYMBOLS $symbol . "\n"
+ print SYMBOLS $symbol . "\n";
+ }
+
+ close (SYMBOLS);
+}
+
+#############################################################################
+# Function : OutputSymbolsWithoutSince
+# Description : Outputs list of all symbols without a since tag to a file
+#
+# Arguments : none
+#############################################################################
+
+sub OutputSymbolsWithoutSince {
+ my $n_documented = 0;
+ my $total = 0;
+ my $symbol;
+ my $percent;
+ my $msg;
+
+ open (SYMBOLS, ">$ROOT_DIR/$MODULE-nosince.txt")
+ || die "Can't create $ROOT_DIR/$MODULE-nosince.txt: $!";
+
+ foreach $symbol (sort (keys (%SourceSymbolDocs))) {
+ if (!defined $Since{$symbol}) {
+ print SYMBOLS $symbol . "\n";
+ }
}
close (SYMBOLS);
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]