diff --git a/build.xml b/build.xml index 53d399dd..48b3c560 100644 --- a/build.xml +++ b/build.xml @@ -554,11 +554,22 @@ + + + + + + + + + + + diff --git a/src/docs/Makefile b/src/docs/Makefile index 103bebf5..a84bce8b 100644 --- a/src/docs/Makefile +++ b/src/docs/Makefile @@ -15,6 +15,9 @@ BUILDROOT=../../build BUILD_DIR=$(BUILDROOT)/docs +WEBSITE_DIR=$(BUILDROOT)/webdocs + +VERSION=Unknown all: man userguide devguide @@ -25,10 +28,33 @@ devguide: $(BUILD_DIR)/SqoopDevGuide.html MANSOURCES=$(shell echo man/sqoop*.txt) MANPAGES=$(MANSOURCES:.txt=.1.gz) +REVDATE=$(shell date) + + +website: + mkdir -p $(WEBSITE_DIR) + asciidoc --unsafe -a revnumber=$(VERSION) \ + -b docbook \ + user/SqoopUserGuide.txt + xmlto -o $(WEBSITE_DIR) -m web/html.xsl html-nochunks user/SqoopUserGuide.xml + asciidoc --unsafe -a revnumber=$(VERSION) \ + -b docbook \ + dev/SqoopDevGuide.txt + xmlto -o $(WEBSITE_DIR) -m web/html.xsl html-nochunks dev/SqoopDevGuide.xml + asciidoc --unsafe -a revnumber=$(VERSION) \ + -b docbook \ + web/index.txt + xmlto -o $(WEBSITE_DIR) -m web/html.xsl html-nochunks web/index.xml + cp web/docbook.css $(WEBSITE_DIR) + rsync -a web/images $(WEBSITE_DIR)/ + rm user/SqoopUserGuide.xml + rm dev/SqoopDevGuide.xml + rm web/index.xml + man: $(MANPAGES) %.1.gz : %.txt - asciidoc --unsafe -b docbook -d manpage $< + asciidoc --unsafe -b docbook -d manpage -a "author=Sqoop Team" $< xmlto man $*.xml -o man gzip $*.1 rm $*.xml @@ -37,12 +63,14 @@ man: $(MANPAGES) $(BUILD_DIR)/SqoopUserGuide.html: user/*.txt asciidoc -a toc -a toclevels=1 -a "toc-title=Table of Contents" \ + -a revnumber=$(VERSION) -a "revdate=$(REVDATE)" \ user/SqoopUserGuide.txt mkdir -p $(BUILD_DIR) mv user/SqoopUserGuide.html $(BUILD_DIR) $(BUILD_DIR)/SqoopDevGuide.html: dev/*.txt asciidoc -a toc -a toclevels=1 -a "toc-title=Table of Contents" \ + -a revnumber=$(VERSION) -a "revdate=$(REVDATE)" \ dev/SqoopDevGuide.txt mkdir -p $(BUILD_DIR) mv dev/SqoopDevGuide.html $(BUILD_DIR) diff --git a/src/docs/dev/SqoopDevGuide.txt b/src/docs/dev/SqoopDevGuide.txt index 4a6f3ed6..d1f451a1 100644 --- a/src/docs/dev/SqoopDevGuide.txt +++ b/src/docs/dev/SqoopDevGuide.txt @@ -16,6 +16,11 @@ limitations under the License. //// +Sqoop Developer's Guide v{revnumber} +==================================== + + + include::intro.txt[] include::preface.txt[] diff --git a/src/docs/dev/preface.txt b/src/docs/dev/preface.txt index ce9fa705..4163ae05 100644 --- a/src/docs/dev/preface.txt +++ b/src/docs/dev/preface.txt @@ -21,7 +21,7 @@ Supported Releases ------------------ -This documentation applies to Sqoop v1.0.0 (June 2010). +This documentation applies to Sqoop v{revnumber}. Sqoop Releases -------------- diff --git a/src/docs/user/SqoopUserGuide.txt b/src/docs/user/SqoopUserGuide.txt index 35ac4ec3..921ec5fc 100644 --- a/src/docs/user/SqoopUserGuide.txt +++ b/src/docs/user/SqoopUserGuide.txt @@ -16,6 +16,10 @@ limitations under the License. //// +Sqoop User Guide (v{revnumber}) +=============================== + + include::intro.txt[] diff --git a/src/docs/user/preface.txt b/src/docs/user/preface.txt index 6d956327..3fe142ce 100644 --- a/src/docs/user/preface.txt +++ b/src/docs/user/preface.txt @@ -21,7 +21,7 @@ Supported Releases ------------------ -This documentation applies to Sqoop v1.0.0 (June 2010). +This documentation applies to Sqoop v{revnumber}. Sqoop Releases -------------- @@ -30,6 +30,7 @@ Sqoop is an open source software product of Cloudera, Inc. Software development for Sqoop occurs at http://github.com/cloudera/sqoop. At that site you can obtain: + - New releases of Sqoop as well as its most recent source code - An issue tracker - A wiki that contains Sqoop documentation diff --git a/src/docs/user/support.txt b/src/docs/user/support.txt index 36927b4c..c0da874a 100644 --- a/src/docs/user/support.txt +++ b/src/docs/user/support.txt @@ -19,11 +19,14 @@ Getting Support --------------- +Some general information is available at the +http://wiki.github.com/cloudera/sqoop/[Sqoop wiki]. + Report bugs in Sqoop to the issue tracker at http://github.com/cloudera/sqoop/issues[]. -For general questions and answers, a support forum is available at -http://getsatisfaction.com/cloudera/products/cloudera_sqoop[]. +Questions and discussion regarding the usage of Sqoop should be directed to the +http://groups.google.com/a/cloudera.org/group/sqoop-user[sqoop-user mailing list]. Before contacting either forum, run your Sqoop job with the +\--verbose+ flag to acquire as much debugging information as diff --git a/src/docs/user/version.txt b/src/docs/user/version.txt index 077eb2f1..5ede8611 100644 --- a/src/docs/user/version.txt +++ b/src/docs/user/version.txt @@ -41,7 +41,7 @@ Display the version: ---- $ sqoop version -Sqoop 1.0.0 +Sqoop {revnumber} git commit id 46b3e06b79a8411320d77c984c3030db47dd1c22 Compiled by aaron@jargon on Mon May 17 13:43:22 PDT 2010 ---- diff --git a/src/docs/web/breadcrumbs.xsl b/src/docs/web/breadcrumbs.xsl new file mode 100644 index 00000000..3863192a --- /dev/null +++ b/src/docs/web/breadcrumbs.xsl @@ -0,0 +1,30 @@ + + + + + + + + diff --git a/src/docs/web/docbook.css b/src/docs/web/docbook.css new file mode 100644 index 00000000..85e44491 --- /dev/null +++ b/src/docs/web/docbook.css @@ -0,0 +1,248 @@ +/* + * Copyright (c) 2001, 2003 The FreeBSD Documentation Project + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * $FreeBSD: doc/share/misc/docbook.css,v 1.14 2008/11/21 07:28:34 keramida Exp $ + */ + +BODY ADDRESS { + line-height: 1.3; + margin: .6em 0; +} + +BODY BLOCKQUOTE { + margin-top: .75em; + line-height: 1.5; + margin-bottom: .75em; +} + +HTML BODY { + margin: 1em 4% 1em 4%; + line-height: 1.2; + font-family: verdana; +} + +a { + text-decoration: none; + color: #1c84bf; +} + +a:hover { + text-decoration: underline; +} + +a:visited { + color: #597e93; +} + +div.titlepage .title { + font-size: 26px; +} + +.LEGALNOTICE { + font-size: small; + font-variant: small-caps; +} + +BODY DIV { + margin: 0; +} + +DL { + margin: .8em 0; + line-height: 1.2; +} + +BODY FORM { + margin: .6em 0; +} + +H1, H2, H3, H4, H5, H6, +DIV.EXAMPLE P B, +.QUESTION, +DIV.TABLE P B, +DIV.PROCEDURE P B { + color: #148BCF; +} + +BODY H1, BODY H2, BODY H3, BODY H4, BODY H5, BODY H6 { + line-height: 1.3; + margin-left: 0; +} + +BODY H1, H2, H3, H4, H5, H6 { + margin: 6px 0 0 0; +} + +BODY HR { + border-width: 0 0 1px 0; + border-style: solid; + border-color: #0068BB; +} + +BODY IMG.NAVHEADER { + margin: 0 0 0 -4%; +} + +OL { + margin: 0 0 0 5%; + line-height: 1.2; +} + +BODY PRE { + margin: .75em 0; + line-height: 1.0; + font-family: monospace; +} + +BODY TD, BODY TH { + line-height: 1.2; +} + +UL, BODY DIR, BODY MENU { + margin: 0 0 0 5%; + line-height: 1.2; +} + +HTML { + margin: 0; + padding: 0; +} + +BODY P B.APPLICATION { + color: #000000; +} + +.navfooter td, .literal, .FILENAME { + color: #007a00; + font-family: monospace; +} + + +.GUIMENU, .GUIMENUITEM, .GUISUBMENU, +.GUILABEL, .INTERFACE, +.SHORTCUT, .SHORTCUT .KEYCAP { + font-weight: bold; +} + +.GUIBUTTON { + background-color: #CFCFCF; + padding: 2px; +} + +.ACCEL { + background-color: #F0F0F0; + text-decoration: underline; +} + +.PROGRAMLISTING { + padding: 1ex; + background-color: #eee; + border: 1px solid #ccc; +} + +@media screen { /* hide from IE3 */:/ + a[href]:hover { background: #ffa } +} + +.NOTE, .SCREEN { + color: #222; + background: #fff; + border: 1px solid #ccc; + padding: 0.4em 0.4em; +} + +.SCREEN { + background: #eee; +} + +.TIP { + color: #004F00; + background: #fff; + border: 1px solid green; + padding: 0.4em 0.4em; +} + +table.CDH { + padding:0px 0px 8px +} + +table.CDH th { + background: #EDF2F9; + border-right: 0.5pt solid #adb6cd; + border-bottom: 0.5pt solid #adb6cd; + padding:2px 8px 1px; +} + +table.CDH td { + font-size: 12px; +} + +div.breadcrumbs { + border-top: 2px solid #0068BB; + background: #EDF2F9; + font-style: bold; + font-size: small; + padding: 0.6em 0.6em; +} + +span.breadcrumb-node { + font-style: italic; +} + +/* Match the the breadcrumbs at the top */ +div.footer-text { + border-bottom: 2px solid #0068BB; + background: #EDF2F9; + font-size: small; + padding: 0.2em 0.2em; + text-align: center; +} + +.IMPORTANT, .caution { + font-style:italic; + border: 1px solid #a00; + border-left: 12px solid #c00; + padding: 0.1em 1em; +} + +.WARNING { + color: #9F1313; + background: #fff; + border: 1px solid #e59595; + padding: 0.4em 0.4em; + width: 85%; +} + +.EXAMPLE { + width: 100%; +} + +.tip, .note, .caution { + margin:4px 0 4px; +} + +img { + border: 0; +} diff --git a/src/docs/web/footer.xsl b/src/docs/web/footer.xsl new file mode 100644 index 00000000..b42c945e --- /dev/null +++ b/src/docs/web/footer.xsl @@ -0,0 +1,29 @@ + + + + + + + + + + + diff --git a/src/docs/web/header.xsl b/src/docs/web/header.xsl new file mode 100644 index 00000000..67462985 --- /dev/null +++ b/src/docs/web/header.xsl @@ -0,0 +1,23 @@ + + + + + + + + + +
+
+ Documentation Home +
+ + + + + + diff --git a/src/docs/web/html.xsl b/src/docs/web/html.xsl new file mode 100644 index 00000000..b75d4e92 --- /dev/null +++ b/src/docs/web/html.xsl @@ -0,0 +1,66 @@ + + + + + + + + + + + + + + + + + + + + + + + + + .png + images/ + + + .png + images/ + + + + + + + + + + + + + + +appendix toc,title +article toc,title,figure,equation +book toc,title,figure,example,equation +chapter toc,title +part toc,title +preface toc,title +qandadiv toc +qandaset toc +reference toc,title +sect1 toc +sect2 toc +sect3 toc +sect4 toc +sect5 toc +section toc +set toc,title + + + diff --git a/src/docs/web/images/README b/src/docs/web/images/README new file mode 100644 index 00000000..f12b2a73 --- /dev/null +++ b/src/docs/web/images/README @@ -0,0 +1,5 @@ +Replaced the plain DocBook XSL admonition icons with Jimmac's DocBook +icons (http://jimmac.musichall.cz/ikony.php3). I dropped transparency +from the Jimmac icons to get round MS IE and FOP PNG incompatibilies. + +Stuart Rackham diff --git a/src/docs/web/images/callouts/1.png b/src/docs/web/images/callouts/1.png new file mode 100644 index 00000000..7d473430 Binary files /dev/null and b/src/docs/web/images/callouts/1.png differ diff --git a/src/docs/web/images/callouts/10.png b/src/docs/web/images/callouts/10.png new file mode 100644 index 00000000..997bbc82 Binary files /dev/null and b/src/docs/web/images/callouts/10.png differ diff --git a/src/docs/web/images/callouts/11.png b/src/docs/web/images/callouts/11.png new file mode 100644 index 00000000..ce47dac3 Binary files /dev/null and b/src/docs/web/images/callouts/11.png differ diff --git a/src/docs/web/images/callouts/12.png b/src/docs/web/images/callouts/12.png new file mode 100644 index 00000000..31daf4e2 Binary files /dev/null and b/src/docs/web/images/callouts/12.png differ diff --git a/src/docs/web/images/callouts/13.png b/src/docs/web/images/callouts/13.png new file mode 100644 index 00000000..14021a89 Binary files /dev/null and b/src/docs/web/images/callouts/13.png differ diff --git a/src/docs/web/images/callouts/14.png b/src/docs/web/images/callouts/14.png new file mode 100644 index 00000000..64014b75 Binary files /dev/null and b/src/docs/web/images/callouts/14.png differ diff --git a/src/docs/web/images/callouts/15.png b/src/docs/web/images/callouts/15.png new file mode 100644 index 00000000..0d65765f Binary files /dev/null and b/src/docs/web/images/callouts/15.png differ diff --git a/src/docs/web/images/callouts/2.png b/src/docs/web/images/callouts/2.png new file mode 100644 index 00000000..5d09341b Binary files /dev/null and b/src/docs/web/images/callouts/2.png differ diff --git a/src/docs/web/images/callouts/3.png b/src/docs/web/images/callouts/3.png new file mode 100644 index 00000000..ef7b7004 Binary files /dev/null and b/src/docs/web/images/callouts/3.png differ diff --git a/src/docs/web/images/callouts/4.png b/src/docs/web/images/callouts/4.png new file mode 100644 index 00000000..adb8364e Binary files /dev/null and b/src/docs/web/images/callouts/4.png differ diff --git a/src/docs/web/images/callouts/5.png b/src/docs/web/images/callouts/5.png new file mode 100644 index 00000000..4d7eb460 Binary files /dev/null and b/src/docs/web/images/callouts/5.png differ diff --git a/src/docs/web/images/callouts/6.png b/src/docs/web/images/callouts/6.png new file mode 100644 index 00000000..0ba694af Binary files /dev/null and b/src/docs/web/images/callouts/6.png differ diff --git a/src/docs/web/images/callouts/7.png b/src/docs/web/images/callouts/7.png new file mode 100644 index 00000000..472e96f8 Binary files /dev/null and b/src/docs/web/images/callouts/7.png differ diff --git a/src/docs/web/images/callouts/8.png b/src/docs/web/images/callouts/8.png new file mode 100644 index 00000000..5e60973c Binary files /dev/null and b/src/docs/web/images/callouts/8.png differ diff --git a/src/docs/web/images/callouts/9.png b/src/docs/web/images/callouts/9.png new file mode 100644 index 00000000..a0676d26 Binary files /dev/null and b/src/docs/web/images/callouts/9.png differ diff --git a/src/docs/web/images/caution.png b/src/docs/web/images/caution.png new file mode 100644 index 00000000..cb9d5ea0 Binary files /dev/null and b/src/docs/web/images/caution.png differ diff --git a/src/docs/web/images/example.png b/src/docs/web/images/example.png new file mode 100644 index 00000000..bba1c001 Binary files /dev/null and b/src/docs/web/images/example.png differ diff --git a/src/docs/web/images/home.png b/src/docs/web/images/home.png new file mode 100644 index 00000000..37a5231b Binary files /dev/null and b/src/docs/web/images/home.png differ diff --git a/src/docs/web/images/important.png b/src/docs/web/images/important.png new file mode 100644 index 00000000..1096c232 Binary files /dev/null and b/src/docs/web/images/important.png differ diff --git a/src/docs/web/images/next.png b/src/docs/web/images/next.png new file mode 100644 index 00000000..64e126bd Binary files /dev/null and b/src/docs/web/images/next.png differ diff --git a/src/docs/web/images/note.png b/src/docs/web/images/note.png new file mode 100644 index 00000000..841820f7 Binary files /dev/null and b/src/docs/web/images/note.png differ diff --git a/src/docs/web/images/prev.png b/src/docs/web/images/prev.png new file mode 100644 index 00000000..3e8f12fe Binary files /dev/null and b/src/docs/web/images/prev.png differ diff --git a/src/docs/web/images/tip.png b/src/docs/web/images/tip.png new file mode 100644 index 00000000..a3a029d8 Binary files /dev/null and b/src/docs/web/images/tip.png differ diff --git a/src/docs/web/images/up.png b/src/docs/web/images/up.png new file mode 100644 index 00000000..2db1ce62 Binary files /dev/null and b/src/docs/web/images/up.png differ diff --git a/src/docs/web/images/warning.png b/src/docs/web/images/warning.png new file mode 100644 index 00000000..0b0c419d Binary files /dev/null and b/src/docs/web/images/warning.png differ diff --git a/src/docs/web/index.txt b/src/docs/web/index.txt new file mode 100644 index 00000000..aeb8f3fa --- /dev/null +++ b/src/docs/web/index.txt @@ -0,0 +1,28 @@ + +//// + Licensed to Cloudera, Inc. under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + Cloudera, Inc. licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +//// + +Sqoop Documentation (v{revnumber}) +================================== + + + +The following pages are the documentation for Sqoop v{revnumber}: + +- link:SqoopUserGuide.html[Sqoop User Guide] +- link:SqoopDevGuide.html[Sqoop Developer's Guide] +