Author: paul
Date: 2006-07-18 21:13:43 +0200 (Tue, 18 Jul 2006)
New Revision: 2762
Log:
r11553@polar: paul | 2006-07-18 12:10:04 -0500
Add general README. (Created from metadoc mysqldoc-structure.xml file).
Added:
trunk/README.txt
Property changes on: trunk
___________________________________________________________________
Name: svk:merge
- 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:11552
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:12339
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:8441
+ 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:11553
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:12339
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:8441
Added: trunk/README.txt
===================================================================
--- trunk/README.txt (rev 0)
+++ trunk/README.txt 2006-07-18 19:13:43 UTC (rev 2762)
Changed blocks: 1, Lines Added: 57, Lines Deleted: 0; 2911 bytes
@@ -0,0 +1,57 @@
+1. Organization of the mysqldoc Repository
+ ________________________________________________________
+
+ The primary MySQL documentation repository is named mysqldoc.
+ This repository holds the English-language versions of the
+ MySQL Reference Manual and other documents. Some directories
+ in mysqldoc contain document content. Others provide the
+ infrastructure needed to check, format, or otherwise process
+ the documents.
+
+ Content Directories
+
+ Files in content directories are DocBook files that comprise
+ the content for one or more documents. Generally, each
+ document is given its own directory within the repository.
+ Most content directories also have a Makefile that contains
+ the target rules for document-processing operations.
+
+ The mysqldoc repository has the following content
+ directories:
+ * refman-5.1, refman-5.0, refman-4.1: Versions of the MySQL
+ Reference Manual for MySQL 5.1, 5.0, and 4.1. The 4.1
+ manual also includes material on MySQL 3.23 and 4.0;
+ there are no plans to create separate 3.23 or 4.0
+ manuals.
+ * refman-common: Files that are used in common by multiple
+ versions of the Reference Manual.
+ * administrator: The MySQL Administrator Manual.
+ * query-browser: The MySQL Query Browser Manual.
+ * gui-common: Files that are used in common by the MySQL
+ Administrator and MySQL Query Browser manuals.
+ * internals: The MySQL Internals manual.
+ * migration-toolkit: The MySQL Migration Toolkit manual.
+ * mysqltest: The MySQL Test Framework manual.
+ * userguide: The MySQL User Guide.
+ * workbench: The MySQL Workbench manual.
+ * sample-data: Data and supporting documentation for sample
+ databases (sakila, world, menagerie)
+ * proto-doc: A "prototype" document directory. You can copy
+ this directory to begin a new document.
+
+ Infrastructure Directories
+
+ Infrastructure directories provide support for working with
+ DocBook documents:
+ * dtd.d: The standard DocBook DTD files. These are used for
+ checking documents to make sure that their structure is
+ valid according to the syntax for DocBook.
+ * make.d: Files used in Makefiles to implement make
+ operations. This directory contains "modules" that can be
+ included into a Makefile for building particular kinds of
+ targets. For example, xml-pdf contains target rules for
+ generating PDF from XML documents.
+ * tools: Executable scripts and other tools used for
+ producing documentation.
+ * xsl.d: Files used to perform XSL transforms. The standard
+ DocBook XSL stylesheets are located in xsl.d/docbook-xsl.
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r2762 - trunk | paul | 18 Jul |
