Mercurial > mplayer.hg
changeset 31104:c00cb80e3c18
docs: Update documentation to account for recent build system changes.
author | diego |
---|---|
date | Tue, 11 May 2010 13:17:26 +0000 |
parents | 1ff8bca53fe6 |
children | cf40376e7302 |
files | DOCS/xml/README.maintainers |
diffstat | 1 files changed, 3 insertions(+), 13 deletions(-) [+] |
line wrap: on
line diff
--- a/DOCS/xml/README.maintainers Tue May 11 13:13:32 2010 +0000 +++ b/DOCS/xml/README.maintainers Tue May 11 13:17:26 2010 +0000 @@ -1,19 +1,12 @@ 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. +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'. -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 ~~~~~~~~~~~~~~~~~~~~~~~ @@ -21,10 +14,7 @@ 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 +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).