sr-dev

sr-dev@lists.kamailio.org

44307 discussions

git:andrei/cdefs2doc: doc: dump_selects.pl: support for docbook output

by Andrei Pelinescu-Onciul

Module: sip-router Branch: andrei/cdefs2doc Commit: 088a8a7c3214823a16f55f95b90aa6071721b49b URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=088a8a7… Author: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Committer: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Date: Thu Feb 18 12:31:59 2010 +0100 doc: dump_selects.pl: support for docbook output Added support for generating docbook output (by using the --docbook option). --- doc/scripts/cdefs2doc/dump_selects.pl | 100 ++++++++++++++++++++++++++++++--- 1 files changed, 91 insertions(+), 9 deletions(-) diff --git a/doc/scripts/cdefs2doc/dump_selects.pl b/doc/scripts/cdefs2doc/dump_selects.pl index 5de697e..84a1cda 100755 --- a/doc/scripts/cdefs2doc/dump_selects.pl +++ b/doc/scripts/cdefs2doc/dump_selects.pl @@ -63,8 +63,12 @@ my @core_exports; # filled with select definitions from core (if -c is used) my ($sel_grp_name, $sel_var_name); my ($opt_help, $opt_txt, $opt_is_tu, $dbg, $opt_grp_name, $opt_patch); -my $opt_force_grp_name; +my ($opt_force_grp_name, $opt_docbook); +# default output formats +my $output_format_header="HEADER"; +my $output_format_footer="FOOTER"; +my $output_format_selline="SELLINE"; sub show_patch @@ -113,6 +117,7 @@ Options: is autodetected (see also -g). --gcc gcc_name - run gcc_name instead of gcc. -t | --txt - text mode output. + --docbook | --xml - docbook output (xml). -T | --tu - the input file is in raw gcc translation unit format (as produced by gcc -fdump-translation-unit -c ). If not @@ -128,6 +133,37 @@ Options: } + + +# escape a string for xml use +# params: string to be escaped +# return: escaped string +sub xml_escape{ + my $s=shift; + my %escapes = ( + '"' => '"', + "'" => ''', + '&' => '&', + '<' => '<', + '>' => '>' + ); + + $s=~s/(["'&<>])/$escapes{$1}/g; + return $s; +} + + + +# escape a string according with the output requirements +# params: string to be escaped +# return: escaped string +sub output_esc{ + return xml_escape(shift) if defined $opt_docbook; + return shift; +} + + + # eliminate casts and expressions. # (always go on the first operand) # params: node (GCC::Node) @@ -454,6 +490,7 @@ if ($#ARGV < 0 || ! GetOptions( 'help|h|?' => \$opt_help, 'file|f=s' => \$file, 'core|c=s' => \$core_file, 'txt|t' => \$opt_txt, + 'docbook|xml' => \$opt_docbook, 'tu|T' => \$opt_is_tu, 'source|src|s=s' => \$src_fname, 'defs|d=s'=>\$c_defs, @@ -473,6 +510,16 @@ if ($#ARGV < 0 || ! GetOptions( 'help|h|?' => \$opt_help, do { show_patch(); exit 0; } if (defined $opt_patch); do { select(STDERR); help(); exit 1 } if (!defined $file); +if (defined $opt_txt){ + $output_format_header="HEADER"; + $output_format_footer="FOOTER"; + $output_format_selline="SELLINE"; +}elsif (defined $opt_docbook){ + $output_format_header="DOCBOOK_HEADER"; + $output_format_footer="DOCBOOK_FOOTER"; + $output_format_selline="DOCBOOK_SELLINE"; +} + process_file($file, \@sel_exports, defined $opt_is_tu); process_file($core_file, \@core_exports, 0) if (defined $core_file); print(STDERR "Done.\n") if $dbg; @@ -485,23 +532,24 @@ if (@sel_exports > 0){ $i=0; # dump the configuration in txt mode if (defined $opt_force_grp_name) { - $sel_grp_name=$opt_force_grp_name; + $sel_grp_name=output_esc($opt_force_grp_name); }elsif (!defined $sel_grp_name && defined $opt_grp_name) { - $sel_grp_name=$opt_grp_name; + $sel_grp_name=output_esc($opt_grp_name); } print(STDERR "Generating select list...\n") if $dbg; my @sels = gen_selects "0"; - $~ = "HEADER"; write; - $~ = "SELLINE" ; + $~ = $output_format_header; write; + $~ = $output_format_selline ; for $s (@sels){ - $extra_txt=""; - $desc=""; - $name=$s; + $extra_txt=output_esc(""); + $desc=output_esc(""); + $name=output_esc($s); $i++; - #$extra_txt.="Returns an array." if ($flags & 1 ); + #$extra_txt.=output_esc("Returns an array.") if ($flags & 1 ); # generate txt description write; } + $~ = $output_format_footer; write; }else{ die "no selects found in $file\n"; } @@ -526,6 +574,9 @@ Selects@* . +format FOOTER = +. + format SELLINE = @>>. @* $i, $name @@ -534,3 +585,34 @@ $i, $name ~~ ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< $extra_txt . + + +format DOCBOOK_HEADER = +<?xml version="1.0" encoding="UTF-8"?> + +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<chapter id="select_list@*"> +(valid_grp_name $sel_grp_name) ? "." . $sel_grp_name : "" + <title>Selects List@*</title> +(valid_grp_name $sel_grp_name) ? " for " . $sel_grp_name : "" + <orderedlist> + + +. + +format DOCBOOK_FOOTER = + </orderedlist> +</chapter> +. + +format DOCBOOK_SELLINE = + <listitem>@* + $name +~~<para>^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< </para> + $desc +~~<para>^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< </para> + $extra_txt + </listitem> + +.

14 years, 11 months

git:andrei/cdefs2doc: doc: select_list: generated docbook and txt lists

by Andrei Pelinescu-Onciul

Module: sip-router Branch: andrei/cdefs2doc Commit: 1993e8e3f2c3a52e0a22e04871bde80bed4cfec5 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=1993e8e… Author: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Committer: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Date: Thu Feb 18 15:19:53 2010 +0100 doc: select_list: generated docbook and txt lists --- doc/select_list/docbook/select_avp.xml | 29 + doc/select_list/docbook/select_core.xml | 1478 ++++++++++++++++++++++++++ doc/select_list/docbook/select_db_ops.xml | 359 +++++++ doc/select_list/docbook/select_eval.xml | 155 +++ doc/select_list/docbook/select_list.xml | 25 + doc/select_list/docbook/select_nathelper.xml | 50 + doc/select_list/docbook/select_rr.xml | 14 + doc/select_list/docbook/select_textops.xml | 107 ++ doc/select_list/docbook/select_timer.xml | 17 + doc/select_list/docbook/select_tls.xml | 1235 +++++++++++++++++++++ doc/select_list/docbook/select_tm.xml | 59 + doc/select_list/docbook/select_xmlrpc.xml | 14 + doc/select_list/select_avp.txt | 12 + doc/select_list/select_core.txt | 495 +++++++++ doc/select_list/select_db_ops.txt | 122 +++ doc/select_list/select_eval.txt | 54 + doc/select_list/select_nathelper.txt | 19 + doc/select_list/select_rr.txt | 7 + doc/select_list/select_textops.txt | 38 + doc/select_list/select_timer.txt | 8 + doc/select_list/select_tls.txt | 414 +++++++ doc/select_list/select_tm.txt | 22 + doc/select_list/select_xmlrpc.txt | 7 + 23 files changed, 4740 insertions(+), 0 deletions(-) Diff: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commitdiff;h=199…

14 years, 11 months

git:andrei/cdefs2doc: doc: select_list: added makefiles for auto-gen.

by Andrei Pelinescu-Onciul

Module: sip-router Branch: andrei/cdefs2doc Commit: 725c50b14e4a99da654a0dd2ee4804cda29217f9 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=725c50b… Author: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Committer: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Date: Thu Feb 18 14:15:31 2010 +0100 doc: select_list: added makefiles for auto-gen. Added a new directory (doc/select_list) complete with a makefile for auto-generating lists with all the select implemented in the code. make -C doc/select_list all will generate both .txt and .xml files. The .xml are in docbook format and are written to doc/select_list/docbook, complete with a file that includes them all (select_list.xml). E.g.: to generate a .html file with all the selects: make -C doc/select_list all # generates the docbook make -C doc/select_list/docbook html --- doc/select_list/Makefile | 229 ++++++++++++++++++++++++++++++++++++++ doc/select_list/docbook/Makefile | 5 + 2 files changed, 234 insertions(+), 0 deletions(-) diff --git a/doc/select_list/Makefile b/doc/select_list/Makefile new file mode 100644 index 0000000..4962624 --- /dev/null +++ b/doc/select_list/Makefile @@ -0,0 +1,229 @@ + +COREPATH=../.. + +#include $(COREPATH)/Makefile.defs + +CFG2TXT=../scripts/cdefs2doc/dump_selects.pl +CFG2DOCBOOK=../scripts/cdefs2doc/dump_selects.pl + +# extra generators options +# use select_core.c to resolve possible chained select +CFG2TXT_EXTRA_OPTS=--core $(COREPATH)/select_core.c +CFG2DOCBOOK_EXTRA_OPTS=--core $(COREPATH)/select_core.c + +# output directory for generated txt files +txt_output_dir=. +# output directory for generated docbook xml files +docbook_output_dir=docbook + +# list of files contanining selects defs in the following format: +# <filename>:<sel_grp_name> +# can be easily filled/updated by pasting the output of: +# make print-lst |sed -e 's!^ \?../..$.*$!$(COREPATH)\1 \\!' +files_list=$(COREPATH)/select_core.c:core \ + $(COREPATH)/modules_s/timer/timer.c:timer \ + $(COREPATH)/modules_s/nathelper/nathelper.c:nathelper \ + $(COREPATH)/modules_s/eval/eval.c:eval \ + $(COREPATH)/modules_s/rr/rr_mod.c:rr \ + $(COREPATH)/modules_s/textops/textops.c:textops \ + $(COREPATH)/modules_s/avp/avp.c:avp \ + $(COREPATH)/modules_s/db_ops/db_ops.c:db_ops \ + $(COREPATH)/modules/tm/select.c:tm \ + $(COREPATH)/modules/tls/tls_select.c:tls \ + $(COREPATH)/modules/xmlrpc/xmlrpc.c:xmlrpc \ + $(COREPATH)/modules/iptrtpproxy/iptrtpproxy.c:iptrtpproxy + +# list of excluded groups +grp_exclude=pa iptrtpproxy +# list of file prefixes to exclude (full path needed) +file_exclude= $(COREPATH)/modules_s/tls/ \ + $(COREPATH)/modules/iptrtpproxy/ + +# special per file group overrides +# format= grp_filename=... ,where filename does not contain the extension +# e.g.: +# grp_f_tcp_options=tcp +# grp_f_sctp_options=sctp + +# special per group group name overrides +# e.g.: +# grp_g_maxfwd=mf + +# override auto-detected group if set to 1 (else the group is used inside the +# file only if it cannot be aut-odetected) +ifeq ($(group_override),1) +override force_grp=force- +else +override force_grp= +endif + +# command used for gcc (contains extra includes) +gcc=gcc -I$(COREPATH)/lib -I/usr/include/libxml2 + +#filtered files list +flist=$(subst .h:,.c:, $(filter-out $(addsuffix %,$(file_exclude)),\ + $(filter-out $(addprefix %:,$(grp_exclude)),$(files_list)) ) ) + +# throws an error if input is not in the format filename:grp +check_fname_grp=$(if $(filter-out 2,$(words $(subst :, ,$(1)))),\ + $(error bad format "$(1)", it should be filename:grp)) + +# get prereq from file:grp (get_prereq(file:grp) => file) +get_prereq=$(firstword $(subst :, ,$(1))) + +# get grp from file:grp (get_grp(file:grp) => grp) +get_listed_grp=$(word 2, $(subst :, ,$(1))) + +# get base file name from file:grp: get_bname(file:grp) +# => basename(file) without extension (e.g. get_bname(foo/bar.c:x) => bar) +# +get_bname=$(basename $(notdir $(call get_prereq,$(1)))) + +#get grp from file:grp, using the overrides +get_grp=$(strip $(if $(grp_f_$(call get_bname,$(1))), \ + $(grp_f_$(call get_bname,$(1))),\ + $(if $(grp_g_$(call get_listed_grp,$(1))),\ + $(grp_g_$(call get_listed_grp,$(1))),\ + $(call get_listed_grp,$(1))) ) ) + +# get target from file:grp (get_target(file:grp) => select_grp) +get_target=select_$(call get_grp,$(1)) + +define mk_rules + +$(call check_fname_grp, $(1)) + +#$$(info generating select_$$(call get_grp,$(1)).txt: $$(call get_prereq,$(1))) + +$(txt_output_dir)/$$(call get_target,$(1)).txt: \ + $$(call get_prereq,$(1)) Makefile $(CFG2TXT) + $(CFG2TXT) --file $$< --$(force_grp)grp=$$(call get_grp,$(1)) \ + --gcc="$(gcc)" --txt $(CFG2TXT_EXTRA_OPTS) > "$$@" || \ + (rm -f "$$@"; exit 1) + +$(docbook_output_dir)/$$(call get_target,$(1)).xml: \ + $$(call get_prereq,$(1)) Makefile $(CFG2TXT) + $(CFG2DOCBOOK) --file $$< --$(force_grp)grp=$$(call get_grp,$(1)) \ + --gcc="$(gcc)" --docbook $(CFG2DOCBOOK_EXTRA_OPTS) > "$$@" || \ + (rm -f "$$@"; exit 1) + + +clean_$$(call get_target,$(1)).txt: + rm -f "$(txt_output_dir)/$$(call get_target,$(1)).txt" + +clean_$$(call get_target,$(1)).xml: + rm -f "$(docbook_output_dir)/$$(call get_target,$(1)).xml" + +txt: $(txt_output_dir)/$$(call get_target,$(1)).txt + +docbook: $(docbook_output_dir)/$$(call get_target,$(1)).xml + +clean_txt: clean_$$(call get_target,$(1)).txt + +clean_docbook: clean_$$(call get_target,$(1)).xml + + +endef + + +# help will be the default rule (on-purpose since without having a patched +# GCC:TranslationUnit module, make all won't work) +.PHONY: help +help: + @echo "To regenerate $(foreach f,$(flist),$(call get_target,$f).{txt,xml})" + @echo "type: $(MAKE) all ." + @echo "or to regenerate all the select lists by searching all" + @echo " the source files for definitions, type: $(MAKE) autogen ." + @echo "NOTE: you need the GCC:TranslationUnit perl module with an " + @echo "extra patch applied (see $(CFG2TXT) --patch)." + +.PHONY: txt +txt: + +.PHONY: docbook +docbook: + +.PHONY: clean_txt +clean_txt: + +.PHONY: clean_docbook +clean_docbook: + + +.PHONY: all +all: txt $(docbook_output_dir)/select_list.xml + +.PHONY: clean +clean: clean_txt clean_docbook + @rm -f $(docbook_output_dir)/select_list.xml + +.PHONY: proper +proper: + @rm -f $(txt_output_dir)/select_*.txt + @rm -f $(docbook_output_dir)/select_*.xml + +repo_ver="sip-router"\ + "git-$(shell git rev-parse --verify --short=6 HEAD 2>/dev/null)" +ifeq ($(repo_ver),git-) +repo_ver="sip-router unknown" +endif + +$(docbook_output_dir)/select_list.xml: \ + $(foreach f,$(flist),$(docbook_output_dir)/$(call get_target,$f).xml) + @echo '<?xml version="1.0" encoding="UTF-8"?>' >$@ + @echo '' >>$@ + @echo '<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"' >>$@ + @echo ' "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">' >>$@ + @echo '<book id="select_list"'\ + 'xmlns:xi="http://www.w3.org/2001/XInclude">' >>$@ + @echo ' <title>Select List</title>' >>$@ + @echo ' <info><revhistory><revision>' >>$@ + @echo ' <revnumber>'$(repo_ver)'</revnumber>' >>$@ + @echo ' <revremark>' >>$@ + @echo " Automatically generated by:">>$@ + @echo " $(MAKE) -C doc/select_list $(MAKECMDGOALS)" >>$@ + @echo ' </revremark>' >>$@ + @echo ' </revision></revhistory></info>' >>$@ + @$(foreach f,$(flist),\ + echo ' <xi:include'\ + 'href="'$(call get_target,$f).xml'"/>' \ + >>$@ ; ) + @echo '</book>' >>$@ + +find_sel_files_cmd= find $(COREPATH) -type f -name "*.[ch]" \ + -exec grep "select_row_t[ ][a-zA-Z0-9_][a-zA-Z0-9_]*\[\][ ]*=" \ + /dev/null {} \; \ + | cut -d: -f1 + +# shell command to generate a file:grp list from a list of files +# grp will be the modulename if the file is in a module directory or +# the file name with the extension and _sel, sel_, select_, _select, +# _declaration or _table # stripped out of it. +# output: list of " "filename":"grpname +gen_file_grp_cmd=\ +sed -e "s!$.*/modules[^/]*/\([^/][^/]*$/.*\)! \1:\2!" \ + -e "s!^$[^ ].*/\([^/.]*$[^/]*$$\)!\1:\2!" \ + -e "s!^$[^ :]*$:$.*$_select[_]*!\1:\2!" \ + -e "s!^$[^ :]*$:$.*$select[_]*!\1:\2!" \ + -e "s!^$[^ :]*$:$.*$_declaration[_]*!\1:\2!" \ + -e "s!^$[^ :]*$:$.*$_table[_]*!\1:\2!" \ + -e "s!^$[^ :]*$:$.*$_sel[_]*!:\1:\2!" \ + -e "s!^$[^ :]*$:$.*$sel[_]*!\1:\2!" + +# finds all the files containing select defs +.PHONY: find +find: + @$(find_sel_files_cmd) + +# print the list of the autogenerated files +.PHONY: print-lst +print-lst: + @$(find_sel_files_cmd) | $(gen_file_grp_cmd) + +# try to generate the docs from all the sources +.PHONY: autogen +autogen: + LST=`$(find_sel_files_cmd)| $(gen_file_grp_cmd) | xargs echo` && \ + [ -n "$$LST" ] && $(MAKE) all files_list="$$LST" + +$(foreach f,$(flist),$(eval $(call mk_rules,$(f)))) diff --git a/doc/select_list/docbook/Makefile b/doc/select_list/docbook/Makefile new file mode 100644 index 0000000..95cc961 --- /dev/null +++ b/doc/select_list/docbook/Makefile @@ -0,0 +1,5 @@ + +docs = select_list.xml +docbook_dir = ../../../docbook + +include $(docbook_dir)/Makefile

14 years, 11 months

git:andrei/cdefs2doc: doc: dump_selects.pl: fix for incomplete initializers

by Andrei Pelinescu-Onciul

Module: sip-router Branch: andrei/cdefs2doc Commit: 8ee1a086852a038fa80daf3d5e5534f4b67a646f URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=8ee1a08… Author: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Committer: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Date: Thu Feb 18 13:41:10 2010 +0100 doc: dump_selects.pl: fix for incomplete initializers Some of the modules (e.g db_ops) omit the last members (flags) in the select_row_t initializer. The script did not take into account this possibility when it did parse the C code. --- doc/scripts/cdefs2doc/dump_selects.pl | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/scripts/cdefs2doc/dump_selects.pl b/doc/scripts/cdefs2doc/dump_selects.pl index 84a1cda..f88d252 100755 --- a/doc/scripts/cdefs2doc/dump_selects.pl +++ b/doc/scripts/cdefs2doc/dump_selects.pl @@ -461,7 +461,7 @@ sub process_file ($new_f_n->isa('GCC::Node::integer_cst'))? $new_f_n->low: expr_op0($new_f_n)->name->identifier; - $flags=$flags_n->low; + $flags= (defined $flags_n)?$flags_n->low:0; push @res, [$prev_f, $type, $name, $new_f, $flags]; @@ -594,7 +594,7 @@ format DOCBOOK_HEADER = "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> <chapter id="select_list@*"> (valid_grp_name $sel_grp_name) ? "." . $sel_grp_name : "" - <title>Selects List@*</title> + <title>Selects@*</title> (valid_grp_name $sel_grp_name) ? " for " . $sel_grp_name : "" <orderedlist>

14 years, 11 months

git:andrei/cdefs2doc: doc: {rpc, cfg}_list: fix makefile exclude list

by Andrei Pelinescu-Onciul

Module: sip-router Branch: andrei/cdefs2doc Commit: 0ddc0cebabe0973dd0a44b4fae51a02a8222d686 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=0ddc0ce… Author: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Committer: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Date: Thu Feb 18 14:10:08 2010 +0100 doc: {rpc,cfg}_list: fix makefile exclude list - fix makefile exclude groups and files (didn't work for more then one entry) - added default list for make all --- doc/cfg_list/Makefile | 6 ++++-- doc/cfg_list/docbook/cfg_var_list.xml | 2 +- doc/rpc_list/Makefile | 32 +++++++++++++++++++++++++++----- doc/rpc_list/docbook/rpc_list.xml | 4 ++-- 4 files changed, 34 insertions(+), 10 deletions(-) diff --git a/doc/cfg_list/Makefile b/doc/cfg_list/Makefile index 9283a50..8d83fc3 100644 --- a/doc/cfg_list/Makefile +++ b/doc/cfg_list/Makefile @@ -13,6 +13,8 @@ docbook_output_dir=docbook # list of files contanining cfg defs in the following format: # <filename>:<cfg_grp_name> +# can be easily filled/updated by pasting the output of: +# make print-lst |sed -e 's!^ \?../..$.*$!$(COREPATH)\1 \\!' files_list=$(COREPATH)/cfg_core.c:core $(COREPATH)/tcp_options.c:tcp \ $(COREPATH)/sctp_options.c:sctp \ $(COREPATH)/modules_s/maxfwd/maxfwd.c:maxfwd \ @@ -45,8 +47,8 @@ endif gcc=gcc -I$(COREPATH)/lib -I/usr/include/libxml2 #filtered files list -flist=$(filter-out $(join $(file_exclude),%),\ - $(filter-out $(join %:,$(grp_exclude)),$(files_list)) ) +flist=$(filter-out $(addsuffix %,$(file_exclude)),\ + $(filter-out $(addprefix %:,$(grp_exclude)),$(files_list)) ) # throws an error if input is not in the format filename:grp check_fname_grp=$(if $(filter-out 2,$(words $(subst :, ,$(1)))),\ diff --git a/doc/cfg_list/docbook/cfg_var_list.xml b/doc/cfg_list/docbook/cfg_var_list.xml index 4da2a56..991e39e 100644 --- a/doc/cfg_list/docbook/cfg_var_list.xml +++ b/doc/cfg_list/docbook/cfg_var_list.xml @@ -5,7 +5,7 @@ <book id="cfg_var_list" xmlns:xi="http://www.w3.org/2001/XInclude"> <title>RPC Exports List</title> <info><revhistory><revision> - <revnumber>sip-router git-a11ee8</revnumber> + <revnumber>sip-router git-8ee1a0</revnumber> <revremark> Automatically generated by: make -C doc/cfg_list all diff --git a/doc/rpc_list/Makefile b/doc/rpc_list/Makefile index b4e7afd..eb046cc 100644 --- a/doc/rpc_list/Makefile +++ b/doc/rpc_list/Makefile @@ -13,9 +13,31 @@ docbook_output_dir=docbook # list of files contanining rpc defs in the following format: # <filename>:<cfg_grp_name> -# one way to quickly fill it up is pasting the output of -# make print-lst|xargs echo -files_list=$(COREPATH)/core_cmd.c:core +# can be easily filled/updated by pasting the output of: +# make print-lst |sed -e 's!^ \?../..$.*$!$(COREPATH)\1 \\!' +files_list= $(COREPATH)/core_cmd.c:core \ + $(COREPATH)/modules_s/pdt/pdt.c:pdt \ + $(COREPATH)/modules_s/rls/rpc.c:rls \ + $(COREPATH)/modules_s/pike/rpc.c:pike \ + $(COREPATH)/modules_s/tls/tls_rpc.c:tls \ + $(COREPATH)/modules_s/presence_b2b/rpc.c:presence_b2b \ + $(COREPATH)/modules_s/gflags/gflags.c:gflags \ + $(COREPATH)/modules_s/dispatcher/ds_rpc.c:dispatcher \ + $(COREPATH)/modules_s/prefix_route/pr_rpc.c:prefix_route \ + $(COREPATH)/modules_s/domain/domain_rpc.c:domain \ + $(COREPATH)/modules_s/cpl-c/cpl_rpc.c:cpl-c \ + $(COREPATH)/modules_s/sl/sl_stats.c:sl \ + $(COREPATH)/modules_s/usrloc/ul_rpc.c:usrloc \ + $(COREPATH)/modules_s/pa/rpc.c:pa \ + $(COREPATH)/modules_s/ratelimit/ratelimit.c:ratelimit \ + $(COREPATH)/modules/tm/tm.c:tm \ + $(COREPATH)/modules/tls/tls_rpc.c:tls \ + $(COREPATH)/modules/lcr/lcr_rpc.c:lcr \ + $(COREPATH)/modules/ctl/ctl.c:ctl \ + $(COREPATH)/modules/cfg_rpc/cfg_rpc.c:cfg_rpc \ + $(COREPATH)/modules/db_flatstore/flat_rpc.c:db_flatstore \ + $(COREPATH)/modules/mi_rpc/mi_rpc_mod.c:mi_rpc + # list of excluded groups grp_exclude=pa @@ -44,8 +66,8 @@ endif gcc=gcc -I$(COREPATH)/lib -I/usr/include/libxml2 #filtered files list -flist=$(filter-out $(join $(file_exclude),%),\ - $(filter-out $(join %:,$(grp_exclude)),$(files_list)) ) +flist=$(filter-out $(addsuffix %,$(file_exclude)),\ + $(filter-out $(addprefix %:,$(grp_exclude)),$(files_list)) ) # throws an error if input is not in the format filename:grp check_fname_grp=$(if $(filter-out 2,$(words $(subst :, ,$(1)))),\ diff --git a/doc/rpc_list/docbook/rpc_list.xml b/doc/rpc_list/docbook/rpc_list.xml index 40a0225..16a1027 100644 --- a/doc/rpc_list/docbook/rpc_list.xml +++ b/doc/rpc_list/docbook/rpc_list.xml @@ -5,12 +5,13 @@ <book id="rpc_list" xmlns:xi="http://www.w3.org/2001/XInclude"> <title>RPC Exports List</title> <info><revhistory><revision> - <revnumber>sip-router git-b6cfcc</revnumber> + <revnumber>sip-router git-8ee1a0</revnumber> <revremark> Automatically generated by: make -C doc/rpc_list all </revremark> </revision></revhistory></info> + <xi:include href="rpc_core.xml"/> <xi:include href="rpc_pdt.xml"/> <xi:include href="rpc_rls.xml"/> <xi:include href="rpc_pike.xml"/> @@ -30,5 +31,4 @@ <xi:include href="rpc_cfg_rpc.xml"/> <xi:include href="rpc_db_flatstore.xml"/> <xi:include href="rpc_mi_rpc.xml"/> - <xi:include href="rpc_core.xml"/> </book>

14 years, 11 months

git:bpintea/asi_binrpc2: s/CRIT(/LOG(L_CRIT, /

by Bogdan Pintea

Module: sip-router Branch: bpintea/asi_binrpc2 Commit: 885ea4b28f30635329c7178b77e42319e9c47b1a URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=885ea4b… Author: bpi <bpi(a)machine.office.iptego.net> Committer: bpi <bpi(a)machine.office.iptego.net> Date: Thu Feb 18 12:05:50 2010 +0100 s/CRIT(/LOG(L_CRIT, / - this makes the code compatible with CVS sip_router --- modules/binrpc/io_listener.c | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/modules/binrpc/io_listener.c b/modules/binrpc/io_listener.c index a1975d8..eec6b6a 100644 --- a/modules/binrpc/io_listener.c +++ b/modules/binrpc/io_listener.c @@ -328,7 +328,7 @@ void io_listen_loop(struct ctrl_socket* cs_lst) } /* should never reach this point under normal (non-error) circumstances */ error: - CRIT("io_listen_loop exiting ...\n"); + LOG(L_CRIT, "io_listen_loop exiting ...\n"); }

14 years, 11 months

git:andrei/cdefs2doc: doc: dump_cfg_defs.pl: support for docbook output

by Andrei Pelinescu-Onciul

Module: sip-router Branch: andrei/cdefs2doc Commit: becac8950fdfb89585e864bcf838ee30a59f2950 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=becac89… Author: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Committer: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Date: Wed Feb 17 22:27:01 2010 +0100 doc: dump_cfg_defs.pl: support for docbook output Added support for generating docbook output (by using the --docbook option). --- doc/scripts/cdefs2doc/dump_cfg_defs.pl | 107 +++++++++++++++++++++++++++++-- 1 files changed, 100 insertions(+), 7 deletions(-) diff --git a/doc/scripts/cdefs2doc/dump_cfg_defs.pl b/doc/scripts/cdefs2doc/dump_cfg_defs.pl index 1dd9759..48e199b 100755 --- a/doc/scripts/cdefs2doc/dump_cfg_defs.pl +++ b/doc/scripts/cdefs2doc/dump_cfg_defs.pl @@ -72,8 +72,12 @@ my @cfg_default; # filled with config var defaults my ($cfg_grp_name, $def_cfg_name, $cfg_var_name); my ($opt_help, $opt_txt, $opt_is_tu, $dbg, $opt_grp_name, $opt_patch); -my $opt_force_grp_name; +my ($opt_force_grp_name, $opt_docbook); +# default output formats +my $output_format_header="HEADER"; +my $output_format_footer="FOOTER"; +my $output_format_varline="VARLINE2"; sub show_patch @@ -121,6 +125,7 @@ Options: is autodetected (see also -g). --gcc gcc_name - run gcc_name instead of gcc. -t | --txt - text mode output. + --docbook | --xml - docbook output (xml). -T | --tu - the input file is in raw gcc translation unit format (as produced by gcc -fdump-translation-unit -c ). If not @@ -136,6 +141,37 @@ Options: } + + +# escape a string for xml use +# params: string to be escaped +# return: escaped string +sub xml_escape{ + my $s=shift; + my %escapes = ( + '"' => '"', + "'" => ''', + '&' => '&', + '<' => '<', + '>' => '>' + ); + + $s=~s/(["'&<>])/$escapes{$1}/g; + return $s; +} + + + +# escape a string according with the output requirements +# params: string to be escaped +# return: escaped string +sub output_esc{ + return xml_escape(shift) if defined $opt_docbook; + return shift; +} + + + # eliminate casts and expressions. # (always go on the first operand) # params: node (GCC::Node) @@ -157,6 +193,7 @@ sub expr_op0{ if ($#ARGV < 0 || ! GetOptions( 'help|h|?' => \$opt_help, 'file|f=s' => \$file, 'txt|t' => \$opt_txt, + 'docbook|xml' => \$opt_docbook, 'tu|T' => \$opt_is_tu, 'source|src|s=s' => \$src_fname, 'defs|d=s'=>\$c_defs, @@ -176,6 +213,16 @@ if ($#ARGV < 0 || ! GetOptions( 'help|h|?' => \$opt_help, do { show_patch(); exit 0; } if (defined $opt_patch); do { select(STDERR); help(); exit 1 } if (!defined $file); +if (defined $opt_txt){ + $output_format_header="HEADER"; + $output_format_footer="FOOTER"; + $output_format_varline="VARLINE2"; +}elsif (defined $opt_docbook){ + $output_format_header="DOCBOOK_HEADER"; + $output_format_footer="DOCBOOK_FOOTER"; + $output_format_varline="DOCBOOK_VARLINE"; +} + if (! defined $opt_is_tu){ # file is not a gcc translation-unit dump # => we have to create one @@ -342,17 +389,17 @@ if (@cfg_defs > 0){ } # dump the configuration in txt mode if (defined $opt_force_grp_name) { - $cfg_grp_name=$opt_force_grp_name; + $cfg_grp_name=output_esc($opt_force_grp_name); }elsif (!defined $cfg_grp_name && defined $opt_grp_name) { - $cfg_grp_name=$opt_grp_name; + $cfg_grp_name=output_esc($opt_grp_name); } - $~ = "HEADER"; write; - $~ = "VARLINE2" ; + $~ = $output_format_header; write; + $~ = $output_format_varline ; for $l (@cfg_defs){ ($name, $flags, $min, $max, $desc)=@{$l}; $type=""; $extra_txt=""; - $default= ($no>0) ? $cfg_default[$i] : ""; + $default= ($no>0) ? output_esc($cfg_default[$i]) : ""; $i++; if ($min==0 && $max==0) { @@ -373,10 +420,13 @@ if (@cfg_defs > 0){ } $extra_txt.="Read-only." if ($flags & 128 ); - $desc.="."; + $extra_txt=output_esc($extra_txt); + $desc=output_esc($desc . "."); + $name=output_esc($name); # generate txt description write; } + $~ = $output_format_footer; write; }else{ die "no configuration variables found in $file\n"; } @@ -401,6 +451,9 @@ Configuration Variables@* . +format FOOTER = +. + format VARLINE = @>. @<<<<<<<<<<<<<<<<<<< - ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< $i, $name, $desc @@ -432,3 +485,43 @@ $i, (valid_grp_name $cfg_grp_name)?$cfg_grp_name . "." . $name : $name $extra_txt . + +format DOCBOOK_HEADER = +<?xml version="1.0" encoding="UTF-8"?> + +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<chapter id="config_vars@*"> +(valid_grp_name $cfg_grp_name) ? "." . $cfg_grp_name : "" + <title> Configuration Variables@*</title> +(valid_grp_name $cfg_grp_name) ? " for " . $cfg_grp_name : "" + + +. + +format DOCBOOK_FOOTER = +</chapter> +. + +format DOCBOOK_VARLINE = +<section id="@*"> + (valid_grp_name $cfg_grp_name)?$cfg_grp_name . "." . $name : $name + <title>@*</title> + (valid_grp_name $cfg_grp_name)?$cfg_grp_name . "." . $name : $name + <para> +~~ ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< + $desc + </para> +~ <para>Default value: @*.</para> + $default +~ <para>Range: @* - @*.</para> + $min, $max +~ <para>Type: @*.</para> + $type + <para> +~~ ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< + $extra_txt + </para> +</section> + +.

14 years, 11 months

git:andrei/cdefs2doc: doc: cfg_list: docbook output directory

by Andrei Pelinescu-Onciul

Module: sip-router Branch: andrei/cdefs2doc Commit: a11ee8f6d82543baab975cfb750412f84d1d344c URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=a11ee8f… Author: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Committer: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Date: Wed Feb 17 22:35:09 2010 +0100 doc: cfg_list: docbook output directory Added directory for docbook output, complete with standard doc makefile (for generating html, pdf, txt a.s.o from docbook sources). --- doc/cfg_list/docbook/Makefile | 5 +++++ 1 files changed, 5 insertions(+), 0 deletions(-) diff --git a/doc/cfg_list/docbook/Makefile b/doc/cfg_list/docbook/Makefile new file mode 100644 index 0000000..d0f65d2 --- /dev/null +++ b/doc/cfg_list/docbook/Makefile @@ -0,0 +1,5 @@ + +docs = cfg_var_list.xml +docbook_dir = ../../../docbook + +include $(docbook_dir)/Makefile

14 years, 11 months

git:andrei/cdefs2doc: doc: cfg_list: support for generating docbook output

by Andrei Pelinescu-Onciul

Module: sip-router Branch: andrei/cdefs2doc Commit: 34d34985de850287caf9f17fddeee015f0101f52 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=34d3498… Author: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Committer: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Date: Wed Feb 17 22:31:43 2010 +0100 doc: cfg_list: support for generating docbook output - make docbook will generate the cfg lists in docbook format - make all will generate both txt and docbook - generate docbook index file (cfg_var_list.xml) - configurable output directories (txt_output_dir and docbook_output_dir) --- doc/cfg_list/Makefile | 84 ++++++++++++++++++++++++++++++++++++++++++------ 1 files changed, 73 insertions(+), 11 deletions(-) diff --git a/doc/cfg_list/Makefile b/doc/cfg_list/Makefile index 881f735..9283a50 100644 --- a/doc/cfg_list/Makefile +++ b/doc/cfg_list/Makefile @@ -4,6 +4,12 @@ COREPATH=../.. #include $(COREPATH)/Makefile.defs CFG2TXT=../scripts/cdefs2doc/dump_cfg_defs.pl +CFG2DOCBOOK=../scripts/cdefs2doc/dump_cfg_defs.pl + +# output directory for generated txt files +txt_output_dir=. +# output directory for generated docbook xml files +docbook_output_dir=docbook # list of files contanining cfg defs in the following format: # <filename>:<cfg_grp_name> @@ -65,7 +71,7 @@ get_grp=$(strip $(if $(grp_f_$(call get_bname,$(1))), \ $(call get_listed_grp,$(1))) ) ) # get target from file:grp (get_target(file:grp) => cfg_grp.txt) -get_target=cfg_$(call get_grp,$(1)).txt +get_target=cfg_$(call get_grp,$(1)) define mk_rules @@ -73,17 +79,30 @@ $(call check_fname_grp, $(1)) #$$(info generating cfg_$$(call get_grp,$(1)).txt: $$(call get_prereq,$(1))) -$$(call get_target,$(1)): $$(call get_prereq,$(1)) Makefile $(CFG2TXT) +$(txt_output_dir)/$$(call get_target,$(1)).txt: \ + $$(call get_prereq,$(1)) Makefile $(CFG2TXT) $(CFG2TXT) --file $$< --$(force_grp)grp=$$(call get_grp,$(1)) \ - --gcc="$(gcc)" > "$$@" || (rm -f "$$@"; exit 1) + --gcc="$(gcc)" --txt > "$$@" || (rm -f "$$@"; exit 1) + +$(docbook_output_dir)/$$(call get_target,$(1)).xml: \ + $$(call get_prereq,$(1)) Makefile $(CFG2TXT) + $(CFG2DOCBOOK) --file $$< --$(force_grp)grp=$$(call get_grp,$(1)) \ + --gcc="$(gcc)" --docbook > "$$@" || (rm -f "$$@"; exit 1) + + +clean_$$(call get_target,$(1)).txt: + rm -f "$(txt_output_dir)/$$(call get_target,$(1)).txt" +clean_$$(call get_target,$(1)).xml: + rm -f "$(docbook_output_dir)/$$(call get_target,$(1)).xml" -clean_$$(call get_target,$(1)): - rm -f "$$(call get_target,$(1))" +txt: $(txt_output_dir)/$$(call get_target,$(1)).txt -all: $$(call get_target,$(1)) +docbook: $(docbook_output_dir)/$$(call get_target,$(1)).xml -clean: clean_$$(call get_target,$(1)) +clean_txt: clean_$$(call get_target,$(1)).txt + +clean_docbook: clean_$$(call get_target,$(1)).xml endef @@ -93,22 +112,65 @@ endef # GCC:TranslationUnit module, make all won't work) .PHONY: help help: - @echo "To regenerate $(foreach f,$(flist),$(call get_target,$f) )" + @echo "To regenerate $(foreach f,$(flist),$(call get_target,$f).{txt,xml})" @echo "type: $(MAKE) all ." @echo "or to regenerate all the cfg documentation by searching all" @echo " the source files for definitions, type: $(MAKE) autogen ." @echo "NOTE: you need the GCC:TranslationUnit perl module with an " @echo "extra patch applied (see $(CFG2TXT) --patch)." +.PHONY: txt +txt: + +.PHONY: docbook +docbook: + +.PHONY: clean_txt +clean_txt: + +.PHONY: clean_docbook +clean_docbook: + + .PHONY: all -all: +all: txt $(docbook_output_dir)/cfg_var_list.xml .PHONY: clean -clean: +clean: clean_txt clean_docbook + @rm -f $(docbook_output_dir)/cfg_var_list.xml .PHONY: proper proper: - @rm -f cfg_*.txt + @rm -f $(txt_output_dir)/cfg_*.txt + @rm -f $(docbook_output_dir)/cfg_*.xml + +repo_ver="sip-router"\ + "git-$(shell git rev-parse --verify --short=6 HEAD 2>/dev/null)" +ifeq ($(repo_ver),git-) +repo_ver="sip-router unknown" +endif + +$(docbook_output_dir)/cfg_var_list.xml: \ + $(foreach f,$(flist),$(docbook_output_dir)/$(call get_target,$f).xml) + @echo '<?xml version="1.0" encoding="UTF-8"?>' >$@ + @echo '' >>$@ + @echo '<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"' >>$@ + @echo ' "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">' >>$@ + @echo '<book id="cfg_var_list"'\ + 'xmlns:xi="http://www.w3.org/2001/XInclude">' >>$@ + @echo ' <title>RPC Exports List</title>' >>$@ + @echo ' <info><revhistory><revision>' >>$@ + @echo ' <revnumber>'$(repo_ver)'</revnumber>' >>$@ + @echo ' <revremark>' >>$@ + @echo " Automatically generated by:">>$@ + @echo " $(MAKE) -C doc/cfg_list $(MAKECMDGOALS)" >>$@ + @echo ' </revremark>' >>$@ + @echo ' </revision></revhistory></info>' >>$@ + @$(foreach f,$(flist),\ + echo ' <xi:include'\ + 'href="'$(call get_target,$f).xml'"/>' \ + >>$@ ; ) + @echo '</book>' >>$@ find_cfg_files_cmd= find $(COREPATH) -type f -name "*.c" \ -exec grep "cfg_def_t[ ][a-zA-Z0-9_]*\[\][ ]*=" /dev/null {} \; \

14 years, 11 months

git:andrei/cdefs2doc: doc: cfg_list: generated docbook cfg vars lists

by Andrei Pelinescu-Onciul

Module: sip-router Branch: andrei/cdefs2doc Commit: dfd8da505d6ad20edff80289cd4553e87dfbbb00 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=dfd8da5… Author: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Committer: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Date: Wed Feb 17 22:39:30 2010 +0100 doc: cfg_list: generated docbook cfg vars lists --- doc/cfg_list/cfg_core.txt | 2 +- doc/cfg_list/docbook/cfg_core.xml | 424 +++++++++++++++++++++++++++++++++ doc/cfg_list/docbook/cfg_maxfwd.xml | 21 ++ doc/cfg_list/docbook/cfg_sctp.xml | 222 +++++++++++++++++ doc/cfg_list/docbook/cfg_tcp.xml | 288 ++++++++++++++++++++++ doc/cfg_list/docbook/cfg_tm.xml | 399 +++++++++++++++++++++++++++++++ doc/cfg_list/docbook/cfg_var_list.xml | 19 ++ 7 files changed, 1374 insertions(+), 1 deletions(-) Diff: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commitdiff;h=dfd…

14 years, 11 months

Jump to page:

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

sr-dev