Skip to content

Commit

Permalink
Merge pull request #58 from yast/no_builtin_doc
Browse files Browse the repository at this point in the history
do not generate documentation with obsolete tools
  • Loading branch information
jreidinger committed Oct 15, 2013
2 parents 9295ca0 + 0763163 commit 34a9465
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 115 deletions.
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
3.1.2
3.1.3
13 changes: 1 addition & 12 deletions agent-process/doc/autodocs/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,4 @@

SUBDIRS =

htmldir = $(docdir)/agent-process

html_DATA = ag_process-builtins.html
EXTRA_DIST = $(html_DATA)

builtin = $(srcdir)/../../src/ProcessAgent.cc

ag_process-builtins.html: $(builtin)
`pkg-config --variable=ybindir yast2-devtools`/makebuiltindocs -t "SCR Process agent functions" -a $(builtin) > $@.new
mv $@.new $@

CLEANFILES = ag_process-builtins.html
CLEANFILES =
11 changes: 0 additions & 11 deletions agent-system/doc/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,3 @@ SUBDIRS =
htmldir = $(docdir)/agent-system
html_DATA = systemagent.txt passwdagent.txt
EXTRA_DIST = $(html_DATA)

builtin = $(srcdir)/../src/SystemAgent.cc
hbuiltin = ag_system.html
$(hbuiltin): $(builtin)
`pkg-config --variable=ybindir yast2-devtools`/makebuiltindocs -t "SCR System agent functions" -a $(builtin) > $@.new
mv $@.new $@

compdir = $(yastdocdir)/components
comp_DATA = $(hbuiltin)

CLEANFILES = $(hbuiltin)
51 changes: 0 additions & 51 deletions libycp/doc/Makefile.am
Original file line number Diff line number Diff line change
@@ -1,55 +1,4 @@
#
# Makefile.am for core/libycp/doc
#
SUBDIRS = ycp

htmldir = $(yastdocdir)/ycp

builtin = $(wildcard $(srcdir)/../src/YCPBuiltin*.cc)
builtinxml := $(builtin:%.cc=%.xml)
xmlfiles = combined.xml
# needed for building the overall documentation
xmlfilesseparated := $(foreach xml,$(builtinxml),$(notdir $(xml)))
htmlfiles = $(filter-out html/index.html,$(wildcard html/*.html html/*/*.html))


html_DATA = \
html/yast2docs.css \
html/index.html \
$(htmlfiles)

html/index.html: $(xmlfilesseparated) $(xmlfiles) builtins.xml
XML_CATALOG_FILES=@XML_CATALOG@ $(XSLTPROC) $(XSLTPROC_FLAGS) --xinclude @STYLESHEET_HTML@ builtins.xml

YDOC := $(shell pkg-config --variable=ybindir yast2-devtools)/ydoc2
RENT := $(shell pkg-config --variable=ybindir yast2-devtools)/replace_entities

$(xmlfiles) : $(builtin)
$(YDOC) -o $@.tmp $^
$(XSLTPROC) --stringparam disambiguate yes $(XSLTPROC_FLAGS) @STYLESHEET_YDOC@ $@.tmp > $@
$(RENT) $@
rm $@.tmp

$(xmlfilesseparated) : $(builtin)
$(YDOC) -o $@.tmp ../src/$(subst xml,cc,$@)
$(XSLTPROC) $(XSLTPROC_FLAGS) @STYLESHEET_YDOC@ $@.tmp > $@
$(RENT) $@
rm $@.tmp

html/yast2docs.css: html/index.html
cp @STYLESHEET_CSS@ html
cp -a `pkg-config --variable=yast2dir yast2-devtools`/data/docbook/images html

EXTRA_DIST = builtins.xml

CLEANFILES = $(xmlfiles) $(xmlfilesseparated)

clean-local:
rm -rf html

install-data-local:
mkdir -p $(DESTDIR)$(htmldir)
cp -a $(srcdir)/html/images $(DESTDIR)$(htmldir)

check-manual:
xmllint --noout --valid builtins.xml
8 changes: 8 additions & 0 deletions package/yast2-core.changes
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
-------------------------------------------------------------------
Tue Oct 15 09:24:53 UTC 2013 - [email protected]

- Dropped documentation generated by makebuildindocs, not include
in yast2-devtools. Parts of it are obsolete anyway (YCP, WFM),
ag_process and ag_system will get new tools.
- 3.1.3

-------------------------------------------------------------------
Wed Oct 2 14:56:39 UTC 2013 - [email protected]

Expand Down
2 changes: 1 addition & 1 deletion package/yast2-core.spec
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


Name: yast2-core
Version: 3.1.0
Version: 3.1.3
Release: 0

BuildRoot: %{_tmppath}/%{name}-%{version}-build
Expand Down
39 changes: 0 additions & 39 deletions wfm/doc/Makefile.am
Original file line number Diff line number Diff line change
@@ -1,42 +1,3 @@
# Makefile.am for core/wfm/doc

SUBDIRS =

htmldir = $(yastdocdir)/ycp/WFM

htmlfiles = $(filter-out html/index.html,$(wildcard html/*.html))
builtin = $(srcdir)/../src/Y2WFMComponent.cc
builtinxml := $(builtin:%.cc=%.xml)
xmlfiles := $(foreach xml,$(builtinxml),$(notdir $(xml)))


html_DATA = \
html/yast2docs.css \
html/index.html \
$(htmlfiles)

html/index.html: $(xmlfiles) wfm.xml
XML_CATALOG_FILES=@XML_CATALOG@ $(XSLTPROC) $(XSLTPROC_FLAGS) --xinclude @STYLESHEET_HTML@ wfm.xml



$(xmlfiles) : $(builtin)
`pkg-config --variable=ybindir yast2-devtools`/ydoc2 -o $@.tmp ../src/$(subst xml,cc,$@)
$(XSLTPROC) $(XSLTPROC_FLAGS) @STYLESHEET_YDOC@ $@.tmp > $@
`pkg-config --variable=ybindir yast2-devtools`/replace_entities $@
rm $@.tmp

html/yast2docs.css: html/index.html
cp @STYLESHEET_CSS@ html
cp -a `pkg-config --variable=yast2dir yast2-devtools`/data/docbook/images html

EXTRA_DIST = wfm.xml

CLEANFILES = $(xmlfiles)

clean-local:
rm -rf html

install-data-local:
mkdir -p $(DESTDIR)$(htmldir)
cp -a $(srcdir)/html/images $(DESTDIR)$(htmldir)

0 comments on commit 34a9465

Please sign in to comment.