[MPlayer-DOCS] r31161 - trunk/DOCS/xml/README.maintainers
diego
subversion at mplayerhq.hu
Tue May 11 15:17:26 CEST 2010
Author: diego
Date: Tue May 11 15:17:26 2010
New Revision: 31161
Log:
docs: Update documentation to account for recent build system changes.
Modified:
trunk/DOCS/xml/README.maintainers
Modified: trunk/DOCS/xml/README.maintainers
==============================================================================
--- trunk/DOCS/xml/README.maintainers Tue May 11 15:13:32 2010 (r31160)
+++ trunk/DOCS/xml/README.maintainers Tue May 11 15:17:26 2010 (r31161)
@@ -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 @@ 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
+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).
More information about the MPlayer-DOCS
mailing list