MySQL Lists: internals: bk commit - mysqldoc@docsrva tree (paul:1.3627)

List:	Internals	« Previous Message Next Message »
From:	paul	Date:	September 26 2005 6:28pm
Subject:	bk commit - mysqldoc@docsrva tree (paul:1.3627)
View as plain text
Below is the list of changes that have just been committed into a local
mysqldoc repository of paul. When paul does a push these changes will
be propagated to the main repository and, within 24 hours after the
push, to the public repository.
For information on how to access the public repository
see http://www.mysql.com/doc/I/n/Installing_source_tree.html

ChangeSet
  1.3627 05/09/26 13:28:37 paul@stripped +4 -0
  Clean up Makefiles.
  Mark two .texi files obsolete.

  Makefile
    1.6 05/09/26 13:28:36 paul@stripped +6 -57
    Clean up Makefile.

  Docs/Makefile
    1.45 05/09/26 13:28:36 paul@stripped +43 -218
    Clean up Makefile.

  Docs/manual-obsolete.ja.texi
    1.16 05/09/26 13:15:49 paul@stripped +0 -0
    Rename: Docs/manual.ja.texi -> Docs/manual-obsolete.ja.texi

  Docs/manual-obsolete.fr.texi
    1.50 05/09/26 13:15:42 paul@stripped +0 -0
    Rename: Docs/manual.fr.texi -> Docs/manual-obsolete.fr.texi

# This is a BitKeeper patch.  What follows are the unified diffs for the
# set of deltas contained in the patch.  The rest of the patch, the part
# that BitKeeper cares about, is below these diffs.
# User:	paul
# Host:	kite-hub.kitebird.com
# Root:	/src/extern/MySQL/bk/mysqldoc

--- 1.5/Makefile	2005-04-28 21:17:19 -05:00
+++ 1.6/Makefile	2005-09-26 13:28:36 -05:00
@@ -1,60 +1,9 @@
 # mysqldoc top-level Makefile
 
-# Exists primarily as a fixed point from which the "make docs-dist"
-# command can be invoked to build document files needed for inclusion
-# into MySQL distributions.  These files are:
-
-# Docs/{manual,reservedwords,internals,include}.texi - Manual source
-# Docs/{manual,manual_toc}.html - HTML version of manual
-# Docs/manual.txt - Text version of manual
-# Docs/mysql.info - Info version of manual
-# Docs/Images/*.* - Image files for manual
-# - If we stop distributing the .texi files, we might need only the
-#   image files that are referenced by the HTML manual, which would
-#   reduce distribution size.  (HTML manual seems to refer to a mix
-#   of GIF and JPG files for some reason.)
-# Plain text files generated as fragments of the manual:
-# INSTALL-SOURCE - for distribution root
-# INSTALL-WIN-SOURCE - for distribution root
-# COPYING - for distribution root
-# EXCEPTIONS-CLIENT - for distribution root
-# INSTALL-BINARY - for distribution Docs directory
-# ReadMe.txt - for distribution support-files/MacOSX directory
-# Docs/{internals,internals_toc}.html - HTML version of internals manual
-# Docs/internals.txt - Text version of internals manual
-# Docs/internals.info - Info version of internals manual
-
-# Note: distributions still include mysqld_error.txt, which is obsolete.
-# The manual now lists error codes, so no need to include this file any more.
-# If we stop distributing .texi files, we probably also need to include
-# only the .jpg/.gif image files (needed for the HTML manual).
-# Should we build/distribute PDFs? (pretty large)
-
 all:
-
-# All files that must be built are in the Docs directory
-
-docs-dist:
-	cd Docs;make docs-dist
-	-mkdir docs-built
-	-mkdir docs-built/Images
-	cp \
-		Docs/manual.html \
-		Docs/manual_toc.html \
-		Docs/manual.txt \
-		Docs/mysql.info \
-		Docs/INSTALL-SOURCE \
-		Docs/INSTALL-WIN-SOURCE \
-		Docs/INSTALL-BINARY \
-		Docs/COPYING \
-		Docs/EXCEPTIONS-CLIENT \
-		Docs/ReadMe.txt \
-		Docs/internals.html \
-		Docs/internals_toc.html \
-		Docs/internals.txt \
-		Docs/internals.info \
-		docs-built
-	cp Docs/Images/*.* docs-built/Images
-
-clean:
-	rm -rf docs-built
+	@echo "Documents maintained in this directory generally each"
+	@echo "have their own directory.  To work on a document"
+	@echo "(for example, to edit it or to generate output),"
+	@echo "cd into the document directory first.  For example,"
+	@echo "to work on the MySQL 5.0 Reference Manual, cd into"
+	@echo "the refman-5.0 directory."

--- 1.44/Docs/Makefile	2005-08-13 21:45:34 -05:00
+++ 1.45/Docs/Makefile	2005-09-26 13:28:36 -05:00
@@ -1,6 +1,13 @@
-# Todo:
-# - The single-file .html target does not do anything about remapping
-#   image file names.
+# NOTE:
+# The Texinfo documents in this directory are mostly obsolete.  Some
+# of them have been converted to DocBook, which is the format we
+# now use.  For those that have not been converted, that will happen
+# in the near future.  To work on a DocBook document, look for the
+# document's directory in .. and cd into that directory.
+
+# If you really want to format output for an obsolete document, use these:
+# MySQL Reference Manual: manual-obsolete.texi
+# Internals Manual:       internals-obsolete.texi
 
 # Location of "tools" directory
 
@@ -50,6 +57,14 @@
 TEXI2DB_POST_XSL = $(XSL_DIR)/texi2db-post.xsl
 MANUALIZE_CONNECTOR_DOC_XSL = $(XSL_DIR)/manualize-connector-doc.xsl
 
+MANUAL_EN_BASE = manual-obsolete
+MANUAL_DE_BASE = manual-de
+MANUAL_FR_BASE = manual-fr-obsolete
+MANUAL_JA_BASE = manual-ja-obsolete
+MANUAL_PT_BASE = manual-pt
+MANUAL_RU_BASE = manual-ru
+INTERNALS_BASE = internals-obsolete
+
 all::
 	@echo "You must say what you want to do."
 	@echo "Some commands supported by this Makefile:"
@@ -60,89 +75,12 @@
 	@echo "  make doc_name.txt"
 	@echo "  make doc_name.info"
 
-ADMINISTRATOR_SRCS = \
-	administrator.xml \
-	administrator/connection.png \
-	administrator/configure-service-mode-connection.png \
-	administrator/configure-service-mode-window.png \
-	administrator/mainwindow.png \
-	administrator/marked-area.png \
-	administrator/user-accounts.png \
-	administrator/user-information.png \
-	administrator/graph-settings.png \
-	administrator/server-logs-general-log.png \
-	administrator/restore-content.png \
-	administrator/replication.png \
-	gui-common/tableeditor.png \
-	gui-common/columneditor.png \
-	gui-common/indexeditor.png \
-	gui-common/confirmchanges.png \
-	gui-common/options.png \
-	gui-common/options-connection.png \
-	administrator/system-tray.png \
-	gui-common/connectionerror.png
-
-administrator-prepped.xml: $(ADMINISTRATOR_SRCS)
-
 CONNECTOR_NET_SRCS = \
 	connector-net.xml \
 	connector-net/changelog.xml
 
 connector-net-prepped.xml: $(CONNECTOR_NET_SRCS)
 
-QUERY_BROWSER_SRCS = \
-	query-browser.xml \
-	query-browser/connection.png \
-	query-browser/mainscreen.png \
-	query-browser/querybar.png \
-	query-browser/twosakilas.png \
-	query-browser/buttonbar.png \
-	query-browser/schematabrowser.png \
-	query-browser/script-editor.png \
-	query-browser/tabletool.png \
-	query-browser/blob-buttons.png \
-	query-browser/dynamiclist.png \
-	gui-common/tableeditor.png \
-	gui-common/columneditor.png \
-	gui-common/indexeditor.png \
-	gui-common/confirmchanges.png \
-	gui-common/options.png \
-	gui-common/options-connection.png \
-	gui-common/connectionerror.png
-
-query-browser-prepped.xml: $(QUERY_BROWSER_SRCS)
-
-MIGRATION_TOOLKIT_SRCS = \
-	migration-toolkit.xml \
-	migration-toolkit/migration-plan.png \
-	migration-toolkit/welcome-screen.png \
-	migration-toolkit/configuration-type.png \
-	migration-toolkit/source-database-access.png \
-	migration-toolkit/source-database-oracle.png \
-	migration-toolkit/source-database-oracle-nodriver.png \
-	migration-toolkit/source-database-mysql.png \
-	migration-toolkit/target-database-mysql.png \
-	migration-toolkit/connect-servers.png \
-	migration-toolkit/schema-selection.png \
-	migration-toolkit/reverse-engineering.png \
-	migration-toolkit/object-selection.png \
-	migration-toolkit/object-selection-detail.png \
-	migration-toolkit/object-selection-expression.png \
-	migration-toolkit/object-mapping.png \
-	migration-toolkit/meta-migration.png \
-	migration-toolkit/manual-editing.png \
-	migration-toolkit/manual-editing-detail.png \
-	migration-toolkit/creation-options.png \
-	migration-toolkit/creating-objects.png \
-	migration-toolkit/mapping-options.png \
-	migration-toolkit/bulk-transfer.png \
-	migration-toolkit/summary.png \
-	migration-toolkit/access-options-show.png \
-	migration-toolkit/access-system-tables.png \
-	migration-toolkit/access-object-permissions.png
-
-migration-toolkit-prepped.xml: $(MIGRATION_TOOLKIT_SRCS)
-
 # Validate an XML document
 
 %.valid: %.xml
@@ -162,12 +100,13 @@
 # into MySQL distributions
 
 docs-dist:: \
-	manual.html manual.txt mysql.info \
-	internals.html internals.txt internals.info \
+	$(MANUAL_EN_BASE).html $(MANUAL_EN_BASE).txt mysql.info \
+	$(INTERNALS_BASE).html $(INTERNALS_BASE).txt \
+	$(INTERNALS_BASE).info \
 	text-fragment-files
 
 # Files included by main .texi files
-MANUAL_SRCS = manual.texi include.texi reservedwords.texi \
+MANUAL_SRCS = $(MANUAL_EN_BASE).texi include.texi reservedwords.texi \
 	errmsg-table.texi cl-errmsg-table.texi
 MANUAL_DE_SRCS = manual.de.texi include.texi reservedwords.texi
 MANUAL_FR_SRCS = manual.fr.texi include.texi reservedwords.texi \
@@ -177,10 +116,10 @@
 MANUAL_PT_SRCS = manual.pt.texi include.texi reservedwords.texi \
 	errmsg-table.texi cl-errmsg-table.texi
 MANUAL_RU_SRCS = manual.ru.texi include.texi reservedwords.texi
-INTERNALS_SRCS = internals.texi include.texi
+INTERNALS_SRCS = $(INTERNALS_BASE).texi include.texi
 
-manual.pdf manual.html manual.txt mysql.info \
-	manual.texi-xml: $(MANUAL_SRCS)
+$(MANUAL_EN_BASE).pdf $(MANUAL_EN_BASE).html $(MANUAL_EN_BASE).txt mysql.info \
+	$(MANUAL_EN_BASE).texi-xml: $(MANUAL_SRCS)
 manual.de.pdf manual.de.html manual.de.txt mysql.de.info \
 	manual.de.texi-xml: $(MANUAL_DE_SRCS)
 manual.fr.pdf manual.fr.html manual.fr.txt mysql.fr.info \
@@ -191,8 +130,8 @@
 	manual.pt.texi-xml: $(MANUAL_PT_SRCS)
 manual.ru.pdf manual.ru.html manual.ru.txt mysql.ru.info \
 	manual.ru.texi-xml: $(MANUAL_RU_SRCS)
-internals.pdf internals.html internals.txt internals.info \
-	internals.texi-xml: $(INTERNALS_SRCS)
+$(INTERNALS_BASE).pdf $(INTERNALS_BASE).html $(INTERNALS_BASE).txt \
+	$(INTERNALS_BASE).info $(INTERNALS_BASE).texi-xml: $(INTERNALS_SRCS)
 
 %.test: %.texi
 	makeinfo --no-split -I . $<
@@ -205,8 +144,8 @@
 
 # Info rule for English manual
 
-manual.info: mysql.info
-mysql.info: manual.texi
+$(MANUAL_EN_BASE).info: mysql.info
+mysql.info: $(MANUAL_EN_BASE).texi
 	makeinfo --no-split -I . $<
 
 # Info rule for non-English manuals
@@ -236,38 +175,6 @@
 %.html-section: %.html-section.d
 	touch $@
 
-# Rules for documents that have special requirements
-# - administrator document needs images from gui-common and administrator
-#   directories.
-# - query-browser document needs images from gui-common and query-browser
-#   directories.
-# - migration-toolkit document needs images from migration-toolkit
-#   directory.
-
-# In those cases, the images should be stored in an "images" subdirectory.
-# This differs from the source layout, so the resulting HTML files have
-# to be hacked to remap the src attribute of <img> elements. Ack, ptooey.
-
-administrator.html-section: administrator.html-section.d
-	mkdir $</images
-	cp gui-common/*.png $</images
-	cp administrator/*.png $</images
-	$(TOOLS_DIR)/remap-img-paths.pl $</*.html
-	touch $@
-
-query-browser.html-section: query-browser.html-section.d
-	mkdir $</images
-	cp gui-common/*.png $</images
-	cp query-browser/*.png $</images
-	$(TOOLS_DIR)/remap-img-paths.pl $</*.html
-	touch $@
-
-migration-toolkit.html-section: migration-toolkit.html-section.d
-	mkdir $</images
-	cp migration-toolkit/*.png $</images
-	$(TOOLS_DIR)/remap-img-paths.pl $</*.html
-	touch $@
-
 # Helper rule - this actually builds the HTML per-section output
 
 .PRECIOUS: %.html-section.d
@@ -291,38 +198,6 @@
 %.html-chapter: %.html-chapter.d
 	touch $@
 
-# Rules for documents that have special requirements
-# - administrator document needs images from gui-common and administrator
-#   directories.
-# - query-browser document needs images from gui-common and query-browser
-#   directories.
-# - migration-toolkit document needs images from migration-toolkit
-#   directory.
-
-# In those cases, the images should be stored in an "images" subdirectory.
-# This differs from the source layout, so the resulting HTML files have
-# to be hacked to remap the src attribute of <img> elements. Ack, ptooey.
-
-administrator.html-chapter: administrator.html-chapter.d
-	mkdir $</images
-	cp gui-common/*.png $</images
-	cp administrator/*.png $</images
-	$(TOOLS_DIR)/remap-img-paths.pl $</*.html
-	touch $@
-
-query-browser.html-chapter: query-browser.html-chapter.d
-	mkdir $</images
-	cp gui-common/*.png $</images
-	cp query-browser/*.png $</images
-	$(TOOLS_DIR)/remap-img-paths.pl $</*.html
-	touch $@
-
-migration-toolkit.html-chapter: migration-toolkit.html-chapter.d
-	mkdir $</images
-	cp migration-toolkit/*.png $</images
-	$(TOOLS_DIR)/remap-img-paths.pl $</*.html
-	touch $@
-
 # Helper rule - this actually builds the HTML per-chapter output
 
 .PRECIOUS: %.html-chapter.d
@@ -345,34 +220,6 @@
 %.html-web: %.html-web.d
 	touch $@
 
-# Rules for documents that have special requirements
-# - administrator document needs images from gui-common and administrator
-#   directories.
-# - query-browser document needs images from gui-common and query-browser
-#   directories.
-# - migration-toolkit document needs images from migration-toolkit
-#   directory.
-
-administrator.html-web: administrator.html-web.d
-	mkdir $</images
-	cp gui-common/*.png $</images
-	cp administrator/*.png $</images
-	$(TOOLS_DIR)/remap-img-paths.pl $</*.html
-	touch $@
-
-query-browser.html-web: query-browser.html-web.d
-	mkdir $</images
-	cp gui-common/*.png $</images
-	cp query-browser/*.png $</images
-	$(TOOLS_DIR)/remap-img-paths.pl $</*.html
-	touch $@
-
-migration-toolkit.html-web: migration-toolkit.html-web.d
-	mkdir $</images
-	cp migration-toolkit/*.png $</images
-	$(TOOLS_DIR)/remap-img-paths.pl $</*.html
-	touch $@
-
 # Helper rule - this actually builds the HTML Web output
 
 .PRECIOUS: %.html-web.d
@@ -395,34 +242,6 @@
 %.html-help: %.html-help.d
 	touch $@
 
-# Rules for documents that have special requirements
-# - administrator document needs images from gui-common and administrator
-#   directories.
-# - query-browser document needs images from gui-common and query-browser
-#   directories.
-# - migration-toolkit document needs images from migration-toolkit
-#   directory.
-
-administrator.html-help: administrator.html-help.d
-	mkdir $</images
-	cp gui-common/*.png $</images
-	cp administrator/*.png $</images
-	$(TOOLS_DIR)/remap-img-paths.pl $</*.html
-	touch $@
-
-query-browser.html-help: query-browser.html-help.d
-	mkdir $</images
-	cp gui-common/*.png $</images
-	cp query-browser/*.png $</images
-	$(TOOLS_DIR)/remap-img-paths.pl $</*.html
-	touch $@
-
-migration-toolkit.html-help: migration-toolkit.html-help.d
-	mkdir $</images
-	cp migration-toolkit/*.png $</images
-	$(TOOLS_DIR)/remap-img-paths.pl $</*.html
-	touch $@
-
 # Helper rule - this actually builds the HTML Help output
 
 .PRECIOUS: %.html-help.d
@@ -547,7 +366,7 @@
 # From the Texinfo manual, generate the file of SQL statements needed
 # for populating the help tables in the mysql database:
 
-fill_help_tables.sql: manual-obsolete.texi $(TOOLS_DIR)/fill_help_tables
+fill_help_tables.sql: $(MANUAL_EN_BASE).texi $(TOOLS_DIR)/fill_help_tables
 	$(TOOLS_DIR)/fill_help_tables $< > $@
 
 prep_demo1.o: prep_demo1.c
@@ -557,14 +376,20 @@
 	$(CC) -o prep_demo1 prep_demo1.o `mysql_config --libs`
 
 clean::
-	$(RM) mysql.info mysql.??.info internals.info
+	$(RM) mysql.info mysql.??.info $(INTERNALS_BASE).info
 	$(RM) texi2dvi.out
-	$(RM) manual.aux manual.cp manual.cps manual.dvi
-	$(RM) manual.fn manual.fns manual.ky manual.log
-	$(RM) manual.pg manual.tp manual.toc manual.vr
-	$(RM) internals.aux internals.cp internals.cps internals.dvi
-	$(RM) internals.fn internals.fns internals.ky internals.log
-	$(RM) internals.pg internals.tp internals.toc internals.vr
+	$(RM) $(MANUAL_EN_BASE).aux $(MANUAL_EN_BASE).cp
+	$(RM) $(MANUAL_EN_BASE).cps $(MANUAL_EN_BASE).dvi
+	$(RM) $(MANUAL_EN_BASE).fn $(MANUAL_EN_BASE).fns
+	$(RM) $(MANUAL_EN_BASE).ky $(MANUAL_EN_BASE).log
+	$(RM) $(MANUAL_EN_BASE).pg $(MANUAL_EN_BASE).tp
+	$(RM) $(MANUAL_EN_BASE).toc $(MANUAL_EN_BASE).vr
+	$(RM) $(INTERNALS_BASE).aux $(INTERNALS_BASE).cp
+	$(RM) $(INTERNALS_BASE).cps $(INTERNALS_BASE).dvi
+	$(RM) $(INTERNALS_BASE).fn $(INTERNALS_BASE).fns
+	$(RM) $(INTERNALS_BASE).ky $(INTERNALS_BASE).log
+	$(RM) $(INTERNALS_BASE).pg $(INTERNALS_BASE).tp
+	$(RM) $(INTERNALS_BASE).toc $(INTERNALS_BASE).vr
 	$(RM) *-prepped.xml
 	$(RM) *.fo *.pdf *.pdf-tmp *.pdf-err *.html *.chm
 	$(RM) -r *.html-chapter *.html-chapter.d
Thread
• bk commit - mysqldoc@docsrva tree (paul:1.3627)	paul	26 Sep