RepoMirrors/mpv
1
0
Fork 0
mirror of https://github.com/mpv-player/mpv synced 2024-12-27 17:42:17 +00:00
Code Issues Releases Wiki Activity

docs: Update documentation to account for recent build system changes.

Browse Source 
git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@31161 b3059339-0415-0410-9bf9-f77b7e298cf2
This commit is contained in:
diego 2010-05-11 13:17:26 +00:00
parent 8de8a1c713
commit 51ac751241
1 changed files with 3 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
DOCS/xml/README.maintainers
View File

@ -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).