diff options
author | Uoti Urpala <uau@glyph.nonexistent.invalid> | 2010-05-30 15:27:58 +0300 |
---|---|---|
committer | Uoti Urpala <uau@glyph.nonexistent.invalid> | 2010-05-30 15:27:58 +0300 |
commit | 6f199ab3d97a1a5831f261fd5fc46d592ae1cdff (patch) | |
tree | a785da88f8fc1ffd73619d528bfac70a795d2f51 /DOCS | |
parent | 18657beb190b3e4acc6404c3b87e6eafbd22de3c (diff) | |
parent | 8c9cb24a48373330e9bfd4568eb7987890b19f8f (diff) | |
download | mpv-6f199ab3d97a1a5831f261fd5fc46d592ae1cdff.tar.bz2 mpv-6f199ab3d97a1a5831f261fd5fc46d592ae1cdff.tar.xz |
Merge svn changes up to r31169
Diffstat (limited to 'DOCS')
-rw-r--r-- | DOCS/tech/MAINTAINERS | 1 | ||||
-rw-r--r-- | DOCS/tech/binary-packaging.txt | 2 | ||||
-rw-r--r-- | DOCS/tech/general.txt | 2 | ||||
-rw-r--r-- | DOCS/xml/Makefile | 27 | ||||
-rw-r--r-- | DOCS/xml/Makefile.inc | 31 | ||||
-rw-r--r-- | DOCS/xml/README | 22 | ||||
-rw-r--r-- | DOCS/xml/README.maintainers | 31 | ||||
-rw-r--r-- | DOCS/xml/cs/Makefile | 4 | ||||
-rw-r--r-- | DOCS/xml/de/Makefile | 4 | ||||
-rw-r--r-- | DOCS/xml/en/Makefile | 4 | ||||
-rw-r--r-- | DOCS/xml/es/Makefile | 4 | ||||
-rw-r--r-- | DOCS/xml/fr/Makefile | 4 | ||||
-rw-r--r-- | DOCS/xml/hu/Makefile | 4 | ||||
-rw-r--r-- | DOCS/xml/it/Makefile | 4 | ||||
-rw-r--r-- | DOCS/xml/pl/Makefile | 4 | ||||
-rw-r--r-- | DOCS/xml/ru/Makefile | 4 | ||||
-rw-r--r-- | DOCS/xml/zh_CN/Makefile | 4 |
17 files changed, 39 insertions, 117 deletions
diff --git a/DOCS/tech/MAINTAINERS b/DOCS/tech/MAINTAINERS index e2fcf01862..5c690a0c1e 100644 --- a/DOCS/tech/MAINTAINERS +++ b/DOCS/tech/MAINTAINERS @@ -91,7 +91,6 @@ Imported libs/projects: * VIDIX core: Benjamin Zores * mp3lib: None * loader: None - * liba52: None * libmpeg2: None * libdvdcss: Diego Biurrun * libdvdread: Diego Biurrun diff --git a/DOCS/tech/binary-packaging.txt b/DOCS/tech/binary-packaging.txt index 974a20d46f..6cc485ef2b 100644 --- a/DOCS/tech/binary-packaging.txt +++ b/DOCS/tech/binary-packaging.txt @@ -45,7 +45,7 @@ the following features MUST be included in any official binary package: * codecs - FAAD(internal) - libavcodec(internal) - - native codecs (libmpeg2/liba52/mp3lib) + - native codecs (libmpeg2/mp3lib) - Vorbis Tremor codec(internal) - RealPlayer codecs support (*) - Win32/VfW/DShow/QT codecs support (*) diff --git a/DOCS/tech/general.txt b/DOCS/tech/general.txt index b9ac61ff10..36a584b746 100644 --- a/DOCS/tech/general.txt +++ b/DOCS/tech/general.txt @@ -196,7 +196,7 @@ Now, go on: Only used if none of the above works. 4. Codecs. Consists of libmpcodecs/* and separate files or libs, - for example liba52, libmpeg2, loader, mp3lib. + for example libmpeg2, loader, mp3lib. mplayer.c doesn't call them directly, but through the dec_audio.c and dec_video.c files, so the mplayer.c doesn't have to know anything about diff --git a/DOCS/xml/Makefile b/DOCS/xml/Makefile index c68c1b9570..01f935293d 100644 --- a/DOCS/xml/Makefile +++ b/DOCS/xml/Makefile @@ -30,23 +30,26 @@ html-single: $(addprefix html-single-,$(DOC_LANGS)) xmllint: $(addprefix xmllint-,$(DOC_LANGS)) -$(foreach lang,$(DOC_LANG_ALL),$(HTML)/$(lang)): - mkdir -p $@ - $(CONFIGURE_GENERATED) $(MAIN_XML_ALL): - sh configure + ./configure define lang-def -html-chunked-$(lang) html-single-$(lang): $(HTML)/$(lang) $(CONFIGURE_GENERATED) +html-chunked-$(lang): $(HTML)/$(lang)/index.html +html-single-$(lang): $(HTML)/$(lang)/MPlayer.html +$(HTML)/$(lang)/index.html $(HTML)/$(lang)/MPlayer.html: $(lang)/main.xml $(wildcard $(lang)/*.xml) html-common.xsl $(HTML)/$(lang)/default.css + +$(HTML)/$(lang)/default.css: + mkdir -p $$(@D) + cp -f default.css $$(@D) -html-chunked-$(lang): - $(MAKE) HTMLDIR=../$$< -C $(lang) html-chunked +$(HTML)/$(lang)/index.html: + ./xsltproc.sh $$(@D)/ html-chunk.xsl $$< -html-single-$(lang): - $(MAKE) HTMLDIR=../$$< -C $(lang) html-single +$(HTML)/$(lang)/MPlayer.html: + ./xsltproc.sh $$@ html-single.xsl $$< -xmllint-$(lang): xmllint.sh - $(MAKE) -C $(lang) xmllint +xmllint-$(lang): $(lang)/main.xml + ./xmllint.sh $$< endef $(foreach lang, $(DOC_LANG_ALL),$(eval $(lang-def))) @@ -61,4 +64,4 @@ releaseclean: distclean: clean releaseclean .PHONY: all help html-chunked html-single xmllint -.PHONY: html-chunked-* html-single-* xmllint-* *clean* +.PHONY: html-chunked-* html-single-* xmllint-* *clean diff --git a/DOCS/xml/Makefile.inc b/DOCS/xml/Makefile.inc deleted file mode 100644 index 44e022d56c..0000000000 --- a/DOCS/xml/Makefile.inc +++ /dev/null @@ -1,31 +0,0 @@ -# -# Makefile.inc for Makefiles in subdirectories. -# - -HTML_CHUNK_XSL := ../html-chunk.xsl -CHUNK_XSL_DEPS := $(HTML_CHUNK_XSL) ../html-common.xsl - -HTML_SINGLE_XSL := ../html-single.xsl -SINGLE_XSL_DEPS := $(HTML_SINGLE_XSL) ../html-common.xsl - -# This is the main target... -all: html-chunked html-single -html-chunked: $(HTMLDIR)/index.html -html-single: $(HTMLDIR)/MPlayer.html - -xmllint: main.xml - ../xmllint.sh $< - -$(HTMLDIR)/default.css: - cp -f ../default.css $(@D) - -$(HTMLDIR)/index.html: main.xml $(CHUNK_XSL_DEPS) xmllint $(HTMLDIR)/default.css - ../xsltproc.sh $(HTMLDIR)/ $(HTML_CHUNK_XSL) $< - -$(HTMLDIR)/MPlayer.html: main.xml $(SINGLE_XSL_DEPS) xmllint $(HTMLDIR)/default.css - ../xsltproc.sh $@ $(HTML_SINGLE_XSL) $< - -../html-chunk.xsl ../html-single.xsl main.xml: - cd .. && sh configure - -.PHONY: all html-chunked html-single xmllint diff --git a/DOCS/xml/README b/DOCS/xml/README index 1897dd53eb..f05432aaa2 100644 --- a/DOCS/xml/README +++ b/DOCS/xml/README @@ -73,6 +73,28 @@ to see all available build targets and make your choice. If something goes wrong, check the Configuration section of the toplevel Makefile and adjust the variables. +The documentation and its translations reside in subdirectories. +When building the documentation, the generated HTML files are +placed in subdirectories of the 'HTML' directory. + +IMPORTANT: Do NOT place sensitive files under 'HTML'! + It is for generated documentation only. + The whole directory tree is wiped out by the Makefile + when running 'make distclean' or 'make clean'. + + +Adding new translations +~~~~~~~~~~~~~~~~~~~~~~~ + +1) Create a new subdirectory and copy the XML files there. main.xml must not be + copied, it is autogenerated. + +2) In each translated file after the <?xml ... ?> tag you must put a note + like <!-- synced with r2 -->, where 2 is the revision of corresponding + English file (see comment at the top of file). + +That's all, in theory. + A few words about SGML catalog files ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/DOCS/xml/README.maintainers b/DOCS/xml/README.maintainers deleted file mode 100644 index 056a2ae039..0000000000 --- a/DOCS/xml/README.maintainers +++ /dev/null @@ -1,31 +0,0 @@ -The documentation and its translations reside in subdirectories. -When building the documentation, the toplevel Makefile goes into -the subdirectories listed in the SUBDIRS variable and executes make -in each of those directories to create the HTML documentation -in subdirectories of the 'HTML' directory. - -IMPORTANT: Do NOT place sensitive files under 'HTML'! - It is for generated documentation only. - The whole directory tree is wiped out by the Makefile - when running 'make distclean' or 'make clean'. - -Each subdirectory must have a Makefile. Its purpose is to include -the toplevel Makefile.inc file (with the rules to build the docs) -and add dependency information to the main target, $(HTMLDIR)/index.html. -The main target usually depends on all the XML files in the subdirectory. - - -Adding new translations -~~~~~~~~~~~~~~~~~~~~~~~ - -1) Create a new subdirectory and copy the XML files there. main.xml must not be - copied, it is autogenerated. - -2) Make sure to create a 'Makefile' for the translation -- you can - use 'en/Makefile' as an example. - -3) In each translated file after the <?xml ... ?> tag you must put a note - like <!-- synced with r2 -->, where 2 is the revision of corresponding - English file (see comment at the top of file). - -That's all, in theory. diff --git a/DOCS/xml/cs/Makefile b/DOCS/xml/cs/Makefile deleted file mode 100644 index db38611f41..0000000000 --- a/DOCS/xml/cs/Makefile +++ /dev/null @@ -1,4 +0,0 @@ -# Dependency information. -$(HTMLDIR)/index.html $(HTMLDIR)/MPlayer.html: $(wildcard *.xml) - -include ../Makefile.inc diff --git a/DOCS/xml/de/Makefile b/DOCS/xml/de/Makefile deleted file mode 100644 index db38611f41..0000000000 --- a/DOCS/xml/de/Makefile +++ /dev/null @@ -1,4 +0,0 @@ -# Dependency information. -$(HTMLDIR)/index.html $(HTMLDIR)/MPlayer.html: $(wildcard *.xml) - -include ../Makefile.inc diff --git a/DOCS/xml/en/Makefile b/DOCS/xml/en/Makefile deleted file mode 100644 index db38611f41..0000000000 --- a/DOCS/xml/en/Makefile +++ /dev/null @@ -1,4 +0,0 @@ -# Dependency information. -$(HTMLDIR)/index.html $(HTMLDIR)/MPlayer.html: $(wildcard *.xml) - -include ../Makefile.inc diff --git a/DOCS/xml/es/Makefile b/DOCS/xml/es/Makefile deleted file mode 100644 index db38611f41..0000000000 --- a/DOCS/xml/es/Makefile +++ /dev/null @@ -1,4 +0,0 @@ -# Dependency information. -$(HTMLDIR)/index.html $(HTMLDIR)/MPlayer.html: $(wildcard *.xml) - -include ../Makefile.inc diff --git a/DOCS/xml/fr/Makefile b/DOCS/xml/fr/Makefile deleted file mode 100644 index db38611f41..0000000000 --- a/DOCS/xml/fr/Makefile +++ /dev/null @@ -1,4 +0,0 @@ -# Dependency information. -$(HTMLDIR)/index.html $(HTMLDIR)/MPlayer.html: $(wildcard *.xml) - -include ../Makefile.inc diff --git a/DOCS/xml/hu/Makefile b/DOCS/xml/hu/Makefile deleted file mode 100644 index db38611f41..0000000000 --- a/DOCS/xml/hu/Makefile +++ /dev/null @@ -1,4 +0,0 @@ -# Dependency information. -$(HTMLDIR)/index.html $(HTMLDIR)/MPlayer.html: $(wildcard *.xml) - -include ../Makefile.inc diff --git a/DOCS/xml/it/Makefile b/DOCS/xml/it/Makefile deleted file mode 100644 index db38611f41..0000000000 --- a/DOCS/xml/it/Makefile +++ /dev/null @@ -1,4 +0,0 @@ -# Dependency information. -$(HTMLDIR)/index.html $(HTMLDIR)/MPlayer.html: $(wildcard *.xml) - -include ../Makefile.inc diff --git a/DOCS/xml/pl/Makefile b/DOCS/xml/pl/Makefile deleted file mode 100644 index db38611f41..0000000000 --- a/DOCS/xml/pl/Makefile +++ /dev/null @@ -1,4 +0,0 @@ -# Dependency information. -$(HTMLDIR)/index.html $(HTMLDIR)/MPlayer.html: $(wildcard *.xml) - -include ../Makefile.inc diff --git a/DOCS/xml/ru/Makefile b/DOCS/xml/ru/Makefile deleted file mode 100644 index db38611f41..0000000000 --- a/DOCS/xml/ru/Makefile +++ /dev/null @@ -1,4 +0,0 @@ -# Dependency information. -$(HTMLDIR)/index.html $(HTMLDIR)/MPlayer.html: $(wildcard *.xml) - -include ../Makefile.inc diff --git a/DOCS/xml/zh_CN/Makefile b/DOCS/xml/zh_CN/Makefile deleted file mode 100644 index db38611f41..0000000000 --- a/DOCS/xml/zh_CN/Makefile +++ /dev/null @@ -1,4 +0,0 @@ -# Dependency information. -$(HTMLDIR)/index.html $(HTMLDIR)/MPlayer.html: $(wildcard *.xml) - -include ../Makefile.inc |